@vrplatform/api 1.3.1-stage.4722 → 1.3.1-stage.4728

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.1-stage.4722",
6
+ "version": "1.3.1-stage.4728",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -1417,9 +1417,9 @@ export interface paths {
1417
1417
  path?: never;
1418
1418
  cookie?: never;
1419
1419
  };
1420
- /** @description Retrieve opening trial balance */
1420
+ /** @description Retrieve active balance-sheet and equity opening trial balance rows. Operating is editable for non-bank ledger accounts, Trust is read-only, and Combined is calculated as Operating plus Trust. Bank rows are visible but cannot be edited or imported. Trust totals aggregate active Trust journal activity across all party attribution before the GL start date. */
1421
1421
  get: operations["getGeneralLedgerOpeningTrialBalance"];
1422
- /** @description Update the manual opening trial balance. Replaces the manually entered opening balance postings that seed each account as of the go-live date; existing journal activity after that date is not touched. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
1422
+ /** @description Update the manual opening trial balance. Replaces Operating values for editable non-bank ledger rows. Trust-backed rows return importable=false but remain manually editable. Bank rows and existing journal activity after the go-live date are not changed. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
1423
1423
  put: operations["putGeneralLedgerOpeningTrialBalance"];
1424
1424
  post?: never;
1425
1425
  delete?: never;
@@ -11683,12 +11683,8 @@ export interface operations {
11683
11683
  includeMatchingTransactions?: string;
11684
11684
  hasMatchingTransactions?: boolean;
11685
11685
  reservationLineFilter?: "all" | "reservationOnly" | "nonReservationOnly";
11686
- /** @description Field to sort by */
11687
- sortBy?: "created" | "amount" | "matched";
11688
- /** @description Sort direction, defaults to desc */
11689
- sortDirection?: "asc" | "desc";
11690
- /** @description Deprecated: use sortBy + sortDirection */
11691
- sort?: "created_desc" | "created_asc" | "amount_desc" | "amount_asc" | "matched_desc" | "matched_asc";
11686
+ /** @description Sort field; prefix with - for descending order */
11687
+ sort?: "date" | "-date" | "amount" | "-amount" | "matched" | "-matched";
11692
11688
  limit?: number;
11693
11689
  page?: number;
11694
11690
  offset?: number;
@@ -12261,12 +12257,8 @@ export interface operations {
12261
12257
  includeMatchingTransactions?: string;
12262
12258
  hasMatchingTransactions?: boolean;
12263
12259
  reservationLineFilter?: "all" | "reservationOnly" | "nonReservationOnly";
12264
- /** @description Field to sort by */
12265
- sortBy?: "created" | "amount" | "matched";
12266
- /** @description Sort direction, defaults to desc */
12267
- sortDirection?: "asc" | "desc";
12268
- /** @description Deprecated: use sortBy + sortDirection */
12269
- sort?: "created_desc" | "created_asc" | "amount_desc" | "amount_asc" | "matched_desc" | "matched_asc";
12260
+ /** @description Sort field; prefix with - for descending order */
12261
+ sort?: "date" | "-date" | "amount" | "-amount" | "matched" | "-matched";
12270
12262
  };
12271
12263
  header?: never;
12272
12264
  path?: never;
