@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.
@@ -153,14 +153,14 @@ export interface paths {
153
153
  */
154
154
  get: operations["getAccountsById"];
155
155
  /**
156
- * @description Update account by ID
156
+ * @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.
157
157
  *
158
158
  * Required scope: accounts:write
159
159
  */
160
160
  put: operations["putAccountsById"];
161
161
  post?: never;
162
162
  /**
163
- * @description Delete Account By ID
163
+ * @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.
164
164
  *
165
165
  * Required scope: accounts:delete
166
166
  */
@@ -319,7 +319,7 @@ export interface paths {
319
319
  cookie?: never;
320
320
  };
321
321
  /**
322
- * @description List apps. Legacy uncategorized apps return category as null.
322
+ * @description List apps. Legacy uncategorized apps return category as null. Validated extractor capabilities include full, cursor, and manual-only sync modes.
323
323
  *
324
324
  * Required scope: integrations:read
325
325
  */
@@ -340,7 +340,7 @@ export interface paths {
340
340
  cookie?: never;
341
341
  };
342
342
  /**
343
- * @description Get an app by ID. Legacy uncategorized apps return category as null.
343
+ * @description Get an app by ID. Legacy uncategorized apps return category as null. Validated extractor capabilities include full, cursor, and manual-only sync modes.
344
344
  *
345
345
  * Required scope: integrations:read
346
346
  */
@@ -802,7 +802,7 @@ export interface paths {
802
802
  get?: never;
803
803
  put?: never;
804
804
  /**
805
- * @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.
805
+ * @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.
806
806
  *
807
807
  * Required scope: integrations:write
808
808
  */
@@ -959,7 +959,7 @@ export interface paths {
959
959
  get?: never;
960
960
  put?: never;
961
961
  /**
962
- * @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.
962
+ * @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.
963
963
  *
964
964
  * Required scope: integrations:write
965
965
  */
@@ -1001,7 +1001,7 @@ export interface paths {
1001
1001
  get?: never;
1002
1002
  put?: never;
1003
1003
  /**
1004
- * @description Sync connection by uniqueRef and type
1004
+ * @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.
1005
1005
  *
1006
1006
  * Required scope: integrations:execute
1007
1007
  */
@@ -2442,7 +2442,7 @@ export interface paths {
2442
2442
  put: operations["putListingsById"];
2443
2443
  post?: never;
2444
2444
  /**
2445
- * @description Delete Listing By ID
2445
+ * @description Delete a listing by ID. Listings referenced by journals, reservations, statements, ownership locks, or child listings must be archived with onLocked=archive.
2446
2446
  *
2447
2447
  * Required scope: listings:delete
2448
2448
  */
@@ -3491,7 +3491,7 @@ export interface paths {
3491
3491
  get: operations["getRecurringFees"];
3492
3492
  put?: never;
3493
3493
  /**
3494
- * @description Create Recurring Fees
3494
+ * @description Create a recurring fee. Active fees require tenant-owned active direct and tax posting accounts.
3495
3495
  *
3496
3496
  * Required scope: recurring-fees:write
3497
3497
  */
@@ -3589,7 +3589,7 @@ export interface paths {
3589
3589
  */
3590
3590
  get: operations["getRecurringFeesById"];
3591
3591
  /**
3592
- * @description Update Recurring Fees
3592
+ * @description Update a recurring fee. Active fees require tenant-owned active direct and tax posting accounts, including on reactivation.
3593
3593
  *
3594
3594
  * Required scope: recurring-fees:write
3595
3595
  */
@@ -4118,7 +4118,7 @@ export interface paths {
4118
4118
  cookie?: never;
4119
4119
  };
4120
4120
  /**
4121
- * @description Sales Tax Liability Report. Collectable taxes include reservation postings and reservation-attributed revenue reclassifications; tax remittances are excluded.
4121
+ * @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.
4122
4122
  *
4123
4123
  * Required scope: reports:read
4124
4124
  */
@@ -4139,7 +4139,7 @@ export interface paths {
4139
4139
  cookie?: never;
4140
4140
  };
4141
4141
  /**
4142
- * @description Sales Tax Liability Report CSV
4142
+ * @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.
4143
4143
  *
4144
4144
  * Required scope: reports:read, reports:export
4145
4145
  */
@@ -4286,7 +4286,7 @@ export interface paths {
4286
4286
  cookie?: never;
4287
4287
  };
4288
4288
  /**
4289
- * @description Get reservations
4289
+ * @description Get reservations with the same materialized issues returned by reservation detail. Issue freshness is exposed through issuesComputedAt and issuesStale.
4290
4290
  *
4291
4291
  * Required scope: reservations:read
4292
4292
  */
@@ -4443,7 +4443,7 @@ export interface paths {
4443
4443
  cookie?: never;
4444
4444
  };
4445
4445
  /**
4446
- * @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.
4446
+ * @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.
4447
4447
  *
4448
4448
  * Required scope: reservations:read
4449
4449
  */
@@ -4497,7 +4497,7 @@ export interface paths {
4497
4497
  get?: never;
4498
4498
  put?: never;
4499
4499
  /**
4500
- * @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.
4500
+ * @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.
4501
4501
  *
4502
4502
  * Required scope: reservations:write
4503
4503
  */
@@ -4517,7 +4517,7 @@ export interface paths {
4517
4517
  };
4518
4518
  get?: never;
4519
4519
  /**
4520
- * @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.
4520
+ * @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.
4521
4521
  *
4522
4522
  * Required scope: reservations:write
4523
4523
  */
@@ -5181,7 +5181,7 @@ export interface paths {
5181
5181
  */
5182
5182
  get: operations["getRate"];
5183
5183
  /**
5184
- * @description Update a tax rate
5184
+ * @description Update a tax rate. Posting accounts must remain active while the rate is used by an active recurring fee.
5185
5185
  *
5186
5186
  * Required scope: tax-rates:write
5187
5187
  */
@@ -12470,7 +12470,7 @@ export interface operations {
12470
12470
  extractors: {
12471
12471
  name: string;
12472
12472
  /** @enum {string} */
12473
- sync: "full" | "cursor";
12473
+ sync: "full" | "cursor" | "none";
12474
12474
  visible?: boolean;
12475
12475
  isDateRangeFetchable?: boolean;
12476
12476
  /** @enum {string} */
@@ -12776,7 +12776,7 @@ export interface operations {
12776
12776
  extractors: {
12777
12777
  name: string;
12778
12778
  /** @enum {string} */
12779
- sync: "full" | "cursor";
12779
+ sync: "full" | "cursor" | "none";
12780
12780
  visible?: boolean;
12781
12781
  isDateRangeFetchable?: boolean;
12782
12782
  /** @enum {string} */
@@ -88671,6 +88671,8 @@ export interface operations {
88671
88671
  };
88672
88672
  message: string;
88673
88673
  })[];
88674
+ issuesComputedAt: string | null;
88675
+ issuesStale: boolean;
88674
88676
  connection?: {
88675
88677
  /** Format: uuid */
88676
88678
  id: string;
@@ -89202,6 +89204,8 @@ export interface operations {
89202
89204
  };
89203
89205
  message: string;
89204
89206
  })[];
89207
+ issuesComputedAt: string | null;
89208
+ issuesStale: boolean;
89205
89209
  connection?: {
89206
89210
  /** Format: uuid */
89207
89211
  id: string;
@@ -91861,6 +91865,8 @@ export interface operations {
91861
91865
  };
91862
91866
  message: string;
91863
91867
  })[];
91868
+ issuesComputedAt: string | null;
91869
+ issuesStale: boolean;
91864
91870
  connection?: {
91865
91871
  /** Format: uuid */
91866
91872
  id: string;
@@ -92645,6 +92651,8 @@ export interface operations {
92645
92651
  };
92646
92652
  message: string;
92647
92653
  })[];
92654
+ issuesComputedAt: string | null;
92655
+ issuesStale: boolean;
92648
92656
  connection?: {
92649
92657
  /** Format: uuid */
92650
92658
  id: string;
@@ -93843,6 +93851,8 @@ export interface operations {
93843
93851
  };
93844
93852
  message: string;
93845
93853
  })[];
93854
+ issuesComputedAt: string | null;
93855
+ issuesStale: boolean;
93846
93856
  connection?: {
93847
93857
  /** Format: uuid */
93848
93858
  id: string;
@@ -94519,6 +94529,8 @@ export interface operations {
94519
94529
  };
94520
94530
  message: string;
94521
94531
  })[];
94532
+ issuesComputedAt: string | null;
94533
+ issuesStale: boolean;
94522
94534
  connection?: {
94523
94535
  /** Format: uuid */
94524
94536
  id: string;
@@ -95177,6 +95189,8 @@ export interface operations {
95177
95189
  };
95178
95190
  message: string;
95179
95191
  })[];
95192
+ issuesComputedAt: string | null;
95193
+ issuesStale: boolean;
95180
95194
  connection?: {
95181
95195
  /** Format: uuid */
95182
95196
  id: string;