@vrplatform/api 1.3.1-stage.5543 → 1.3.1-stage.5583

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.5543",
6
+ "version": "1.3.1-stage.5583",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -154,14 +154,14 @@ export interface paths {
154
154
  */
155
155
  get: operations["getAccountsById"];
156
156
  /**
157
- * @description Update account by ID
157
+ * @description Update an account by ID. Status cannot be changed to inactive while an active recurring fee uses the account for direct or tax posting.
158
158
  *
159
159
  * Required scope: accounts:write
160
160
  */
161
161
  put: operations["putAccountsById"];
162
162
  post?: never;
163
163
  /**
164
- * @description Delete Account By ID
164
+ * @description Delete an account by ID, or archive a protected account with onLocked=archive. An account used as a direct or tax posting account by an active recurring fee cannot be deleted or archived.
165
165
  *
166
166
  * Required scope: accounts:delete
167
167
  */
@@ -320,7 +320,7 @@ export interface paths {
320
320
  cookie?: never;
321
321
  };
322
322
  /**
323
- * @description List apps. Legacy uncategorized apps return category as null.
323
+ * @description List apps. Legacy uncategorized apps return category as null. Validated extractor capabilities include full, cursor, and manual-only sync modes.
324
324
  *
325
325
  * Required scope: integrations:read
326
326
  */
@@ -341,7 +341,7 @@ export interface paths {
341
341
  cookie?: never;
342
342
  };
343
343
  /**
344
- * @description Get an app by ID. Legacy uncategorized apps return category as null.
344
+ * @description Get an app by ID. Legacy uncategorized apps return category as null. Validated extractor capabilities include full, cursor, and manual-only sync modes.
345
345
  *
346
346
  * Required scope: integrations:read
347
347
  */
@@ -803,7 +803,7 @@ export interface paths {
803
803
  get?: never;
804
804
  put?: never;
805
805
  /**
806
- * @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity. PMS connections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Provider tasks that do not finish within 15 seconds return ERROR_TIMEOUT.
806
+ * @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity. PMS connections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
807
807
  *
808
808
  * Required scope: integrations:write
809
809
  */
@@ -960,7 +960,7 @@ export interface paths {
960
960
  get?: never;
961
961
  put?: never;
962
962
  /**
963
- * @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. The built-in API app preserves its existing server-generated identity. Provider identities owned by another connection are rejected before mutation. PMS reconnections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Provider tasks that do not finish within 15 seconds return ERROR_TIMEOUT.
963
+ * @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. The built-in API app preserves its existing server-generated identity. Provider identities owned by another connection are rejected before mutation. PMS reconnections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
964
964
  *
965
965
  * Required scope: integrations:write
966
966
  */
@@ -1002,7 +1002,7 @@ export interface paths {
1002
1002
  get?: never;
1003
1003
  put?: never;
1004
1004
  /**
1005
- * @description Sync connection by uniqueRef and type
1005
+ * @description Sync one connection resource by uniqueRef and type. The request waits at most 15 seconds across task dispatch and completion. A timeout returns the failed-sync response envelope while the provider task may continue in the background.
1006
1006
  *
1007
1007
  * Required scope: integrations:execute
1008
1008
  */
@@ -2443,7 +2443,7 @@ export interface paths {
2443
2443
  put: operations["putListingsById"];
2444
2444
  post?: never;
2445
2445
  /**
2446
- * @description Delete Listing By ID
2446
+ * @description Delete a listing by ID. Listings referenced by journals, reservations, statements, ownership locks, or child listings must be archived with onLocked=archive.
2447
2447
  *
2448
2448
  * Required scope: listings:delete
2449
2449
  */
@@ -3492,7 +3492,7 @@ export interface paths {
3492
3492
  get: operations["getRecurringFees"];
3493
3493
  put?: never;
3494
3494
  /**
3495
- * @description Create Recurring Fees
3495
+ * @description Create a recurring fee. Active fees require tenant-owned active direct and tax posting accounts.
3496
3496
  *
3497
3497
  * Required scope: recurring-fees:write
3498
3498
  */
@@ -3590,7 +3590,7 @@ export interface paths {
3590
3590
  */
3591
3591
  get: operations["getRecurringFeesById"];
3592
3592
  /**
3593
- * @description Update Recurring Fees
3593
+ * @description Update a recurring fee. Active fees require tenant-owned active direct and tax posting accounts, including on reactivation.
3594
3594
  *
3595
3595
  * Required scope: recurring-fees:write
3596
3596
  */
@@ -4119,7 +4119,7 @@ export interface paths {
4119
4119
  cookie?: never;
4120
4120
  };
4121
4121
  /**
4122
- * @description Sales Tax Liability Report. Collectable taxes include reservation postings and reservation-attributed revenue reclassifications; tax remittances are excluded.
4122
+ * @description Sales Tax Liability Report. Taxable income excludes synthetic A/R adjustment mirrors. Collectable taxes include reservation postings and reservation-attributed revenue reclassifications; tax remittances are excluded.
4123
4123
  *
4124
4124
  * Required scope: reports:read
4125
4125
  */
@@ -4140,7 +4140,7 @@ export interface paths {
4140
4140
  cookie?: never;
4141
4141
  };
4142
4142
  /**
4143
- * @description Sales Tax Liability Report CSV
4143
+ * @description Sales Tax Liability Report. Taxable income excludes synthetic A/R adjustment mirrors. Collectable taxes include reservation postings and reservation-attributed revenue reclassifications; tax remittances are excluded. Returns a CSV export.
4144
4144
  *
4145
4145
  * Required scope: reports:read, reports:export
4146
4146
  */
@@ -4287,7 +4287,7 @@ export interface paths {
4287
4287
  cookie?: never;
4288
4288
  };
4289
4289
  /**
4290
- * @description Get reservations
4290
+ * @description Get reservations with the same materialized issues returned by reservation detail. Issue freshness is exposed through issuesComputedAt and issuesStale.
4291
4291
  *
4292
4292
  * Required scope: reservations:read
4293
4293
  */
@@ -4444,7 +4444,7 @@ export interface paths {
4444
4444
  cookie?: never;
4445
4445
  };
4446
4446
  /**
4447
- * @description Get reservation detail with financial totals, inactive lines, locks, and issues. Financial lines omit generated adjustment A/R mirror legs; pre-start rows return priorToStartDate.
4447
+ * @description Get reservation detail with financial totals, inactive lines, locks, and issues. Issue freshness is exposed through issuesComputedAt and issuesStale. Financial lines omit generated adjustment A/R mirror legs; pre-start rows return priorToStartDate.
4448
4448
  *
4449
4449
  * Required scope: reservations:read
4450
4450
  */
@@ -4498,7 +4498,7 @@ export interface paths {
4498
4498
  get?: never;
4499
4499
  put?: never;
4500
4500
  /**
4501
- * @description Create a reservation adjustment line. Adjustments post additional journal entries for the reservation and are the supported way to change locked reservations. Pass type or recurringFeeId when the booking is active; canceled bookings may create an unclassified adjustment. onLocked=nextOpen to resolve and persist the earliest valid posting date, or provide generalLedgerPostingAt explicitly. The two options cannot be combined. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
4501
+ * @description Create a reservation adjustment line. Adjustments post additional journal entries for the reservation and are the supported way to change locked reservations. Pass type or recurringFeeId when the booking is active; canceled bookings may create an unclassified adjustment. A recurring-fee adjustment is rejected before persistence when the fee uses an inactive posting account. onLocked=nextOpen to resolve and persist the earliest valid posting date, or provide generalLedgerPostingAt explicitly. The two options cannot be combined. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
4502
4502
  *
4503
4503
  * Required scope: reservations:write
4504
4504
  */
@@ -4518,7 +4518,7 @@ export interface paths {
4518
4518
  };
4519
4519
  get?: never;
4520
4520
  /**
4521
- * @description Update a reservation adjustment line. Refreshes the reservation journal inline; the update is rejected when the adjustment posts into a books-closed month or its journal entries are attached to an owner statement. Move the generalLedgerPostingAt date after the locked range to adjust a locked reservation. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
4521
+ * @description Update a reservation adjustment line. Refreshes the reservation journal inline; the update is rejected when the adjustment posts into a books-closed month or its journal entries are attached to an owner statement. A recurring-fee adjustment is also rejected before persistence when the fee uses an inactive posting account. Move the generalLedgerPostingAt date after the locked range to adjust a locked reservation. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates.
4522
4522
  *
4523
4523
  * Required scope: reservations:write
4524
4524
  */
@@ -5182,7 +5182,7 @@ export interface paths {
5182
5182
  */
5183
5183
  get: operations["getRate"];
5184
5184
  /**
5185
- * @description Update a tax rate
5185
+ * @description Update a tax rate. Posting accounts must remain active while the rate is used by an active recurring fee.
5186
5186
  *
5187
5187
  * Required scope: tax-rates:write
5188
5188
  */
@@ -12471,7 +12471,7 @@ export interface operations {
12471
12471
  extractors: {
12472
12472
  name: string;
12473
12473
  /** @enum {string} */
12474
- sync: "full" | "cursor";
12474
+ sync: "full" | "cursor" | "none";
12475
12475
  visible?: boolean;
12476
12476
  isDateRangeFetchable?: boolean;
12477
12477
  /** @enum {string} */
@@ -12777,7 +12777,7 @@ export interface operations {
12777
12777
  extractors: {
12778
12778
  name: string;
12779
12779
  /** @enum {string} */
12780
- sync: "full" | "cursor";
12780
+ sync: "full" | "cursor" | "none";
12781
12781
  visible?: boolean;
12782
12782
  isDateRangeFetchable?: boolean;
12783
12783
  /** @enum {string} */
@@ -88672,6 +88672,8 @@ export interface operations {
88672
88672
  };
88673
88673
  message: string;
88674
88674
  })[];
88675
+ issuesComputedAt: string | null;
88676
+ issuesStale: boolean;
88675
88677
  connection?: {
88676
88678
  /** Format: uuid */
88677
88679
  id: string;
@@ -89203,6 +89205,8 @@ export interface operations {
89203
89205
  };
89204
89206
  message: string;
89205
89207
  })[];
89208
+ issuesComputedAt: string | null;
89209
+ issuesStale: boolean;
89206
89210
  connection?: {
89207
89211
  /** Format: uuid */
89208
89212
  id: string;
@@ -91862,6 +91866,8 @@ export interface operations {
91862
91866
  };
91863
91867
  message: string;
91864
91868
  })[];
91869
+ issuesComputedAt: string | null;
91870
+ issuesStale: boolean;
91865
91871
  connection?: {
91866
91872
  /** Format: uuid */
91867
91873
  id: string;
@@ -92646,6 +92652,8 @@ export interface operations {
92646
92652
  };
92647
92653
  message: string;
92648
92654
  })[];
92655
+ issuesComputedAt: string | null;
92656
+ issuesStale: boolean;
92649
92657
  connection?: {
92650
92658
  /** Format: uuid */
92651
92659
  id: string;
@@ -93844,6 +93852,8 @@ export interface operations {
93844
93852
  };
93845
93853
  message: string;
93846
93854
  })[];
93855
+ issuesComputedAt: string | null;
93856
+ issuesStale: boolean;
93847
93857
  connection?: {
93848
93858
  /** Format: uuid */
93849
93859
  id: string;
@@ -94520,6 +94530,8 @@ export interface operations {
94520
94530
  };
94521
94531
  message: string;
94522
94532
  })[];
94533
+ issuesComputedAt: string | null;
94534
+ issuesStale: boolean;
94523
94535
  connection?: {
94524
94536
  /** Format: uuid */
94525
94537
  id: string;
@@ -95178,6 +95190,8 @@ export interface operations {
95178
95190
  };
95179
95191
  message: string;
95180
95192
  })[];
95193
+ issuesComputedAt: string | null;
95194
+ issuesStale: boolean;
95181
95195
  connection?: {
95182
95196
  /** Format: uuid */
95183
95197
  id: string;