@vrplatform/api 1.3.0-stage.1168 → 1.3.0-stage.1170

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.1168",
6
+ "version": "1.3.0-stage.1170",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -1563,6 +1563,40 @@ export interface paths {
1563
1563
  patch?: never;
1564
1564
  trace?: never;
1565
1565
  };
1566
+ "/reports/trust-reconciliation/by-listing": {
1567
+ parameters: {
1568
+ query?: never;
1569
+ header?: never;
1570
+ path?: never;
1571
+ cookie?: never;
1572
+ };
1573
+ /** @description Trust reconciliation grouped by listing */
1574
+ get: operations["getTrustReconciliationReportByListing"];
1575
+ put?: never;
1576
+ post?: never;
1577
+ delete?: never;
1578
+ options?: never;
1579
+ head?: never;
1580
+ patch?: never;
1581
+ trace?: never;
1582
+ };
1583
+ "/reports/trust-reconciliation/by-listing/csv": {
1584
+ parameters: {
1585
+ query?: never;
1586
+ header?: never;
1587
+ path?: never;
1588
+ cookie?: never;
1589
+ };
1590
+ /** @description Trust reconciliation grouped by listing (CSV) */
1591
+ get: operations["getTrustReconciliationReportByListingCsv"];
1592
+ put?: never;
1593
+ post?: never;
1594
+ delete?: never;
1595
+ options?: never;
1596
+ head?: never;
1597
+ patch?: never;
1598
+ trace?: never;
1599
+ };
1566
1600
  "/reports/trust-reconciliation/csv": {
1567
1601
  parameters: {
1568
1602
  query?: never;
@@ -6470,14 +6504,19 @@ export interface operations {
6470
6504
  status?: "active" | "inactive";
6471
6505
  defaultCurrency?: string | null;
6472
6506
  activeRecurringFeePeriods?: {
6473
- listingId: string;
6474
6507
  startAt?: string | null;
6475
6508
  endAt?: string | null;
6476
6509
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
6477
6510
  rate?: number | null;
6478
- recurringFeeId: string;
6479
6511
  /** Format: uuid */
6480
6512
  id: string;
6513
+ recurringFee: {
6514
+ /** Format: uuid */
6515
+ id: string;
6516
+ title: string;
6517
+ /** @enum {string} */
6518
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6519
+ };
6481
6520
  }[] | null;
6482
6521
  /** Format: uuid */
6483
6522
  sourceId?: string | null;
@@ -6559,14 +6598,19 @@ export interface operations {
6559
6598
  id: string;
6560
6599
  } | null;
6561
6600
  activeRecurringFeePeriods?: {
6562
- listingId: string;
6563
6601
  startAt?: string | null;
6564
6602
  endAt?: string | null;
6565
6603
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
6566
6604
  rate?: number | null;
6567
- recurringFeeId: string;
6568
6605
  /** Format: uuid */
6569
6606
  id: string;
6607
+ recurringFee: {
6608
+ /** Format: uuid */
6609
+ id: string;
6610
+ title: string;
6611
+ /** @enum {string} */
6612
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6613
+ };
6570
6614
  }[] | null;
6571
6615
  source?: {
6572
6616
  /** Format: uuid */
@@ -6800,14 +6844,19 @@ export interface operations {
6800
6844
  id: string;
6801
6845
  } | null;
6802
6846
  activeRecurringFeePeriods?: {
6803
- listingId: string;
6804
6847
  startAt?: string | null;
6805
6848
  endAt?: string | null;
6806
6849
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
6807
6850
  rate?: number | null;
6808
- recurringFeeId: string;
6809
6851
  /** Format: uuid */
6810
6852
  id: string;
6853
+ recurringFee: {
6854
+ /** Format: uuid */
6855
+ id: string;
6856
+ title: string;
6857
+ /** @enum {string} */
6858
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6859
+ };
6811
6860
  }[] | null;
6812
6861
  source?: {
6813
6862
  /** Format: uuid */
@@ -6908,14 +6957,19 @@ export interface operations {
6908
6957
  status?: "active" | "inactive";
6909
6958
  defaultCurrency?: string | null;
6910
6959
  activeRecurringFeePeriods?: {
6911
- listingId: string;
6912
6960
  startAt?: string | null;
6913
6961
  endAt?: string | null;
6914
6962
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
6915
6963
  rate?: number | null;
6916
- recurringFeeId: string;
6917
6964
  /** Format: uuid */
6918
6965
  id: string;
6966
+ recurringFee: {
6967
+ /** Format: uuid */
6968
+ id: string;
6969
+ title: string;
6970
+ /** @enum {string} */
6971
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
6972
+ };
6919
6973
  }[] | null;
6920
6974
  /** Format: uuid */
6921
6975
  sourceId?: string | null;
@@ -6993,14 +7047,19 @@ export interface operations {
6993
7047
  id: string;
6994
7048
  } | null;
6995
7049
  activeRecurringFeePeriods?: {
6996
- listingId: string;
6997
7050
  startAt?: string | null;
6998
7051
  endAt?: string | null;
6999
7052
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
7000
7053
  rate?: number | null;
7001
- recurringFeeId: string;
7002
7054
  /** Format: uuid */
7003
7055
  id: string;
7056
+ recurringFee: {
7057
+ /** Format: uuid */
7058
+ id: string;
7059
+ title: string;
7060
+ /** @enum {string} */
7061
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7062
+ };
7004
7063
  }[] | null;
7005
7064
  source?: {
7006
7065
  /** Format: uuid */
@@ -7210,14 +7269,19 @@ export interface operations {
7210
7269
  id: string;
7211
7270
  } | null;
7212
7271
  activeRecurringFeePeriods?: {
7213
- listingId: string;
7214
7272
  startAt?: string | null;
7215
7273
  endAt?: string | null;
7216
7274
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
7217
7275
  rate?: number | null;
7218
- recurringFeeId: string;
7219
7276
  /** Format: uuid */
7220
7277
  id: string;
7278
+ recurringFee: {
7279
+ /** Format: uuid */
7280
+ id: string;
7281
+ title: string;
7282
+ /** @enum {string} */
7283
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7284
+ };
7221
7285
  }[] | null;
7222
7286
  source?: {
7223
7287
  /** Format: uuid */
@@ -7326,14 +7390,19 @@ export interface operations {
7326
7390
  status?: "active" | "inactive";
7327
7391
  defaultCurrency?: string | null;
7328
7392
  activeRecurringFeePeriods?: {
7329
- listingId: string;
7330
7393
  startAt?: string | null;
7331
7394
  endAt?: string | null;
7332
7395
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
7333
7396
  rate?: number | null;
7334
- recurringFeeId: string;
7335
7397
  /** Format: uuid */
7336
7398
  id: string;
7399
+ recurringFee: {
7400
+ /** Format: uuid */
7401
+ id: string;
7402
+ title: string;
7403
+ /** @enum {string} */
7404
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7405
+ };
7337
7406
  }[] | null;
7338
7407
  /** Format: uuid */
7339
7408
  sourceId?: string | null;
@@ -7411,14 +7480,19 @@ export interface operations {
7411
7480
  id: string;
7412
7481
  } | null;
7413
7482
  activeRecurringFeePeriods?: {
7414
- listingId: string;
7415
7483
  startAt?: string | null;
7416
7484
  endAt?: string | null;
7417
7485
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
7418
7486
  rate?: number | null;
7419
- recurringFeeId: string;
7420
7487
  /** Format: uuid */
7421
7488
  id: string;
7489
+ recurringFee: {
7490
+ /** Format: uuid */
7491
+ id: string;
7492
+ title: string;
7493
+ /** @enum {string} */
7494
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
7495
+ };
7422
7496
  }[] | null;
7423
7497
  source?: {
7424
7498
  /** Format: uuid */
@@ -9274,9 +9348,15 @@ export interface operations {
9274
9348
  endAt?: string | null;
9275
9349
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
9276
9350
  rate?: number | null;
9277
- recurringFeeId: string;
9278
9351
  /** Format: uuid */
9279
9352
  id: string;
9353
+ recurringFee: {
9354
+ /** Format: uuid */
9355
+ id: string;
9356
+ title: string;
9357
+ /** @enum {string} */
9358
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
9359
+ };
9280
9360
  }[];
9281
9361
  pagination: {
9282
9362
  /** @default 100 */
@@ -9380,9 +9460,15 @@ export interface operations {
9380
9460
  endAt?: string | null;
9381
9461
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
9382
9462
  rate?: number | null;
9383
- recurringFeeId: string;
9384
9463
  /** Format: uuid */
9385
9464
  id: string;
9465
+ recurringFee: {
9466
+ /** Format: uuid */
9467
+ id: string;
9468
+ title: string;
9469
+ /** @enum {string} */
9470
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
9471
+ };
9386
9472
  }[];
9387
9473
  };
9388
9474
  };
@@ -9474,9 +9560,15 @@ export interface operations {
9474
9560
  endAt?: string | null;
9475
9561
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
9476
9562
  rate?: number | null;
9477
- recurringFeeId: string;
9478
9563
  /** Format: uuid */
9479
9564
  id: string;
9565
+ recurringFee: {
9566
+ /** Format: uuid */
9567
+ id: string;
9568
+ title: string;
9569
+ /** @enum {string} */
9570
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
9571
+ };
9480
9572
  };
9481
9573
  };
9482
9574
  };
@@ -9558,9 +9650,15 @@ export interface operations {
9558
9650
  endAt?: string | null;
9559
9651
  /** @description Basis points between '0' and '100 000' ('100 000' => 100%, '1000' => 1%, '10' => 0.01%, '1' => 0.001%) */
9560
9652
  rate?: number | null;
9561
- recurringFeeId: string;
9562
9653
  /** Format: uuid */
9563
9654
  id: string;
9655
+ recurringFee: {
9656
+ /** Format: uuid */
9657
+ id: string;
9658
+ title: string;
9659
+ /** @enum {string} */
9660
+ type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
9661
+ };
9564
9662
  };
9565
9663
  };
9566
9664
  };
@@ -22427,6 +22525,168 @@ export interface operations {
22427
22525
  };
22428
22526
  };
22429
22527
  };
22528
+ getTrustReconciliationReportByListing: {
22529
+ parameters: {
22530
+ query: {
22531
+ endDate: string;
22532
+ listingId?: string;
22533
+ };
22534
+ header?: {
22535
+ "X-Team-Id"?: string;
22536
+ };
22537
+ path?: never;
22538
+ cookie?: never;
22539
+ };
22540
+ requestBody?: never;
22541
+ responses: {
22542
+ /** @description Successful response */
22543
+ 200: {
22544
+ headers: {
22545
+ [name: string]: unknown;
22546
+ };
22547
+ content: {
22548
+ "application/json": {
22549
+ data: {
22550
+ id: string;
22551
+ name: string;
22552
+ total: number;
22553
+ sections: {
22554
+ /** @enum {string} */
22555
+ name: "Owner Balance" | "Other Net Liabilities";
22556
+ total: number;
22557
+ /** @enum {string} */
22558
+ type: "accounts";
22559
+ accounts: {
22560
+ id: string;
22561
+ name: string;
22562
+ categoryId: string;
22563
+ total: number;
22564
+ }[];
22565
+ }[];
22566
+ }[];
22567
+ total: number;
22568
+ };
22569
+ };
22570
+ };
22571
+ /** @description Invalid input data */
22572
+ 400: {
22573
+ headers: {
22574
+ [name: string]: unknown;
22575
+ };
22576
+ content: {
22577
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
22578
+ };
22579
+ };
22580
+ /** @description Authorization not provided */
22581
+ 401: {
22582
+ headers: {
22583
+ [name: string]: unknown;
22584
+ };
22585
+ content: {
22586
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
22587
+ };
22588
+ };
22589
+ /** @description Insufficient access */
22590
+ 403: {
22591
+ headers: {
22592
+ [name: string]: unknown;
22593
+ };
22594
+ content: {
22595
+ "application/json": components["schemas"]["error.FORBIDDEN"];
22596
+ };
22597
+ };
22598
+ /** @description Not found */
22599
+ 404: {
22600
+ headers: {
22601
+ [name: string]: unknown;
22602
+ };
22603
+ content: {
22604
+ "application/json": components["schemas"]["error.NOT_FOUND"];
22605
+ };
22606
+ };
22607
+ /** @description Internal server error */
22608
+ 500: {
22609
+ headers: {
22610
+ [name: string]: unknown;
22611
+ };
22612
+ content: {
22613
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
22614
+ };
22615
+ };
22616
+ };
22617
+ };
22618
+ getTrustReconciliationReportByListingCsv: {
22619
+ parameters: {
22620
+ query: {
22621
+ endDate: string;
22622
+ listingId?: string;
22623
+ };
22624
+ header?: {
22625
+ "X-Team-Id"?: string;
22626
+ };
22627
+ path?: never;
22628
+ cookie?: never;
22629
+ };
22630
+ requestBody?: never;
22631
+ responses: {
22632
+ /** @description Successful response */
22633
+ 200: {
22634
+ headers: {
22635
+ [name: string]: unknown;
22636
+ };
22637
+ content: {
22638
+ "application/json": {
22639
+ url: string;
22640
+ };
22641
+ };
22642
+ };
22643
+ /** @description Invalid input data */
22644
+ 400: {
22645
+ headers: {
22646
+ [name: string]: unknown;
22647
+ };
22648
+ content: {
22649
+ "application/json": components["schemas"]["error.BAD_REQUEST"];
22650
+ };
22651
+ };
22652
+ /** @description Authorization not provided */
22653
+ 401: {
22654
+ headers: {
22655
+ [name: string]: unknown;
22656
+ };
22657
+ content: {
22658
+ "application/json": components["schemas"]["error.UNAUTHORIZED"];
22659
+ };
22660
+ };
22661
+ /** @description Insufficient access */
22662
+ 403: {
22663
+ headers: {
22664
+ [name: string]: unknown;
22665
+ };
22666
+ content: {
22667
+ "application/json": components["schemas"]["error.FORBIDDEN"];
22668
+ };
22669
+ };
22670
+ /** @description Not found */
22671
+ 404: {
22672
+ headers: {
22673
+ [name: string]: unknown;
22674
+ };
22675
+ content: {
22676
+ "application/json": components["schemas"]["error.NOT_FOUND"];
22677
+ };
22678
+ };
22679
+ /** @description Internal server error */
22680
+ 500: {
22681
+ headers: {
22682
+ [name: string]: unknown;
22683
+ };
22684
+ content: {
22685
+ "application/json": components["schemas"]["error.INTERNAL_SERVER_ERROR"];
22686
+ };
22687
+ };
22688
+ };
22689
+ };
22430
22690
  getTrustReconciliationReportCsv: {
22431
22691
  parameters: {
22432
22692
  query: {
@@ -22944,7 +23204,10 @@ export interface operations {
22944
23204
  /** @description comma separated categories */
22945
23205
  categoryIds?: string;
22946
23206
  classifications?: string;
23207
+ accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
23208
+ /** @description comma separated journal entry types */
22947
23209
  types?: string;
23210
+ /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" */
22948
23211
  entityTypes?: string;
22949
23212
  party?: "owners" | "manager";
22950
23213
  includeDetails?: boolean;
@@ -23092,7 +23355,10 @@ export interface operations {
23092
23355
  /** @description comma separated categories */
23093
23356
  categoryIds?: string;
23094
23357
  classifications?: string;
23358
+ accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
23359
+ /** @description comma separated journal entry types */
23095
23360
  types?: string;
23361
+ /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" */
23096
23362
  entityTypes?: string;
23097
23363
  party?: "owners" | "manager";
23098
23364
  };
@@ -23398,7 +23664,10 @@ export interface operations {
23398
23664
  /** @description comma separated categories */
23399
23665
  categoryIds?: string;
23400
23666
  classifications?: string;
23667
+ accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
23668
+ /** @description comma separated journal entry types */
23401
23669
  types?: string;
23670
+ /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" */
23402
23671
  entityTypes?: string;
23403
23672
  limit?: number;
23404
23673
  page?: number;
@@ -23544,7 +23813,10 @@ export interface operations {
23544
23813
  /** @description comma separated categories */
23545
23814
  categoryIds?: string;
23546
23815
  classifications?: string;
23816
+ accountType?: "ledger" | "bank" | "recurringFee" | "nonPosting";
23817
+ /** @description comma separated journal entry types */
23547
23818
  types?: string;
23819
+ /** @description comma separated entity types "reservation" | "deposit" | "expense" | "recurringFee" | "transfer" */
23548
23820
  entityTypes?: string;
23549
23821
  };
23550
23822
  header?: {