@vrplatform/api 1.3.1-stage.4423 → 1.3.1-stage.4427

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.
@@ -1124,7 +1124,7 @@ export interface paths {
1124
1124
  };
1125
1125
  /** @description Retrieve opening balance accounts payable summary by party */
1126
1126
  get: operations["getGeneralLedgerOpeningBalancesAccountsPayable"];
1127
- /** @description Update opening balance accounts payable by party */
1127
+ /** @description Update opening balance accounts payable by party. Replaces the accounts payable opening balance postings for the given party as of the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
1128
1128
  put: operations["putGeneralLedgerOpeningBalancesAccountsPayable"];
1129
1129
  post?: never;
1130
1130
  delete?: never;
@@ -1142,7 +1142,7 @@ export interface paths {
1142
1142
  };
1143
1143
  /** @description Retrieve opening balance accounts receivable / deferred revenue summary */
1144
1144
  get: operations["getGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
1145
- /** @description Update opening balance accounts receivable / deferred revenue summary */
1145
+ /** @description Update opening balance accounts receivable / deferred revenue. Replaces the receivable and deferred revenue opening balance postings as of the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
1146
1146
  put: operations["putGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
1147
1147
  post?: never;
1148
1148
  delete?: never;
@@ -1160,7 +1160,7 @@ export interface paths {
1160
1160
  };
1161
1161
  /** @description Retrieve opening balance advanced deposits summary */
1162
1162
  get: operations["getGeneralLedgerOpeningBalancesAdvancedDeposits"];
1163
- /** @description Update opening balance advanced deposits */
1163
+ /** @description Update opening balance advanced deposits. Replaces the advanced deposit opening balance postings for stays that were paid before the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
1164
1164
  put: operations["putGeneralLedgerOpeningBalancesAdvancedDeposits"];
1165
1165
  post?: never;
1166
1166
  delete?: never;
@@ -1176,7 +1176,7 @@ export interface paths {
1176
1176
  path?: never;
1177
1177
  cookie?: never;
1178
1178
  };
1179
- /** @description Retrieve synced payments/refunds for review advanced deposits modal */
1179
+ /** @description Retrieve synced payments and refunds that are candidates for advanced deposit opening balances */
1180
1180
  get: operations["getGeneralLedgerOpeningBalancesAdvancedDepositsSyncedPaymentsRefunds"];
1181
1181
  put?: never;
1182
1182
  post?: never;
@@ -1195,7 +1195,7 @@ export interface paths {
1195
1195
  };
1196
1196
  /** @description Retrieve opening balance tax payable summary */
1197
1197
  get: operations["getGeneralLedgerOpeningBalancesTaxPayable"];
1198
- /** @description Update opening balance tax payable */
1198
+ /** @description Update opening balance tax payable. Replaces the tax payable opening balance postings as of the go-live date and returns the recalculated summary. Supports dryRun. See https://docs.vrplatform.app/guides/integrate/opening-trial-balance. */
1199
1199
  put: operations["putGeneralLedgerOpeningBalancesTaxPayable"];
1200
1200
  post?: never;
1201
1201
  delete?: never;
@@ -1213,7 +1213,7 @@ export interface paths {
1213
1213
  };
1214
1214
  /** @description Retrieve opening trial balance */
1215
1215
  get: operations["getGeneralLedgerOpeningTrialBalance"];
1216
- /** @description Update opening trial balance */
1216
+ /** @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. */
1217
1217
  put: operations["putGeneralLedgerOpeningTrialBalance"];
1218
1218
  post?: never;
1219
1219
  delete?: never;
@@ -1717,7 +1717,7 @@ export interface paths {
1717
1717
  /** @description List listing ownership periods */
1718
1718
  get: operations["getListingsOwnershipPeriods"];
1719
1719
  put?: never;
1720
- /** @description Create a listing ownership period */
1720
+ /** @description Create a listing ownership period. Periods cannot overlap; onConflict controls how date-range conflicts with existing periods are resolved (updateExisting by default, or error / adjustInsertingItem). Journal entries in the range are relinked to the new period, and setListingInactive=true marks entries in the range inactive so they are excluded from the books and owner statements. Changes touching books-closed or statement-locked months are rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/portfolio. */
1721
1721
  post: operations["postListingsOwnershipPeriods"];
1722
1722
  delete?: never;
1723
1723
  options?: never;
@@ -1734,10 +1734,10 @@ export interface paths {
1734
1734
  };
1735
1735
  /** @description Get a listing ownership period by ID */
1736
1736
  get: operations["getListingsOwnershipPeriodsById"];
1737
- /** @description Update a listing ownership period by ID */
1737
+ /** @description Update a listing ownership period by ID. Date-range changes relink journal entries to the adjusted period, with onConflict controlling how overlaps with neighboring periods are resolved (updateExisting by default). Toggling setListingInactive flips the active flag of the journal entries in the range and refreshes affected reservation totals. Changes touching books-closed or statement-locked months are rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/portfolio. */
1738
1738
  put: operations["putListingsOwnershipPeriodsById"];
1739
1739
  post?: never;
1740
- /** @description Delete a listing ownership period by ID */
1740
+ /** @description Delete a listing ownership period by ID. When deleting the last period, the default onLast=extendPrevious extends the previous period to cover the deleted range so journal entries keep an owning period; onLast=none leaves the gap open. Deletion is rejected when the period is locked by closed books or finalized statements unless onLocked=archive is passed, which archives instead of deleting. Supports dryRun. See https://docs.vrplatform.app/guides/build/portfolio. */
1741
1741
  delete: operations["deleteListingsOwnershipPeriodsById"];
1742
1742
  options?: never;
1743
1743
  head?: never;
@@ -3003,7 +3003,7 @@ export interface paths {
3003
3003
  /** @description Get reservations */
3004
3004
  get: operations["getReservations"];
3005
3005
  put?: never;
3006
- /** @description Create reservation */
3006
+ /** @description Create a reservation. Financial lines post journal entries inline against the listing ownership period covering the stay, so writes into books-closed or statement-locked months are rejected. Owner API keys cannot create reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations. */
3007
3007
  post: operations["postReservations"];
3008
3008
  delete?: never;
3009
3009
  options?: never;
@@ -3054,7 +3054,7 @@ export interface paths {
3054
3054
  };
3055
3055
  get?: never;
3056
3056
  put?: never;
3057
- /** @description Generate reservation journal entries */
3057
+ /** @description Regenerate reservation journal entries. Recomputes postings from the current reservation financials for the given ids (or the whole portfolio) and rewrites unlocked entries; lockPolicy controls how lock-flagged reservations are handled, while books-closed and owner-statement attachment locks always apply. bypassStatementPeriod is only supported for a single-reservation refresh. Generic dry run is unavailable because this operation needs a dedicated consequence preview for projected posting changes. See https://docs.vrplatform.app/guides/build/reservations. */
3058
3058
  post: operations["postReservationsJournalEntries"];
3059
3059
  delete?: never;
3060
3060
  options?: never;
@@ -3123,10 +3123,10 @@ export interface paths {
3123
3123
  };
3124
3124
  /** @description Get reservation By ID */
3125
3125
  get: operations["getReservationsById"];
3126
- /** @description Update Reservation By ID */
3126
+ /** @description Update a reservation by ID. Financial changes refresh the reservation journal inline; a reservation locked by closed books, a finalized statement period, or entries attached to an owner statement rejects them unless the change posts via a generalLedgerPostingAt date after the locked range. Owner API keys cannot update reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#editability. */
3127
3127
  put: operations["putReservationsById"];
3128
3128
  post?: never;
3129
- /** @description Delete reservation By ID */
3129
+ /** @description Delete a reservation by ID. Removes the reservation and its journal entries; deletion is rejected when the reservation is locked by closed books or statement attachments unless onLocked=archive is passed, which archives it instead while keeping the locked postings intact. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#editability. */
3130
3130
  delete: operations["deleteReservationsById"];
3131
3131
  options?: never;
3132
3132
  head?: never;
@@ -3141,7 +3141,7 @@ export interface paths {
3141
3141
  cookie?: never;
3142
3142
  };
3143
3143
  get?: never;
3144
- /** @description Update reservation general ledger status (active/inactive) */
3144
+ /** @description Update reservation general ledger status (active/inactive). Setting inactive flips the active flag of the reservation journal entries so they are excluded from the books and owner statements; setting active restores them. The change is rejected for entries locked by closed books or an owner statement attachment. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations. */
3145
3145
  put: operations["putReservationsByIdStatus"];
3146
3146
  post?: never;
3147
3147
  delete?: never;
@@ -3159,7 +3159,7 @@ export interface paths {
3159
3159
  };
3160
3160
  get?: never;
3161
3161
  put?: never;
3162
- /** @description Create a reservation adjustment line */
3162
+ /** @description Create a reservation adjustment line. Adjustments post additional journal entries for the reservation and are the supported way to change locked reservations: give the line a generalLedgerPostingAt date after the locked range and it posts into the open month instead of being rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates. */
3163
3163
  post: operations["postReservationsByReservationIdAdjustments"];
3164
3164
  delete?: never;
3165
3165
  options?: never;
@@ -3175,10 +3175,10 @@ export interface paths {
3175
3175
  cookie?: never;
3176
3176
  };
3177
3177
  get?: never;
3178
- /** @description Update a reservation adjustment line */
3178
+ /** @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. */
3179
3179
  put: operations["putReservationsByReservationIdAdjustmentsById"];
3180
3180
  post?: never;
3181
- /** @description Delete a reservation adjustment line */
3181
+ /** @description Delete a reservation adjustment line. Removes the adjustment and its journal entries and refreshes the reservation journal inline; deletion is rejected when the entries fall into a books-closed month or are attached to an owner statement. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates. */
3182
3182
  delete: operations["deleteReservationsByReservationIdAdjustmentsById"];
3183
3183
  options?: never;
3184
3184
  head?: never;
@@ -3212,7 +3212,7 @@ export interface paths {
3212
3212
  /** @description Get Statements List. Get Statements, either by year or dateRange + a single listing or owner or by month */
3213
3213
  get: operations["getStatements"];
3214
3214
  put?: never;
3215
- /** @description Create Statements */
3215
+ /** @description Create an owner statement for an ownership period and month. Freezes the statement layout, and creating with a finalized status (inReview or published) attaches the period journal entries to the statement, locking them against further changes. Statements with blocking issues cannot be created in a non-draft status, and publishing out of month order is rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements. */
3216
3216
  post: operations["postStatements"];
3217
3217
  delete?: never;
3218
3218
  options?: never;
@@ -3244,7 +3244,7 @@ export interface paths {
3244
3244
  path?: never;
3245
3245
  cookie?: never;
3246
3246
  };
3247
- /** @description Get Owner Statement CSV export (detailed) */
3247
+ /** @description Get owner statement detailed CSV export for a single ownership period and month. Renders the projected statement even when no statement record has been persisted yet, so drafts and previews can be exported. Returns a short-lived download URL. */
3248
3248
  get: operations["getStatementsByPeriodCsv"];
3249
3249
  put?: never;
3250
3250
  post?: never;
@@ -3261,7 +3261,7 @@ export interface paths {
3261
3261
  path?: never;
3262
3262
  cookie?: never;
3263
3263
  };
3264
- /** @description Get Owner Statement CSV export */
3264
+ /** @description Get owner statement list CSV export. Produces a summary CSV with one row per matched statement (status, payment, and balance columns) for a month, year, date range, or explicit statement IDs. Returns a short-lived download URL. */
3265
3265
  get: operations["getStatementsCsv"];
3266
3266
  put?: never;
3267
3267
  post?: never;
@@ -3278,7 +3278,7 @@ export interface paths {
3278
3278
  path?: never;
3279
3279
  cookie?: never;
3280
3280
  };
3281
- /** @description Get Owner Statement CSV export (detailed) */
3281
+ /** @description Get owner statement detailed CSV export. Produces a combined line-level CSV across all statements matched by the list filters, with rows rendered through the statement layout. Returns a short-lived download URL. */
3282
3282
  get: operations["getStatementsDetailCsv"];
3283
3283
  put?: never;
3284
3284
  post?: never;
@@ -3402,7 +3402,7 @@ export interface paths {
3402
3402
  };
3403
3403
  get?: never;
3404
3404
  put?: never;
3405
- /** @description Pay a property manager out */
3405
+ /** @description Pay the property manager out. Creates a payout transaction with a single manager-party line against either a bank account (bankAccountId) or an explicit ledger account (lineAccountId) - exactly one of the two must be provided - and posts the resulting journal entries on the payout date. Creation respects books-closed and statement locks and supports dryRun. See https://docs.vrplatform.app/guides/build/statements. */
3406
3406
  post: operations["postStatementsManagerPay"];
3407
3407
  delete?: never;
3408
3408
  options?: never;
@@ -3417,7 +3417,7 @@ export interface paths {
3417
3417
  path?: never;
3418
3418
  cookie?: never;
3419
3419
  };
3420
- /** @description Get Owner Statement by ID */
3420
+ /** @description Get owner statement PDF by ownership period and month */
3421
3421
  get: operations["getStatementsPdf"];
3422
3422
  put?: never;
3423
3423
  post?: never;
@@ -3434,7 +3434,7 @@ export interface paths {
3434
3434
  path?: never;
3435
3435
  cookie?: never;
3436
3436
  };
3437
- /** @description Get Owner Statements ZIP by month or listing month range */
3437
+ /** @description Get owner statements PDF ZIP by month or listing month range */
3438
3438
  get: operations["getStatementsPdfBatch"];
3439
3439
  put?: never;
3440
3440
  post?: never;
@@ -3470,10 +3470,10 @@ export interface paths {
3470
3470
  };
3471
3471
  /** @description Get Statements by period. Get Statements by ownership period, can be multiple if multiple currencies are found in a month */
3472
3472
  get: operations["getStatementsById"];
3473
- /** @description Update Statements by Id */
3473
+ /** @description Update an owner statement status (draft, inReview, published). Moving to a finalized status attaches the period journal entries to the statement and locks writes that reference the same ownership period; moving back to draft detaches them again. Transitions are rejected when the statement has blocking issues, when a later statement for the period is already finalized, or when a prior month is still unfinalized. Publishing can optionally email owners via emailDelivery. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements#status-transitions. */
3474
3474
  put: operations["putStatementsById"];
3475
3475
  post?: never;
3476
- /** @description Update Statements by Id */
3476
+ /** @description Delete an owner statement by ID. Deleting a finalized statement is rejected unless onLocked=unlockAndDelete is passed, which detaches the attached journal entries before deleting; historic-ledger entries that exist only for the statement are removed with it. Books-closed periods still deny the operation. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements. */
3477
3477
  delete: operations["deleteStatementsById"];
3478
3478
  options?: never;
3479
3479
  head?: never;
@@ -3489,7 +3489,7 @@ export interface paths {
3489
3489
  };
3490
3490
  get?: never;
3491
3491
  put?: never;
3492
- /** @description Pay a statement */
3492
+ /** @description Pay an owner statement. Creates one payout transfer transaction per ownership member, split by ownership percentage, with each line referencing the paid statement; the resulting journal entries post on the payout date and are consumed by the statement of that month. Omitting amount pays the full net income and is rejected with 409 if an active payout already exists for the statement; pass an explicit amount to record additional partial payments. Payout creation respects books-closed and statement-period locks and supports dryRun. See https://docs.vrplatform.app/guides/build/statements#pay-a-published-statement. */
3493
3493
  post: operations["postStatementsByIdPay"];
3494
3494
  delete?: never;
3495
3495
  options?: never;
@@ -3699,7 +3699,7 @@ export interface paths {
3699
3699
  cookie?: never;
3700
3700
  };
3701
3701
  get?: never;
3702
- /** @description Update the books closing date of the current team (the team in scope via the x-team-id header) */
3702
+ /** @description Update the books closing date of the current team (the team in scope via the x-team-id header). Books closed is the hard accounting lock: journal-affecting writes to reservations, transactions, statements, and ownership periods dated on or before booksClosedAt are rejected across the API. Set booksClosedAt to null to reopen the books. See https://docs.vrplatform.app/guides/build/accounting-administration. */
3703
3703
  put: operations["putTeamBooksClosing"];
3704
3704
  post?: never;
3705
3705
  delete?: never;
@@ -3732,9 +3732,9 @@ export interface paths {
3732
3732
  path?: never;
3733
3733
  cookie?: never;
3734
3734
  };
3735
- /** @description Get the current team VRPilot Onboarding Guide state */
3735
+ /** @description Get the current team's onboarding guide state */
3736
3736
  get: operations["getTeamGuidesOnboarding"];
3737
- /** @description Update the current team VRPilot Onboarding Guide state */
3737
+ /** @description Update the current team's onboarding guide state */
3738
3738
  put: operations["putTeamGuidesOnboarding"];
3739
3739
  post?: never;
3740
3740
  delete?: never;
@@ -3909,7 +3909,7 @@ export interface paths {
3909
3909
  /** @description Transactions List */
3910
3910
  get: operations["getTransactions"];
3911
3911
  put?: never;
3912
- /** @description Create a transaction. Line party defaults and validity depend on transaction type, owner context, account assignment, and account category. See https://docs.vrplatform.app/build/transactions#decision-table. For expense attachments, first upload each file with POST /transactions/attachments, then pass the returned ids in attachmentIds. Attachments are only supported for expense transactions. */
3912
+ /** @description Create a transaction. Journal entries post inline per line; creation into a books-closed month or a statement-locked listing period is rejected. Line party defaults and validity depend on transaction type, owner context, account assignment, and account category. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, first upload each file with POST /transactions/attachments, then pass the returned ids in attachmentIds. Attachments are only supported for expense transactions. */
3913
3913
  post: operations["postTransactions"];
3914
3914
  delete?: never;
3915
3915
  options?: never;
@@ -4029,7 +4029,7 @@ export interface paths {
4029
4029
  };
4030
4030
  get?: never;
4031
4031
  put?: never;
4032
- /** @description Regenerate transaction journal entries. Generic dry run is unavailable because this operation needs a dedicated consequence preview for projected posting changes. */
4032
+ /** @description Regenerate transaction journal entries. Recomputes postings from the current transaction lines for the given ids, listings, or date and rewrites unlocked entries; books-closed and owner-statement attachment locks always apply. Generic dry run is unavailable because this operation needs a dedicated consequence preview for projected posting changes. See https://docs.vrplatform.app/guides/build/transactions. */
4033
4033
  post: operations["postTransactionsJournalEntries"];
4034
4034
  delete?: never;
4035
4035
  options?: never;
@@ -4151,7 +4151,7 @@ export interface paths {
4151
4151
  };
4152
4152
  /** @description Transactions List */
4153
4153
  get: operations["getTransactionsById"];
4154
- /** @description Update a transaction by ID. Changing line account, assignment, listing, or reservation context can recompute a default or forced party. See https://docs.vrplatform.app/build/transactions#decision-table. For expense attachments, pass attachmentIds to replace the attached set. Omit attachmentIds to keep current attachments. Attachments are only supported for expense transactions. */
4154
+ /** @description Update a transaction by ID. Locks apply per line: lines whose journal entries are attached to an owner statement or fall into a books-closed month are locked while the remaining lines stay editable. Changing line account, assignment, listing, or reservation context can recompute a default or forced party. See https://docs.vrplatform.app/guides/build/transactions#decision-table. For expense attachments, pass attachmentIds to replace the attached set. Omit attachmentIds to keep current attachments. Attachments are only supported for expense transactions. */
4155
4155
  put: operations["putTransactionsById"];
4156
4156
  post?: never;
4157
4157
  /** @description Delete a transaction by ID. Use onLocked=archive to archive eligible locked transactions; the option does not bypass statement, books-closed, or reconciliation rules. */
@@ -4169,7 +4169,7 @@ export interface paths {
4169
4169
  cookie?: never;
4170
4170
  };
4171
4171
  get?: never;
4172
- /** @description Update a transaction line by ID. Account, assignment, listing, and reservation changes can recompute a default or forced party. See https://docs.vrplatform.app/build/transactions#decision-table. */
4172
+ /** @description Update a transaction line by ID. Account, assignment, listing, and reservation changes can recompute a default or forced party. See https://docs.vrplatform.app/guides/build/transactions#decision-table. */
4173
4173
  put: operations["putTransactionsByTransactionIdLinesById"];
4174
4174
  post?: never;
4175
4175
  delete?: never;
@@ -4593,6 +4593,7 @@ export interface operations {
4593
4593
  postAccounts: {
4594
4594
  parameters: {
4595
4595
  query?: {
4596
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
4596
4597
  dryRun?: boolean;
4597
4598
  };
4598
4599
  header?: never;
@@ -5449,6 +5450,7 @@ export interface operations {
5449
5450
  putAccountsById: {
5450
5451
  parameters: {
5451
5452
  query?: {
5453
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
5452
5454
  dryRun?: boolean;
5453
5455
  };
5454
5456
  header?: never;
@@ -5730,6 +5732,7 @@ export interface operations {
5730
5732
  parameters: {
5731
5733
  query?: {
5732
5734
  onLocked?: "error" | "archive";
5735
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
5733
5736
  dryRun?: boolean;
5734
5737
  };
5735
5738
  header?: never;
@@ -5893,6 +5896,7 @@ export interface operations {
5893
5896
  postAccountsByIdBankingInit: {
5894
5897
  parameters: {
5895
5898
  query?: {
5899
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
5896
5900
  dryRun?: boolean;
5897
5901
  };
5898
5902
  header?: never;
@@ -9419,6 +9423,7 @@ export interface operations {
9419
9423
  batchBankAccounts: {
9420
9424
  parameters: {
9421
9425
  query?: {
9426
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
9422
9427
  dryRun?: boolean;
9423
9428
  };
9424
9429
  header?: never;
@@ -9792,6 +9797,7 @@ export interface operations {
9792
9797
  updateBankAccount: {
9793
9798
  parameters: {
9794
9799
  query?: {
9800
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
9795
9801
  dryRun?: boolean;
9796
9802
  };
9797
9803
  header?: never;
@@ -10368,6 +10374,7 @@ export interface operations {
10368
10374
  postBankRecordsBatch: {
10369
10375
  parameters: {
10370
10376
  query?: {
10377
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
10371
10378
  dryRun?: boolean;
10372
10379
  };
10373
10380
  header?: never;
@@ -11091,6 +11098,7 @@ export interface operations {
11091
11098
  putBankRecordsById: {
11092
11099
  parameters: {
11093
11100
  query?: {
11101
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
11094
11102
  dryRun?: boolean;
11095
11103
  };
11096
11104
  header?: never;
@@ -11260,6 +11268,7 @@ export interface operations {
11260
11268
  deleteBankRecordsById: {
11261
11269
  parameters: {
11262
11270
  query?: {
11271
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
11263
11272
  dryRun?: boolean;
11264
11273
  };
11265
11274
  header?: never;
@@ -13023,6 +13032,7 @@ export interface operations {
13023
13032
  postBankRulesByIdRun: {
13024
13033
  parameters: {
13025
13034
  query?: {
13035
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
13026
13036
  dryRun?: boolean;
13027
13037
  };
13028
13038
  header?: never;
@@ -17087,6 +17097,7 @@ export interface operations {
17087
17097
  postContacts: {
17088
17098
  parameters: {
17089
17099
  query?: {
17100
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
17090
17101
  dryRun?: boolean;
17091
17102
  };
17092
17103
  header?: never;
@@ -17333,6 +17344,7 @@ export interface operations {
17333
17344
  postContactsBatch: {
17334
17345
  parameters: {
17335
17346
  query?: {
17347
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
17336
17348
  dryRun?: boolean;
17337
17349
  };
17338
17350
  header?: never;
@@ -17918,6 +17930,7 @@ export interface operations {
17918
17930
  putContactsById: {
17919
17931
  parameters: {
17920
17932
  query?: {
17933
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
17921
17934
  dryRun?: boolean;
17922
17935
  };
17923
17936
  header?: never;
@@ -18166,6 +18179,7 @@ export interface operations {
18166
18179
  parameters: {
18167
18180
  query?: {
18168
18181
  onLocked?: "error" | "archive";
18182
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
18169
18183
  dryRun?: boolean;
18170
18184
  };
18171
18185
  header?: never;
@@ -22658,6 +22672,7 @@ export interface operations {
22658
22672
  postGeneralLedgerHistorical: {
22659
22673
  parameters: {
22660
22674
  query?: {
22675
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
22661
22676
  dryRun?: boolean;
22662
22677
  };
22663
22678
  header?: never;
@@ -23003,6 +23018,7 @@ export interface operations {
23003
23018
  putGeneralLedgerOpeningBalancesAccountsPayable: {
23004
23019
  parameters: {
23005
23020
  query?: {
23021
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
23006
23022
  dryRun?: boolean;
23007
23023
  };
23008
23024
  header?: never;
@@ -23337,6 +23353,7 @@ export interface operations {
23337
23353
  putGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue: {
23338
23354
  parameters: {
23339
23355
  query?: {
23356
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
23340
23357
  dryRun?: boolean;
23341
23358
  };
23342
23359
  header?: never;
@@ -23682,6 +23699,7 @@ export interface operations {
23682
23699
  putGeneralLedgerOpeningBalancesAdvancedDeposits: {
23683
23700
  parameters: {
23684
23701
  query?: {
23702
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
23685
23703
  dryRun?: boolean;
23686
23704
  };
23687
23705
  header?: never;
@@ -24214,6 +24232,7 @@ export interface operations {
24214
24232
  putGeneralLedgerOpeningBalancesTaxPayable: {
24215
24233
  parameters: {
24216
24234
  query?: {
24235
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
24217
24236
  dryRun?: boolean;
24218
24237
  };
24219
24238
  header?: never;
@@ -24581,6 +24600,7 @@ export interface operations {
24581
24600
  putGeneralLedgerOpeningTrialBalance: {
24582
24601
  parameters: {
24583
24602
  query?: {
24603
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
24584
24604
  dryRun?: boolean;
24585
24605
  };
24586
24606
  header?: never;
@@ -28144,6 +28164,7 @@ export interface operations {
28144
28164
  statementStartAt?: string | null;
28145
28165
  effectiveStatementStartAt?: string | null;
28146
28166
  settings: {
28167
+ showVRPilotGuide: boolean;
28147
28168
  showReservations: boolean;
28148
28169
  showCancelledReservations: boolean;
28149
28170
  showReservationTotal: boolean;
@@ -28468,6 +28489,7 @@ export interface operations {
28468
28489
  statementStartAt?: string | null;
28469
28490
  effectiveStatementStartAt?: string | null;
28470
28491
  settings: {
28492
+ showVRPilotGuide: boolean;
28471
28493
  showReservations: boolean;
28472
28494
  showCancelledReservations: boolean;
28473
28495
  showReservationTotal: boolean;
@@ -30803,6 +30825,8 @@ export interface operations {
30803
30825
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
30804
30826
  rateType?: ("flat" | "percentage") | null;
30805
30827
  defaultRate?: number | null;
30828
+ /** @enum {string} */
30829
+ status: "active" | "inactive";
30806
30830
  };
30807
30831
  }[] | null;
30808
30832
  source?: {
@@ -31006,6 +31030,7 @@ export interface operations {
31006
31030
  postListings: {
31007
31031
  parameters: {
31008
31032
  query?: {
31033
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
31009
31034
  dryRun?: boolean;
31010
31035
  };
31011
31036
  header?: never;
@@ -31044,6 +31069,8 @@ export interface operations {
31044
31069
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
31045
31070
  rateType?: ("flat" | "percentage") | null;
31046
31071
  defaultRate?: number | null;
31072
+ /** @enum {string} */
31073
+ status: "active" | "inactive";
31047
31074
  };
31048
31075
  }[] | null;
31049
31076
  initialOwnership?: {
@@ -31163,6 +31190,8 @@ export interface operations {
31163
31190
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
31164
31191
  rateType?: ("flat" | "percentage") | null;
31165
31192
  defaultRate?: number | null;
31193
+ /** @enum {string} */
31194
+ status: "active" | "inactive";
31166
31195
  };
31167
31196
  }[] | null;
31168
31197
  source?: {
@@ -31356,6 +31385,7 @@ export interface operations {
31356
31385
  postListingsBatch: {
31357
31386
  parameters: {
31358
31387
  query?: {
31388
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
31359
31389
  dryRun?: boolean;
31360
31390
  };
31361
31391
  header?: never;
@@ -32312,6 +32342,7 @@ export interface operations {
32312
32342
  postListingsOwnershipPeriods: {
32313
32343
  parameters: {
32314
32344
  query?: {
32345
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
32315
32346
  dryRun?: boolean;
32316
32347
  };
32317
32348
  header?: never;
@@ -32691,6 +32722,7 @@ export interface operations {
32691
32722
  putListingsOwnershipPeriodsById: {
32692
32723
  parameters: {
32693
32724
  query?: {
32725
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
32694
32726
  dryRun?: boolean;
32695
32727
  };
32696
32728
  header?: never;
@@ -32893,6 +32925,7 @@ export interface operations {
32893
32925
  query?: {
32894
32926
  onLocked?: "error" | "archive";
32895
32927
  onLast?: "extendPrevious" | "none";
32928
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
32896
32929
  dryRun?: boolean;
32897
32930
  };
32898
32931
  header?: never;
@@ -33168,6 +33201,8 @@ export interface operations {
33168
33201
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
33169
33202
  rateType?: ("flat" | "percentage") | null;
33170
33203
  defaultRate?: number | null;
33204
+ /** @enum {string} */
33205
+ status: "active" | "inactive";
33171
33206
  };
33172
33207
  }[] | null;
33173
33208
  source?: {
@@ -33361,6 +33396,7 @@ export interface operations {
33361
33396
  putListingsById: {
33362
33397
  parameters: {
33363
33398
  query?: {
33399
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
33364
33400
  dryRun?: boolean;
33365
33401
  };
33366
33402
  header?: never;
@@ -33401,6 +33437,8 @@ export interface operations {
33401
33437
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
33402
33438
  rateType?: ("flat" | "percentage") | null;
33403
33439
  defaultRate?: number | null;
33440
+ /** @enum {string} */
33441
+ status: "active" | "inactive";
33404
33442
  };
33405
33443
  }[] | null;
33406
33444
  initialOwnership?: {
@@ -33520,6 +33558,8 @@ export interface operations {
33520
33558
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
33521
33559
  rateType?: ("flat" | "percentage") | null;
33522
33560
  defaultRate?: number | null;
33561
+ /** @enum {string} */
33562
+ status: "active" | "inactive";
33523
33563
  };
33524
33564
  }[] | null;
33525
33565
  source?: {
@@ -33714,6 +33754,7 @@ export interface operations {
33714
33754
  parameters: {
33715
33755
  query?: {
33716
33756
  onLocked?: "error" | "archive";
33757
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
33717
33758
  dryRun?: boolean;
33718
33759
  };
33719
33760
  header?: never;
@@ -34039,6 +34080,7 @@ export interface operations {
34039
34080
  putListingsByIdOpeningBalance: {
34040
34081
  parameters: {
34041
34082
  query?: {
34083
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
34042
34084
  dryRun?: boolean;
34043
34085
  };
34044
34086
  header?: never;
@@ -34211,6 +34253,7 @@ export interface operations {
34211
34253
  putListingsByIdParent: {
34212
34254
  parameters: {
34213
34255
  query?: {
34256
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
34214
34257
  dryRun?: boolean;
34215
34258
  };
34216
34259
  header?: never;
@@ -34329,6 +34372,8 @@ export interface operations {
34329
34372
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
34330
34373
  rateType?: ("flat" | "percentage") | null;
34331
34374
  defaultRate?: number | null;
34375
+ /** @enum {string} */
34376
+ status: "active" | "inactive";
34332
34377
  };
34333
34378
  }[] | null;
34334
34379
  source?: {
@@ -34522,6 +34567,7 @@ export interface operations {
34522
34567
  deleteListingsByIdParent: {
34523
34568
  parameters: {
34524
34569
  query?: {
34570
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
34525
34571
  dryRun?: boolean;
34526
34572
  };
34527
34573
  header?: never;
@@ -34637,6 +34683,8 @@ export interface operations {
34637
34683
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
34638
34684
  rateType?: ("flat" | "percentage") | null;
34639
34685
  defaultRate?: number | null;
34686
+ /** @enum {string} */
34687
+ status: "active" | "inactive";
34640
34688
  };
34641
34689
  }[] | null;
34642
34690
  source?: {
@@ -34893,6 +34941,7 @@ export interface operations {
34893
34941
  colorPrimary: string | null;
34894
34942
  logo: string | null;
34895
34943
  settings: {
34944
+ showVRPilotGuide: boolean;
34896
34945
  showReservations: boolean;
34897
34946
  showCancelledReservations: boolean;
34898
34947
  showReservationTotal: boolean;
@@ -40679,7 +40728,8 @@ export interface operations {
40679
40728
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
40680
40729
  taxBehavior?: ("excluded" | "included") | null;
40681
40730
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
40682
- status?: ("active" | "inactive") | null;
40731
+ /** @enum {string} */
40732
+ status: "active" | "inactive";
40683
40733
  rateType?: ("flat" | "percentage") | null;
40684
40734
  /** @enum {string} */
40685
40735
  creditParty: "manager" | "owners";
@@ -40918,6 +40968,7 @@ export interface operations {
40918
40968
  postRecurringFees: {
40919
40969
  parameters: {
40920
40970
  query?: {
40971
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
40921
40972
  dryRun?: boolean;
40922
40973
  };
40923
40974
  header?: never;
@@ -40976,7 +41027,8 @@ export interface operations {
40976
41027
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
40977
41028
  taxBehavior?: ("excluded" | "included") | null;
40978
41029
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
40979
- status?: ("active" | "inactive") | null;
41030
+ /** @enum {string} */
41031
+ status: "active" | "inactive";
40980
41032
  rateType?: ("flat" | "percentage") | null;
40981
41033
  /** @enum {string} */
40982
41034
  creditParty: "manager" | "owners";
@@ -41244,6 +41296,8 @@ export interface operations {
41244
41296
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
41245
41297
  rateType?: ("flat" | "percentage") | null;
41246
41298
  defaultRate?: number | null;
41299
+ /** @enum {string} */
41300
+ status: "active" | "inactive";
41247
41301
  };
41248
41302
  }[];
41249
41303
  pagination: {
@@ -41395,6 +41449,7 @@ export interface operations {
41395
41449
  postRecurringFeesListingPeriods: {
41396
41450
  parameters: {
41397
41451
  query?: {
41452
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
41398
41453
  dryRun?: boolean;
41399
41454
  };
41400
41455
  header?: never;
@@ -41437,6 +41492,8 @@ export interface operations {
41437
41492
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
41438
41493
  rateType?: ("flat" | "percentage") | null;
41439
41494
  defaultRate?: number | null;
41495
+ /** @enum {string} */
41496
+ status: "active" | "inactive";
41440
41497
  };
41441
41498
  };
41442
41499
  };
@@ -41578,6 +41635,7 @@ export interface operations {
41578
41635
  putRecurringFeesListingPeriodsById: {
41579
41636
  parameters: {
41580
41637
  query?: {
41638
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
41581
41639
  dryRun?: boolean;
41582
41640
  };
41583
41641
  header?: never;
@@ -41620,6 +41678,8 @@ export interface operations {
41620
41678
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
41621
41679
  rateType?: ("flat" | "percentage") | null;
41622
41680
  defaultRate?: number | null;
41681
+ /** @enum {string} */
41682
+ status: "active" | "inactive";
41623
41683
  };
41624
41684
  };
41625
41685
  };
@@ -41762,6 +41822,7 @@ export interface operations {
41762
41822
  parameters: {
41763
41823
  query?: {
41764
41824
  onLocked?: "error" | "archive";
41825
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
41765
41826
  dryRun?: boolean;
41766
41827
  };
41767
41828
  header?: never;
@@ -42267,7 +42328,8 @@ export interface operations {
42267
42328
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
42268
42329
  taxBehavior?: ("excluded" | "included") | null;
42269
42330
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
42270
- status?: ("active" | "inactive") | null;
42331
+ /** @enum {string} */
42332
+ status: "active" | "inactive";
42271
42333
  rateType?: ("flat" | "percentage") | null;
42272
42334
  /** @enum {string} */
42273
42335
  creditParty: "manager" | "owners";
@@ -42496,6 +42558,7 @@ export interface operations {
42496
42558
  putRecurringFeesById: {
42497
42559
  parameters: {
42498
42560
  query?: {
42561
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
42499
42562
  dryRun?: boolean;
42500
42563
  };
42501
42564
  header?: never;
@@ -42556,7 +42619,8 @@ export interface operations {
42556
42619
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
42557
42620
  taxBehavior?: ("excluded" | "included") | null;
42558
42621
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
42559
- status?: ("active" | "inactive") | null;
42622
+ /** @enum {string} */
42623
+ status: "active" | "inactive";
42560
42624
  rateType?: ("flat" | "percentage") | null;
42561
42625
  /** @enum {string} */
42562
42626
  creditParty: "manager" | "owners";
@@ -42786,6 +42850,7 @@ export interface operations {
42786
42850
  parameters: {
42787
42851
  query?: {
42788
42852
  onLocked?: "error" | "archive";
42853
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
42789
42854
  dryRun?: boolean;
42790
42855
  };
42791
42856
  header?: never;
@@ -55491,6 +55556,7 @@ export interface operations {
55491
55556
  postReservations: {
55492
55557
  parameters: {
55493
55558
  query?: {
55559
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
55494
55560
  dryRun?: boolean;
55495
55561
  };
55496
55562
  header?: never;
@@ -56099,6 +56165,7 @@ export interface operations {
56099
56165
  * @description Deprecated: use allowReferenceChange
56100
56166
  */
56101
56167
  noReferenceChange?: boolean;
56168
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
56102
56169
  dryRun?: boolean;
56103
56170
  };
56104
56171
  header?: never;
@@ -57970,6 +58037,7 @@ export interface operations {
57970
58037
  putReservationsById: {
57971
58038
  parameters: {
57972
58039
  query?: {
58040
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
57973
58041
  dryRun?: boolean;
57974
58042
  };
57975
58043
  header?: never;
@@ -58648,6 +58716,7 @@ export interface operations {
58648
58716
  parameters: {
58649
58717
  query?: {
58650
58718
  onLocked?: "error" | "archive";
58719
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
58651
58720
  dryRun?: boolean;
58652
58721
  };
58653
58722
  header?: never;
@@ -58811,6 +58880,7 @@ export interface operations {
58811
58880
  putReservationsByIdStatus: {
58812
58881
  parameters: {
58813
58882
  query?: {
58883
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
58814
58884
  dryRun?: boolean;
58815
58885
  };
58816
58886
  header?: never;
@@ -58979,6 +59049,7 @@ export interface operations {
58979
59049
  postReservationsByReservationIdAdjustments: {
58980
59050
  parameters: {
58981
59051
  query?: {
59052
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
58982
59053
  dryRun?: boolean;
58983
59054
  };
58984
59055
  header?: never;
@@ -59548,6 +59619,7 @@ export interface operations {
59548
59619
  putReservationsByReservationIdAdjustmentsById: {
59549
59620
  parameters: {
59550
59621
  query?: {
59622
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
59551
59623
  dryRun?: boolean;
59552
59624
  };
59553
59625
  header?: never;
@@ -60117,6 +60189,7 @@ export interface operations {
60117
60189
  deleteReservationsByReservationIdAdjustmentsById: {
60118
60190
  parameters: {
60119
60191
  query?: {
60192
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
60120
60193
  dryRun?: boolean;
60121
60194
  };
60122
60195
  header?: never;
@@ -61386,6 +61459,7 @@ export interface operations {
61386
61459
  postStatements: {
61387
61460
  parameters: {
61388
61461
  query?: {
61462
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
61389
61463
  dryRun?: boolean;
61390
61464
  };
61391
61465
  header?: never;
@@ -64744,6 +64818,7 @@ export interface operations {
64744
64818
  postStatementsHistorical: {
64745
64819
  parameters: {
64746
64820
  query?: {
64821
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
64747
64822
  dryRun?: boolean;
64748
64823
  };
64749
64824
  header?: never;
@@ -66761,6 +66836,7 @@ export interface operations {
66761
66836
  putStatementsLinesByLineIdDescription: {
66762
66837
  parameters: {
66763
66838
  query?: {
66839
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
66764
66840
  dryRun?: boolean;
66765
66841
  };
66766
66842
  header?: never;
@@ -66928,6 +67004,7 @@ export interface operations {
66928
67004
  postStatementsManagerPay: {
66929
67005
  parameters: {
66930
67006
  query?: {
67007
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
66931
67008
  dryRun?: boolean;
66932
67009
  };
66933
67010
  header?: never;
@@ -69314,6 +69391,7 @@ export interface operations {
69314
69391
  putStatementsById: {
69315
69392
  parameters: {
69316
69393
  query?: {
69394
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
69317
69395
  dryRun?: boolean;
69318
69396
  };
69319
69397
  header?: never;
@@ -70738,6 +70816,7 @@ export interface operations {
70738
70816
  parameters: {
70739
70817
  query?: {
70740
70818
  onLocked?: "error" | "unlockAndDelete";
70819
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
70741
70820
  dryRun?: boolean;
70742
70821
  };
70743
70822
  header?: never;
@@ -70903,6 +70982,7 @@ export interface operations {
70903
70982
  postStatementsByIdPay: {
70904
70983
  parameters: {
70905
70984
  query?: {
70985
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
70906
70986
  dryRun?: boolean;
70907
70987
  };
70908
70988
  header?: never;
@@ -73108,6 +73188,7 @@ export interface operations {
73108
73188
  createRate: {
73109
73189
  parameters: {
73110
73190
  query?: {
73191
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
73111
73192
  dryRun?: boolean;
73112
73193
  };
73113
73194
  header?: never;
@@ -73470,6 +73551,7 @@ export interface operations {
73470
73551
  updateRate: {
73471
73552
  parameters: {
73472
73553
  query?: {
73554
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
73473
73555
  dryRun?: boolean;
73474
73556
  };
73475
73557
  header?: never;
@@ -73664,6 +73746,7 @@ export interface operations {
73664
73746
  parameters: {
73665
73747
  query?: {
73666
73748
  onLocked?: "error" | "archive";
73749
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
73667
73750
  dryRun?: boolean;
73668
73751
  };
73669
73752
  header?: never;
@@ -73959,6 +74042,7 @@ export interface operations {
73959
74042
  statementStartAt?: string | null;
73960
74043
  effectiveStatementStartAt?: string | null;
73961
74044
  settings: {
74045
+ showVRPilotGuide: boolean;
73962
74046
  showReservations: boolean;
73963
74047
  showCancelledReservations: boolean;
73964
74048
  showReservationTotal: boolean;
@@ -74189,6 +74273,7 @@ export interface operations {
74189
74273
  supportEmail?: string | null;
74190
74274
  migratedFromTenantId?: string | null;
74191
74275
  settings?: {
74276
+ showVRPilotGuide?: boolean;
74192
74277
  showReservations?: boolean;
74193
74278
  showCancelledReservations?: boolean;
74194
74279
  showReservationTotal?: boolean;
@@ -74343,6 +74428,7 @@ export interface operations {
74343
74428
  statementStartAt?: string | null;
74344
74429
  effectiveStatementStartAt?: string | null;
74345
74430
  settings: {
74431
+ showVRPilotGuide: boolean;
74346
74432
  showReservations: boolean;
74347
74433
  showCancelledReservations: boolean;
74348
74434
  showReservationTotal: boolean;
@@ -75014,20 +75100,62 @@ export interface operations {
75014
75100
  content: {
75015
75101
  "application/json": {
75016
75102
  status: ("skipped" | "completed") | null;
75017
- welcome: ("skipped" | "completed") | null;
75018
- connectPms: ("skipped" | "completed") | null;
75019
- connectAiAgents: ("skipped" | "completed") | null;
75020
- connectBankAccounts: ("skipped" | "completed") | null;
75021
- connectRamp: ("skipped" | "completed") | null;
75022
- connectPaymentProcessors: ("skipped" | "completed") | null;
75023
- connectAirbnb: ("skipped" | "completed") | null;
75024
- addOwners: ("skipped" | "completed") | null;
75025
- reportingPreferences: ("skipped" | "completed") | null;
75026
- feesAndCommissions: ("skipped" | "completed") | null;
75027
- ownerStatementTemplate: ("skipped" | "completed") | null;
75028
- openingBalances: ("skipped" | "completed") | null;
75029
- addWorkflows: ("skipped" | "completed") | null;
75030
- validateAndGoLive: ("skipped" | "completed") | null;
75103
+ welcome: {
75104
+ status: ("skipped" | "completed") | null;
75105
+ updatedAt: string | null;
75106
+ };
75107
+ connectPms: {
75108
+ status: ("skipped" | "completed") | null;
75109
+ updatedAt: string | null;
75110
+ };
75111
+ connectAiAgents: {
75112
+ status: ("skipped" | "completed") | null;
75113
+ updatedAt: string | null;
75114
+ };
75115
+ connectBankAccounts: {
75116
+ status: ("skipped" | "completed") | null;
75117
+ updatedAt: string | null;
75118
+ };
75119
+ connectRamp: {
75120
+ status: ("skipped" | "completed") | null;
75121
+ updatedAt: string | null;
75122
+ };
75123
+ connectPaymentProcessors: {
75124
+ status: ("skipped" | "completed") | null;
75125
+ updatedAt: string | null;
75126
+ };
75127
+ connectAirbnb: {
75128
+ status: ("skipped" | "completed") | null;
75129
+ updatedAt: string | null;
75130
+ };
75131
+ addOwners: {
75132
+ status: ("skipped" | "completed") | null;
75133
+ updatedAt: string | null;
75134
+ };
75135
+ reportingPreferences: {
75136
+ status: ("skipped" | "completed") | null;
75137
+ updatedAt: string | null;
75138
+ };
75139
+ feesAndCommissions: {
75140
+ status: ("skipped" | "completed") | null;
75141
+ updatedAt: string | null;
75142
+ };
75143
+ ownerStatementTemplate: {
75144
+ status: ("skipped" | "completed") | null;
75145
+ updatedAt: string | null;
75146
+ };
75147
+ openingBalances: {
75148
+ status: ("skipped" | "completed") | null;
75149
+ updatedAt: string | null;
75150
+ };
75151
+ addWorkflows: {
75152
+ status: ("skipped" | "completed") | null;
75153
+ updatedAt: string | null;
75154
+ };
75155
+ validateAndGoLive: {
75156
+ status: ("skipped" | "completed") | null;
75157
+ updatedAt: string | null;
75158
+ };
75031
75159
  };
75032
75160
  };
75033
75161
  };
@@ -75176,20 +75304,20 @@ export interface operations {
75176
75304
  content: {
75177
75305
  "application/json": {
75178
75306
  status?: ("skipped" | "completed") | null;
75179
- welcome?: ("skipped" | "completed") | null;
75180
- connectPms?: ("skipped" | "completed") | null;
75307
+ addOwners?: ("skipped" | "completed") | null;
75308
+ addWorkflows?: ("skipped" | "completed") | null;
75181
75309
  connectAiAgents?: ("skipped" | "completed") | null;
75310
+ connectAirbnb?: ("skipped" | "completed") | null;
75182
75311
  connectBankAccounts?: ("skipped" | "completed") | null;
75183
- connectRamp?: ("skipped" | "completed") | null;
75184
75312
  connectPaymentProcessors?: ("skipped" | "completed") | null;
75185
- connectAirbnb?: ("skipped" | "completed") | null;
75186
- addOwners?: ("skipped" | "completed") | null;
75187
- reportingPreferences?: ("skipped" | "completed") | null;
75313
+ connectPms?: ("skipped" | "completed") | null;
75314
+ connectRamp?: ("skipped" | "completed") | null;
75188
75315
  feesAndCommissions?: ("skipped" | "completed") | null;
75189
- ownerStatementTemplate?: ("skipped" | "completed") | null;
75190
75316
  openingBalances?: ("skipped" | "completed") | null;
75191
- addWorkflows?: ("skipped" | "completed") | null;
75317
+ ownerStatementTemplate?: ("skipped" | "completed") | null;
75318
+ reportingPreferences?: ("skipped" | "completed") | null;
75192
75319
  validateAndGoLive?: ("skipped" | "completed") | null;
75320
+ welcome?: ("skipped" | "completed") | null;
75193
75321
  };
75194
75322
  };
75195
75323
  };
@@ -75202,20 +75330,62 @@ export interface operations {
75202
75330
  content: {
75203
75331
  "application/json": {
75204
75332
  status: ("skipped" | "completed") | null;
75205
- welcome: ("skipped" | "completed") | null;
75206
- connectPms: ("skipped" | "completed") | null;
75207
- connectAiAgents: ("skipped" | "completed") | null;
75208
- connectBankAccounts: ("skipped" | "completed") | null;
75209
- connectRamp: ("skipped" | "completed") | null;
75210
- connectPaymentProcessors: ("skipped" | "completed") | null;
75211
- connectAirbnb: ("skipped" | "completed") | null;
75212
- addOwners: ("skipped" | "completed") | null;
75213
- reportingPreferences: ("skipped" | "completed") | null;
75214
- feesAndCommissions: ("skipped" | "completed") | null;
75215
- ownerStatementTemplate: ("skipped" | "completed") | null;
75216
- openingBalances: ("skipped" | "completed") | null;
75217
- addWorkflows: ("skipped" | "completed") | null;
75218
- validateAndGoLive: ("skipped" | "completed") | null;
75333
+ welcome: {
75334
+ status: ("skipped" | "completed") | null;
75335
+ updatedAt: string | null;
75336
+ };
75337
+ connectPms: {
75338
+ status: ("skipped" | "completed") | null;
75339
+ updatedAt: string | null;
75340
+ };
75341
+ connectAiAgents: {
75342
+ status: ("skipped" | "completed") | null;
75343
+ updatedAt: string | null;
75344
+ };
75345
+ connectBankAccounts: {
75346
+ status: ("skipped" | "completed") | null;
75347
+ updatedAt: string | null;
75348
+ };
75349
+ connectRamp: {
75350
+ status: ("skipped" | "completed") | null;
75351
+ updatedAt: string | null;
75352
+ };
75353
+ connectPaymentProcessors: {
75354
+ status: ("skipped" | "completed") | null;
75355
+ updatedAt: string | null;
75356
+ };
75357
+ connectAirbnb: {
75358
+ status: ("skipped" | "completed") | null;
75359
+ updatedAt: string | null;
75360
+ };
75361
+ addOwners: {
75362
+ status: ("skipped" | "completed") | null;
75363
+ updatedAt: string | null;
75364
+ };
75365
+ reportingPreferences: {
75366
+ status: ("skipped" | "completed") | null;
75367
+ updatedAt: string | null;
75368
+ };
75369
+ feesAndCommissions: {
75370
+ status: ("skipped" | "completed") | null;
75371
+ updatedAt: string | null;
75372
+ };
75373
+ ownerStatementTemplate: {
75374
+ status: ("skipped" | "completed") | null;
75375
+ updatedAt: string | null;
75376
+ };
75377
+ openingBalances: {
75378
+ status: ("skipped" | "completed") | null;
75379
+ updatedAt: string | null;
75380
+ };
75381
+ addWorkflows: {
75382
+ status: ("skipped" | "completed") | null;
75383
+ updatedAt: string | null;
75384
+ };
75385
+ validateAndGoLive: {
75386
+ status: ("skipped" | "completed") | null;
75387
+ updatedAt: string | null;
75388
+ };
75219
75389
  };
75220
75390
  };
75221
75391
  };
@@ -75356,6 +75526,7 @@ export interface operations {
75356
75526
  postTeamInit: {
75357
75527
  parameters: {
75358
75528
  query?: {
75529
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
75359
75530
  dryRun?: boolean;
75360
75531
  };
75361
75532
  header?: never;
@@ -75499,6 +75670,7 @@ export interface operations {
75499
75670
  statementStartAt?: string | null;
75500
75671
  effectiveStatementStartAt?: string | null;
75501
75672
  settings: {
75673
+ showVRPilotGuide: boolean;
75502
75674
  showReservations: boolean;
75503
75675
  showCancelledReservations: boolean;
75504
75676
  showReservationTotal: boolean;
@@ -76376,6 +76548,7 @@ export interface operations {
76376
76548
  };
76377
76549
  content: {
76378
76550
  "application/json": {
76551
+ showVRPilotGuide: boolean;
76379
76552
  showReservations: boolean;
76380
76553
  showCancelledReservations: boolean;
76381
76554
  showReservationTotal: boolean;
@@ -76529,6 +76702,7 @@ export interface operations {
76529
76702
  requestBody?: {
76530
76703
  content: {
76531
76704
  "application/json": {
76705
+ showVRPilotGuide?: boolean;
76532
76706
  showReservations?: boolean;
76533
76707
  showCancelledReservations?: boolean;
76534
76708
  showReservationTotal?: boolean;
@@ -76546,6 +76720,7 @@ export interface operations {
76546
76720
  };
76547
76721
  content: {
76548
76722
  "application/json": {
76723
+ showVRPilotGuide: boolean;
76549
76724
  showReservations: boolean;
76550
76725
  showCancelledReservations: boolean;
76551
76726
  showReservationTotal: boolean;
@@ -76843,6 +77018,7 @@ export interface operations {
76843
77018
  statementStartAt?: string | null;
76844
77019
  effectiveStatementStartAt?: string | null;
76845
77020
  settings: {
77021
+ showVRPilotGuide: boolean;
76846
77022
  showReservations: boolean;
76847
77023
  showCancelledReservations: boolean;
76848
77024
  showReservationTotal: boolean;
@@ -77225,6 +77401,7 @@ export interface operations {
77225
77401
  statementStartAt?: string | null;
77226
77402
  effectiveStatementStartAt?: string | null;
77227
77403
  settings: {
77404
+ showVRPilotGuide: boolean;
77228
77405
  showReservations: boolean;
77229
77406
  showCancelledReservations: boolean;
77230
77407
  showReservationTotal: boolean;
@@ -78395,6 +78572,7 @@ export interface operations {
78395
78572
  statementStartAt?: string | null;
78396
78573
  effectiveStatementStartAt?: string | null;
78397
78574
  settings: {
78575
+ showVRPilotGuide: boolean;
78398
78576
  showReservations: boolean;
78399
78577
  showCancelledReservations: boolean;
78400
78578
  showReservationTotal: boolean;
@@ -78713,6 +78891,7 @@ export interface operations {
78713
78891
  statementStartAt?: string | null;
78714
78892
  effectiveStatementStartAt?: string | null;
78715
78893
  settings: {
78894
+ showVRPilotGuide: boolean;
78716
78895
  showReservations: boolean;
78717
78896
  showCancelledReservations: boolean;
78718
78897
  showReservationTotal: boolean;
@@ -79383,6 +79562,7 @@ export interface operations {
79383
79562
  postTransactions: {
79384
79563
  parameters: {
79385
79564
  query?: {
79565
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
79386
79566
  dryRun?: boolean;
79387
79567
  };
79388
79568
  header?: never;
@@ -80593,6 +80773,7 @@ export interface operations {
80593
80773
  postTransactionsBatch: {
80594
80774
  parameters: {
80595
80775
  query?: {
80776
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
80596
80777
  dryRun?: boolean;
80597
80778
  };
80598
80779
  header?: never;
@@ -82087,6 +82268,7 @@ export interface operations {
82087
82268
  postTransactionsRecurringTemplates: {
82088
82269
  parameters: {
82089
82270
  query?: {
82271
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
82090
82272
  dryRun?: boolean;
82091
82273
  };
82092
82274
  header?: never;
@@ -82976,6 +83158,7 @@ export interface operations {
82976
83158
  putTransactionsRecurringTemplatesById: {
82977
83159
  parameters: {
82978
83160
  query?: {
83161
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
82979
83162
  dryRun?: boolean;
82980
83163
  };
82981
83164
  header?: never;
@@ -83357,6 +83540,7 @@ export interface operations {
83357
83540
  parameters: {
83358
83541
  query?: {
83359
83542
  onLocked?: "error" | "archive" | "detach";
83543
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
83360
83544
  dryRun?: boolean;
83361
83545
  };
83362
83546
  header?: never;
@@ -83520,6 +83704,7 @@ export interface operations {
83520
83704
  postTransactionsRecurringTemplatesByIdRun: {
83521
83705
  parameters: {
83522
83706
  query?: {
83707
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
83523
83708
  dryRun?: boolean;
83524
83709
  };
83525
83710
  header?: never;
@@ -84420,6 +84605,7 @@ export interface operations {
84420
84605
  putTransactionsById: {
84421
84606
  parameters: {
84422
84607
  query?: {
84608
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
84423
84609
  dryRun?: boolean;
84424
84610
  };
84425
84611
  header?: never;
@@ -85045,6 +85231,7 @@ export interface operations {
85045
85231
  parameters: {
85046
85232
  query?: {
85047
85233
  onLocked?: "error" | "archive";
85234
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
85048
85235
  dryRun?: boolean;
85049
85236
  };
85050
85237
  header?: never;
@@ -85204,6 +85391,7 @@ export interface operations {
85204
85391
  putTransactionsByTransactionIdLinesById: {
85205
85392
  parameters: {
85206
85393
  query?: {
85394
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
85207
85395
  dryRun?: boolean;
85208
85396
  };
85209
85397
  header?: never;