@@ -21582,10 +21574,8 @@ export interface operations {
21582
21574
  search?: string;
21583
21575
  /** @description Filter files by their upload purpose. */
21584
21576
  type?: "userUpload" | "historicalData" | "historicalOwnerStatement" | "ownerStatementExample" | "listingOwnerAssignment" | "listingFeeAssignment";
21585
- /** @description Field to sort files by. */
21586
- sortBy?: "filename" | "startDate" | "endDate" | "createdAt" | "contactName";
21587
- /** @description Sort direction. */
21588
- sortDirection?: "asc" | "desc";
21577
+ /** @description Sort field; prefix with - for descending order. */
21578
+ sort?: "filename" | "-filename" | "startDate" | "-startDate" | "endDate" | "-endDate" | "createdAt" | "-createdAt" | "contactName" | "-contactName";
21589
21579
  limit?: number;
21590
21580
  page?: number;
21591
21581
  offset?: number;
@@ -26501,6 +26491,7 @@ export interface operations {
26501
26491
  /** @description Value in cents (100 = 1€) */
26502
26492
  operatingCentTotal: number;
26503
26493
  editable: boolean;
26494
+ importable: boolean;
26504
26495
  }[];
26505
26496
  assignment: {
26506
26497
  /** Format: uuid */
@@ -26513,12 +26504,6 @@ export interface operations {
26513
26504
  /** @description Value in cents (100 = 1€) */
26514
26505
  operatingCentTotal: number;
26515
26506
  };
26516
- trustReversal: {
26517
- /** @enum {string} */
26518
- status: "not_created" | "active" | "locked";
26519
- journalEntryIds: string[];
26520
- lastRefreshedAt?: string | null;
26521
- };
26522
26507
  };
26523
26508
  };
26524
26509
  };
@@ -26673,7 +26658,7 @@ export interface operations {
26673
26658
  /** Format: uuid */
26674
26659
  accountId: string;
26675
26660
  /** @description Value in cents (100 = 1€) */
26676
- combinedCentTotal: number;
26661
+ operatingCentTotal: number;
26677
26662
  }[];
26678
26663
  };
26679
26664
  };
@@ -26713,6 +26698,7 @@ export interface operations {
26713
26698
  /** @description Value in cents (100 = 1€) */
26714
26699
  operatingCentTotal: number;
26715
26700
  editable: boolean;
26701
+ importable: boolean;
26716
26702
  }[];
26717
26703
  assignment: {
26718
26704
  /** Format: uuid */
@@ -26725,12 +26711,6 @@ export interface operations {
26725
26711
  /** @description Value in cents (100 = 1€) */
26726
26712
  operatingCentTotal: number;
26727
26713
  };
26728
- trustReversal: {
26729
- /** @enum {string} */
26730
- status: "not_created" | "active" | "locked";
26731
- journalEntryIds: string[];
26732
- lastRefreshedAt?: string | null;
26733
- };
26734
26714
  };
26735
26715
  };
26736
26716
  };
@@ -29137,8 +29117,7 @@ export interface operations {
29137
29117
  query?: {
29138
29118
  search?: string;
29139
29119
  status?: "testing" | "ready" | "deployed";
29140
- sortBy?: "createdAt" | "title";
29141
- sortDirection?: "asc" | "desc";
29120
+ sort?: "createdAt" | "-createdAt" | "title" | "-title";
29142
29121
  limit?: number;
29143
29122
  page?: number;
29144
29123
  offset?: number;
@@ -42557,10 +42536,8 @@ export interface operations {
42557
42536
  partnerId?: string;
42558
42537
  product?: "vrtrust" | "vrintegrations";
42559
42538
  billingPlan?: string;
42560
- /** @description Field to sort by, defaults to created */
42561
- sortBy?: "name" | "created" | "partnerName" | "product" | "activeListings" | "billingPlan";
42562
- /** @description Sort direction, defaults to desc */
42563
- sortDirection?: "asc" | "desc";
42539
+ /** @description Sort field; prefix with - for descending order */
42540
+ sort?: "name" | "-name" | "created" | "-created" | "partnerName" | "-partnerName" | "product" | "-product" | "activeListings" | "-activeListings" | "billingPlan" | "-billingPlan";
42564
42541
  limit?: number;
42565
42542
  page?: number;
42566
42543
  offset?: number;
@@ -42768,10 +42745,8 @@ export interface operations {
42768
42745
  appId?: string;
42769
42746
  /** @description Filter teams by whether an active connection is in error */
42770
42747
  isErrorState?: boolean;
42771
- /** @description Team field to sort by; defaults to createdAt */
42772
- sortBy?: "name" | "createdAt";
42773
- /** @description Sort direction; defaults to desc for createdAt and asc for name */
42774
- sortDirection?: "asc" | "desc";
42748
+ /** @description Sort field; prefix with - for descending order */
42749
+ sort?: "name" | "-name" | "createdAt" | "-createdAt";
42775
42750
  limit?: number;
42776
42751
  page?: number;
42777
42752
  offset?: number;
@@ -43866,10 +43841,8 @@ export interface operations {
43866
43841
  query?: {
43867
43842
  /** @description Filter by team name */
43868
43843
  search?: string;
43869
- /** @description Owner statement status count to sort by */
43870
- sortBy?: "draft" | "inReview" | "published";
43871
- /** @description Sort direction, defaults to asc */
43872
- sortDirection?: "asc" | "desc";
43844
+ /** @description Sort field; prefix with - for descending order */
43845
+ sort?: "name" | "-name" | "draft" | "-draft" | "inReview" | "-inReview" | "published" | "-published";
43873
43846
  limit?: number;
43874
43847
  page?: number;
43875
43848
  offset?: number;
@@ -44064,10 +44037,8 @@ export interface operations {
44064
44037
  teamIds?: string;
44065
44038
  /** @description users: non-owner users with a portfolio membership; owners: owner users linked via membership or owner access; missing: users without any portfolio membership (delete candidates). Omitted returns every linked user. */
44066
44039
  view?: "users" | "owners" | "missing";
44067
- /** @description Field to sort by */
44068
- sortBy?: "name" | "email" | "lastSeen" | "created";
44069
- /** @description Sort direction, defaults to asc */
44070
- sortDirection?: "asc" | "desc";
44040
+ /** @description Sort field; prefix with - for descending order */
44041
+ sort?: "name" | "-name" | "email" | "-email" | "lastSeen" | "-lastSeen" | "created" | "-created";
44071
44042
  limit?: number;
44072
44043
  page?: number;
44073
44044
  offset?: number;
@@ -76154,14 +76125,10 @@ export interface operations {
76154
76125
  connectionId?: string;
76155
76126
  type?: "extract" | "automate" | "flow" | "webhook";
76156
76127
  status?: "queued" | "started" | "completed" | "failed" | "canceled";
76157
- /** @description Deprecated: use sortBy + sortDirection */
76158
- sort?: "created_asc" | "created_desc" | "updated_asc" | "updated_desc";
76128
+ /** @description Sort field; prefix with - for descending order */
76129
+ sort?: "created" | "-created" | "updated" | "-updated";
76159
76130
  /** @description Comma-separated sync IDs. */
76160
76131
  ids?: string;
76161
- /** @description Field to sort by */
76162
- sortBy?: "created" | "updated";
76163
- /** @description Sort direction, defaults to desc */
76164
- sortDirection?: "asc" | "desc";
76165
76132
  limit?: number;
76166
76133
  page?: number;
76167
76134
  offset?: number;
@@ -81766,12 +81733,8 @@ export interface operations {
81766
81733
  /** @description Include partner-dashboard listing, member, connection, issue, and child-team counts. */
81767
81734
  includeAggregates?: boolean;
81768
81735
  type?: "partner" | "propertyManager";
81769
- /** @description Field to sort by */
81770
- sortBy?: "created" | "name" | "type";
81771
- /** @description Sort direction, defaults to desc */
81772
- sortDirection?: "asc" | "desc";
81773
- /** @description Deprecated: use sortBy + sortDirection */
81774
- sort?: "created_desc" | "created_asc" | "name_asc" | "name_desc" | "type_asc" | "type_desc";
81736
+ /** @description Sort field; prefix with - for descending order */
81737
+ sort?: "created" | "-created" | "name" | "-name" | "type" | "-type";
81775
81738
  /** @description You can use elipisis: YYYY-MM-DD...YYYY-MM-DD */
81776
81739
  date?: string;
81777
81740
  limit?: number;