@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.
@@ -1123,7 +1123,7 @@ export interface paths {
1123
1123
  };
1124
1124
  /** @description Retrieve opening balance accounts payable summary by party */
1125
1125
  get: operations["getGeneralLedgerOpeningBalancesAccountsPayable"];
1126
- /** @description Update opening balance accounts payable by party */
1126
+ /** @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. */
1127
1127
  put: operations["putGeneralLedgerOpeningBalancesAccountsPayable"];
1128
1128
  post?: never;
1129
1129
  delete?: never;
@@ -1141,7 +1141,7 @@ export interface paths {
1141
1141
  };
1142
1142
  /** @description Retrieve opening balance accounts receivable / deferred revenue summary */
1143
1143
  get: operations["getGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
1144
- /** @description Update opening balance accounts receivable / deferred revenue summary */
1144
+ /** @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. */
1145
1145
  put: operations["putGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue"];
1146
1146
  post?: never;
1147
1147
  delete?: never;
@@ -1159,7 +1159,7 @@ export interface paths {
1159
1159
  };
1160
1160
  /** @description Retrieve opening balance advanced deposits summary */
1161
1161
  get: operations["getGeneralLedgerOpeningBalancesAdvancedDeposits"];
1162
- /** @description Update opening balance advanced deposits */
1162
+ /** @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. */
1163
1163
  put: operations["putGeneralLedgerOpeningBalancesAdvancedDeposits"];
1164
1164
  post?: never;
1165
1165
  delete?: never;
@@ -1175,7 +1175,7 @@ export interface paths {
1175
1175
  path?: never;
1176
1176
  cookie?: never;
1177
1177
  };
1178
- /** @description Retrieve synced payments/refunds for review advanced deposits modal */
1178
+ /** @description Retrieve synced payments and refunds that are candidates for advanced deposit opening balances */
1179
1179
  get: operations["getGeneralLedgerOpeningBalancesAdvancedDepositsSyncedPaymentsRefunds"];
1180
1180
  put?: never;
1181
1181
  post?: never;
@@ -1194,7 +1194,7 @@ export interface paths {
1194
1194
  };
1195
1195
  /** @description Retrieve opening balance tax payable summary */
1196
1196
  get: operations["getGeneralLedgerOpeningBalancesTaxPayable"];
1197
- /** @description Update opening balance tax payable */
1197
+ /** @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. */
1198
1198
  put: operations["putGeneralLedgerOpeningBalancesTaxPayable"];
1199
1199
  post?: never;
1200
1200
  delete?: never;
@@ -1212,7 +1212,7 @@ export interface paths {
1212
1212
  };
1213
1213
  /** @description Retrieve opening trial balance */
1214
1214
  get: operations["getGeneralLedgerOpeningTrialBalance"];
1215
- /** @description Update opening trial balance */
1215
+ /** @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. */
1216
1216
  put: operations["putGeneralLedgerOpeningTrialBalance"];
1217
1217
  post?: never;
1218
1218
  delete?: never;
@@ -1716,7 +1716,7 @@ export interface paths {
1716
1716
  /** @description List listing ownership periods */
1717
1717
  get: operations["getListingsOwnershipPeriods"];
1718
1718
  put?: never;
1719
- /** @description Create a listing ownership period */
1719
+ /** @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. */
1720
1720
  post: operations["postListingsOwnershipPeriods"];
1721
1721
  delete?: never;
1722
1722
  options?: never;
@@ -1733,10 +1733,10 @@ export interface paths {
1733
1733
  };
1734
1734
  /** @description Get a listing ownership period by ID */
1735
1735
  get: operations["getListingsOwnershipPeriodsById"];
1736
- /** @description Update a listing ownership period by ID */
1736
+ /** @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. */
1737
1737
  put: operations["putListingsOwnershipPeriodsById"];
1738
1738
  post?: never;
1739
- /** @description Delete a listing ownership period by ID */
1739
+ /** @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. */
1740
1740
  delete: operations["deleteListingsOwnershipPeriodsById"];
1741
1741
  options?: never;
1742
1742
  head?: never;
@@ -3002,7 +3002,7 @@ export interface paths {
3002
3002
  /** @description Get reservations */
3003
3003
  get: operations["getReservations"];
3004
3004
  put?: never;
3005
- /** @description Create reservation */
3005
+ /** @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. */
3006
3006
  post: operations["postReservations"];
3007
3007
  delete?: never;
3008
3008
  options?: never;
@@ -3053,7 +3053,7 @@ export interface paths {
3053
3053
  };
3054
3054
  get?: never;
3055
3055
  put?: never;
3056
- /** @description Generate reservation journal entries */
3056
+ /** @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. */
3057
3057
  post: operations["postReservationsJournalEntries"];
3058
3058
  delete?: never;
3059
3059
  options?: never;
@@ -3122,10 +3122,10 @@ export interface paths {
3122
3122
  };
3123
3123
  /** @description Get reservation By ID */
3124
3124
  get: operations["getReservationsById"];
3125
- /** @description Update Reservation By ID */
3125
+ /** @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. */
3126
3126
  put: operations["putReservationsById"];
3127
3127
  post?: never;
3128
- /** @description Delete reservation By ID */
3128
+ /** @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. */
3129
3129
  delete: operations["deleteReservationsById"];
3130
3130
  options?: never;
3131
3131
  head?: never;
@@ -3140,7 +3140,7 @@ export interface paths {
3140
3140
  cookie?: never;
3141
3141
  };
3142
3142
  get?: never;
3143
- /** @description Update reservation general ledger status (active/inactive) */
3143
+ /** @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. */
3144
3144
  put: operations["putReservationsByIdStatus"];
3145
3145
  post?: never;
3146
3146
  delete?: never;
@@ -3158,7 +3158,7 @@ export interface paths {
3158
3158
  };
3159
3159
  get?: never;
3160
3160
  put?: never;
3161
- /** @description Create a reservation adjustment line */
3161
+ /** @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. */
3162
3162
  post: operations["postReservationsByReservationIdAdjustments"];
3163
3163
  delete?: never;
3164
3164
  options?: never;
@@ -3174,10 +3174,10 @@ export interface paths {
3174
3174
  cookie?: never;
3175
3175
  };
3176
3176
  get?: never;
3177
- /** @description Update a reservation adjustment line */
3177
+ /** @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. */
3178
3178
  put: operations["putReservationsByReservationIdAdjustmentsById"];
3179
3179
  post?: never;
3180
- /** @description Delete a reservation adjustment line */
3180
+ /** @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. */
3181
3181
  delete: operations["deleteReservationsByReservationIdAdjustmentsById"];
3182
3182
  options?: never;
3183
3183
  head?: never;
@@ -3211,7 +3211,7 @@ export interface paths {
3211
3211
  /** @description Get Statements List. Get Statements, either by year or dateRange + a single listing or owner or by month */
3212
3212
  get: operations["getStatements"];
3213
3213
  put?: never;
3214
- /** @description Create Statements */
3214
+ /** @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. */
3215
3215
  post: operations["postStatements"];
3216
3216
  delete?: never;
3217
3217
  options?: never;
@@ -3243,7 +3243,7 @@ export interface paths {
3243
3243
  path?: never;
3244
3244
  cookie?: never;
3245
3245
  };
3246
- /** @description Get Owner Statement CSV export (detailed) */
3246
+ /** @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. */
3247
3247
  get: operations["getStatementsByPeriodCsv"];
3248
3248
  put?: never;
3249
3249
  post?: never;
@@ -3260,7 +3260,7 @@ export interface paths {
3260
3260
  path?: never;
3261
3261
  cookie?: never;
3262
3262
  };
3263
- /** @description Get Owner Statement CSV export */
3263
+ /** @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. */
3264
3264
  get: operations["getStatementsCsv"];
3265
3265
  put?: never;
3266
3266
  post?: never;
@@ -3277,7 +3277,7 @@ export interface paths {
3277
3277
  path?: never;
3278
3278
  cookie?: never;
3279
3279
  };
3280
- /** @description Get Owner Statement CSV export (detailed) */
3280
+ /** @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. */
3281
3281
  get: operations["getStatementsDetailCsv"];
3282
3282
  put?: never;
3283
3283
  post?: never;
@@ -3401,7 +3401,7 @@ export interface paths {
3401
3401
  };
3402
3402
  get?: never;
3403
3403
  put?: never;
3404
- /** @description Pay a property manager out */
3404
+ /** @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. */
3405
3405
  post: operations["postStatementsManagerPay"];
3406
3406
  delete?: never;
3407
3407
  options?: never;
@@ -3416,7 +3416,7 @@ export interface paths {
3416
3416
  path?: never;
3417
3417
  cookie?: never;
3418
3418
  };
3419
- /** @description Get Owner Statement by ID */
3419
+ /** @description Get owner statement PDF by ownership period and month */
3420
3420
  get: operations["getStatementsPdf"];
3421
3421
  put?: never;
3422
3422
  post?: never;
@@ -3433,7 +3433,7 @@ export interface paths {
3433
3433
  path?: never;
3434
3434
  cookie?: never;
3435
3435
  };
3436
- /** @description Get Owner Statements ZIP by month or listing month range */
3436
+ /** @description Get owner statements PDF ZIP by month or listing month range */
3437
3437
  get: operations["getStatementsPdfBatch"];
3438
3438
  put?: never;
3439
3439
  post?: never;
@@ -3469,10 +3469,10 @@ export interface paths {
3469
3469
  };
3470
3470
  /** @description Get Statements by period. Get Statements by ownership period, can be multiple if multiple currencies are found in a month */
3471
3471
  get: operations["getStatementsById"];
3472
- /** @description Update Statements by Id */
3472
+ /** @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. */
3473
3473
  put: operations["putStatementsById"];
3474
3474
  post?: never;
3475
- /** @description Update Statements by Id */
3475
+ /** @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. */
3476
3476
  delete: operations["deleteStatementsById"];
3477
3477
  options?: never;
3478
3478
  head?: never;
@@ -3488,7 +3488,7 @@ export interface paths {
3488
3488
  };
3489
3489
  get?: never;
3490
3490
  put?: never;
3491
- /** @description Pay a statement */
3491
+ /** @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. */
3492
3492
  post: operations["postStatementsByIdPay"];
3493
3493
  delete?: never;
3494
3494
  options?: never;
@@ -3698,7 +3698,7 @@ export interface paths {
3698
3698
  cookie?: never;
3699
3699
  };
3700
3700
  get?: never;
3701
- /** @description Update the books closing date of the current team (the team in scope via the x-team-id header) */
3701
+ /** @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. */
3702
3702
  put: operations["putTeamBooksClosing"];
3703
3703
  post?: never;
3704
3704
  delete?: never;
@@ -3731,9 +3731,9 @@ export interface paths {
3731
3731
  path?: never;
3732
3732
  cookie?: never;
3733
3733
  };
3734
- /** @description Get the current team VRPilot Onboarding Guide state */
3734
+ /** @description Get the current team's onboarding guide state */
3735
3735
  get: operations["getTeamGuidesOnboarding"];
3736
- /** @description Update the current team VRPilot Onboarding Guide state */
3736
+ /** @description Update the current team's onboarding guide state */
3737
3737
  put: operations["putTeamGuidesOnboarding"];
3738
3738
  post?: never;
3739
3739
  delete?: never;
@@ -3908,7 +3908,7 @@ export interface paths {
3908
3908
  /** @description Transactions List */
3909
3909
  get: operations["getTransactions"];
3910
3910
  put?: never;
3911
- /** @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. */
3911
+ /** @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. */
3912
3912
  post: operations["postTransactions"];
3913
3913
  delete?: never;
3914
3914
  options?: never;
@@ -4028,7 +4028,7 @@ export interface paths {
4028
4028
  };
4029
4029
  get?: never;
4030
4030
  put?: never;
4031
- /** @description Regenerate transaction journal entries. Generic dry run is unavailable because this operation needs a dedicated consequence preview for projected posting changes. */
4031
+ /** @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. */
4032
4032
  post: operations["postTransactionsJournalEntries"];
4033
4033
  delete?: never;
4034
4034
  options?: never;
@@ -4150,7 +4150,7 @@ export interface paths {
4150
4150
  };
4151
4151
  /** @description Transactions List */
4152
4152
  get: operations["getTransactionsById"];
4153
- /** @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. */
4153
+ /** @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. */
4154
4154
  put: operations["putTransactionsById"];
4155
4155
  post?: never;
4156
4156
  /** @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. */
@@ -4168,7 +4168,7 @@ export interface paths {
4168
4168
  cookie?: never;
4169
4169
  };
4170
4170
  get?: never;
4171
- /** @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. */
4171
+ /** @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. */
4172
4172
  put: operations["putTransactionsByTransactionIdLinesById"];
4173
4173
  post?: never;
4174
4174
  delete?: never;
@@ -4592,6 +4592,7 @@ export interface operations {
4592
4592
  postAccounts: {
4593
4593
  parameters: {
4594
4594
  query?: {
4595
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
4595
4596
  dryRun?: boolean;
4596
4597
  };
4597
4598
  header?: never;
@@ -5448,6 +5449,7 @@ export interface operations {
5448
5449
  putAccountsById: {
5449
5450
  parameters: {
5450
5451
  query?: {
5452
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
5451
5453
  dryRun?: boolean;
5452
5454
  };
5453
5455
  header?: never;
@@ -5729,6 +5731,7 @@ export interface operations {
5729
5731
  parameters: {
5730
5732
  query?: {
5731
5733
  onLocked?: "error" | "archive";
5734
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
5732
5735
  dryRun?: boolean;
5733
5736
  };
5734
5737
  header?: never;
@@ -5892,6 +5895,7 @@ export interface operations {
5892
5895
  postAccountsByIdBankingInit: {
5893
5896
  parameters: {
5894
5897
  query?: {
5898
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
5895
5899
  dryRun?: boolean;
5896
5900
  };
5897
5901
  header?: never;
@@ -9418,6 +9422,7 @@ export interface operations {
9418
9422
  batchBankAccounts: {
9419
9423
  parameters: {
9420
9424
  query?: {
9425
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
9421
9426
  dryRun?: boolean;
9422
9427
  };
9423
9428
  header?: never;
@@ -9791,6 +9796,7 @@ export interface operations {
9791
9796
  updateBankAccount: {
9792
9797
  parameters: {
9793
9798
  query?: {
9799
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
9794
9800
  dryRun?: boolean;
9795
9801
  };
9796
9802
  header?: never;
@@ -10367,6 +10373,7 @@ export interface operations {
10367
10373
  postBankRecordsBatch: {
10368
10374
  parameters: {
10369
10375
  query?: {
10376
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
10370
10377
  dryRun?: boolean;
10371
10378
  };
10372
10379
  header?: never;
@@ -11090,6 +11097,7 @@ export interface operations {
11090
11097
  putBankRecordsById: {
11091
11098
  parameters: {
11092
11099
  query?: {
11100
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
11093
11101
  dryRun?: boolean;
11094
11102
  };
11095
11103
  header?: never;
@@ -11259,6 +11267,7 @@ export interface operations {
11259
11267
  deleteBankRecordsById: {
11260
11268
  parameters: {
11261
11269
  query?: {
11270
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
11262
11271
  dryRun?: boolean;
11263
11272
  };
11264
11273
  header?: never;
@@ -13022,6 +13031,7 @@ export interface operations {
13022
13031
  postBankRulesByIdRun: {
13023
13032
  parameters: {
13024
13033
  query?: {
13034
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
13025
13035
  dryRun?: boolean;
13026
13036
  };
13027
13037
  header?: never;
@@ -17086,6 +17096,7 @@ export interface operations {
17086
17096
  postContacts: {
17087
17097
  parameters: {
17088
17098
  query?: {
17099
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
17089
17100
  dryRun?: boolean;
17090
17101
  };
17091
17102
  header?: never;
@@ -17332,6 +17343,7 @@ export interface operations {
17332
17343
  postContactsBatch: {
17333
17344
  parameters: {
17334
17345
  query?: {
17346
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
17335
17347
  dryRun?: boolean;
17336
17348
  };
17337
17349
  header?: never;
@@ -17917,6 +17929,7 @@ export interface operations {
17917
17929
  putContactsById: {
17918
17930
  parameters: {
17919
17931
  query?: {
17932
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
17920
17933
  dryRun?: boolean;
17921
17934
  };
17922
17935
  header?: never;
@@ -18165,6 +18178,7 @@ export interface operations {
18165
18178
  parameters: {
18166
18179
  query?: {
18167
18180
  onLocked?: "error" | "archive";
18181
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
18168
18182
  dryRun?: boolean;
18169
18183
  };
18170
18184
  header?: never;
@@ -22657,6 +22671,7 @@ export interface operations {
22657
22671
  postGeneralLedgerHistorical: {
22658
22672
  parameters: {
22659
22673
  query?: {
22674
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
22660
22675
  dryRun?: boolean;
22661
22676
  };
22662
22677
  header?: never;
@@ -23002,6 +23017,7 @@ export interface operations {
23002
23017
  putGeneralLedgerOpeningBalancesAccountsPayable: {
23003
23018
  parameters: {
23004
23019
  query?: {
23020
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
23005
23021
  dryRun?: boolean;
23006
23022
  };
23007
23023
  header?: never;
@@ -23336,6 +23352,7 @@ export interface operations {
23336
23352
  putGeneralLedgerOpeningBalancesAccountsReceivableDeferredRevenue: {
23337
23353
  parameters: {
23338
23354
  query?: {
23355
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
23339
23356
  dryRun?: boolean;
23340
23357
  };
23341
23358
  header?: never;
@@ -23681,6 +23698,7 @@ export interface operations {
23681
23698
  putGeneralLedgerOpeningBalancesAdvancedDeposits: {
23682
23699
  parameters: {
23683
23700
  query?: {
23701
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
23684
23702
  dryRun?: boolean;
23685
23703
  };
23686
23704
  header?: never;
@@ -24213,6 +24231,7 @@ export interface operations {
24213
24231
  putGeneralLedgerOpeningBalancesTaxPayable: {
24214
24232
  parameters: {
24215
24233
  query?: {
24234
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
24216
24235
  dryRun?: boolean;
24217
24236
  };
24218
24237
  header?: never;
@@ -24580,6 +24599,7 @@ export interface operations {
24580
24599
  putGeneralLedgerOpeningTrialBalance: {
24581
24600
  parameters: {
24582
24601
  query?: {
24602
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
24583
24603
  dryRun?: boolean;
24584
24604
  };
24585
24605
  header?: never;
@@ -28143,6 +28163,7 @@ export interface operations {
28143
28163
  statementStartAt?: string | null;
28144
28164
  effectiveStatementStartAt?: string | null;
28145
28165
  settings: {
28166
+ showVRPilotGuide: boolean;
28146
28167
  showReservations: boolean;
28147
28168
  showCancelledReservations: boolean;
28148
28169
  showReservationTotal: boolean;
@@ -28467,6 +28488,7 @@ export interface operations {
28467
28488
  statementStartAt?: string | null;
28468
28489
  effectiveStatementStartAt?: string | null;
28469
28490
  settings: {
28491
+ showVRPilotGuide: boolean;
28470
28492
  showReservations: boolean;
28471
28493
  showCancelledReservations: boolean;
28472
28494
  showReservationTotal: boolean;
@@ -30802,6 +30824,8 @@ export interface operations {
30802
30824
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
30803
30825
  rateType?: ("flat" | "percentage") | null;
30804
30826
  defaultRate?: number | null;
30827
+ /** @enum {string} */
30828
+ status: "active" | "inactive";
30805
30829
  };
30806
30830
  }[] | null;
30807
30831
  source?: {
@@ -31005,6 +31029,7 @@ export interface operations {
31005
31029
  postListings: {
31006
31030
  parameters: {
31007
31031
  query?: {
31032
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
31008
31033
  dryRun?: boolean;
31009
31034
  };
31010
31035
  header?: never;
@@ -31043,6 +31068,8 @@ export interface operations {
31043
31068
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
31044
31069
  rateType?: ("flat" | "percentage") | null;
31045
31070
  defaultRate?: number | null;
31071
+ /** @enum {string} */
31072
+ status: "active" | "inactive";
31046
31073
  };
31047
31074
  }[] | null;
31048
31075
  initialOwnership?: {
@@ -31162,6 +31189,8 @@ export interface operations {
31162
31189
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
31163
31190
  rateType?: ("flat" | "percentage") | null;
31164
31191
  defaultRate?: number | null;
31192
+ /** @enum {string} */
31193
+ status: "active" | "inactive";
31165
31194
  };
31166
31195
  }[] | null;
31167
31196
  source?: {
@@ -31355,6 +31384,7 @@ export interface operations {
31355
31384
  postListingsBatch: {
31356
31385
  parameters: {
31357
31386
  query?: {
31387
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
31358
31388
  dryRun?: boolean;
31359
31389
  };
31360
31390
  header?: never;
@@ -32311,6 +32341,7 @@ export interface operations {
32311
32341
  postListingsOwnershipPeriods: {
32312
32342
  parameters: {
32313
32343
  query?: {
32344
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
32314
32345
  dryRun?: boolean;
32315
32346
  };
32316
32347
  header?: never;
@@ -32690,6 +32721,7 @@ export interface operations {
32690
32721
  putListingsOwnershipPeriodsById: {
32691
32722
  parameters: {
32692
32723
  query?: {
32724
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
32693
32725
  dryRun?: boolean;
32694
32726
  };
32695
32727
  header?: never;
@@ -32892,6 +32924,7 @@ export interface operations {
32892
32924
  query?: {
32893
32925
  onLocked?: "error" | "archive";
32894
32926
  onLast?: "extendPrevious" | "none";
32927
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
32895
32928
  dryRun?: boolean;
32896
32929
  };
32897
32930
  header?: never;
@@ -33167,6 +33200,8 @@ export interface operations {
33167
33200
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
33168
33201
  rateType?: ("flat" | "percentage") | null;
33169
33202
  defaultRate?: number | null;
33203
+ /** @enum {string} */
33204
+ status: "active" | "inactive";
33170
33205
  };
33171
33206
  }[] | null;
33172
33207
  source?: {
@@ -33360,6 +33395,7 @@ export interface operations {
33360
33395
  putListingsById: {
33361
33396
  parameters: {
33362
33397
  query?: {
33398
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
33363
33399
  dryRun?: boolean;
33364
33400
  };
33365
33401
  header?: never;
@@ -33400,6 +33436,8 @@ export interface operations {
33400
33436
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
33401
33437
  rateType?: ("flat" | "percentage") | null;
33402
33438
  defaultRate?: number | null;
33439
+ /** @enum {string} */
33440
+ status: "active" | "inactive";
33403
33441
  };
33404
33442
  }[] | null;
33405
33443
  initialOwnership?: {
@@ -33519,6 +33557,8 @@ export interface operations {
33519
33557
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
33520
33558
  rateType?: ("flat" | "percentage") | null;
33521
33559
  defaultRate?: number | null;
33560
+ /** @enum {string} */
33561
+ status: "active" | "inactive";
33522
33562
  };
33523
33563
  }[] | null;
33524
33564
  source?: {
@@ -33713,6 +33753,7 @@ export interface operations {
33713
33753
  parameters: {
33714
33754
  query?: {
33715
33755
  onLocked?: "error" | "archive";
33756
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
33716
33757
  dryRun?: boolean;
33717
33758
  };
33718
33759
  header?: never;
@@ -34038,6 +34079,7 @@ export interface operations {
34038
34079
  putListingsByIdOpeningBalance: {
34039
34080
  parameters: {
34040
34081
  query?: {
34082
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
34041
34083
  dryRun?: boolean;
34042
34084
  };
34043
34085
  header?: never;
@@ -34210,6 +34252,7 @@ export interface operations {
34210
34252
  putListingsByIdParent: {
34211
34253
  parameters: {
34212
34254
  query?: {
34255
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
34213
34256
  dryRun?: boolean;
34214
34257
  };
34215
34258
  header?: never;
@@ -34328,6 +34371,8 @@ export interface operations {
34328
34371
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
34329
34372
  rateType?: ("flat" | "percentage") | null;
34330
34373
  defaultRate?: number | null;
34374
+ /** @enum {string} */
34375
+ status: "active" | "inactive";
34331
34376
  };
34332
34377
  }[] | null;
34333
34378
  source?: {
@@ -34521,6 +34566,7 @@ export interface operations {
34521
34566
  deleteListingsByIdParent: {
34522
34567
  parameters: {
34523
34568
  query?: {
34569
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
34524
34570
  dryRun?: boolean;
34525
34571
  };
34526
34572
  header?: never;
@@ -34636,6 +34682,8 @@ export interface operations {
34636
34682
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
34637
34683
  rateType?: ("flat" | "percentage") | null;
34638
34684
  defaultRate?: number | null;
34685
+ /** @enum {string} */
34686
+ status: "active" | "inactive";
34639
34687
  };
34640
34688
  }[] | null;
34641
34689
  source?: {
@@ -34892,6 +34940,7 @@ export interface operations {
34892
34940
  colorPrimary: string | null;
34893
34941
  logo: string | null;
34894
34942
  settings: {
34943
+ showVRPilotGuide: boolean;
34895
34944
  showReservations: boolean;
34896
34945
  showCancelledReservations: boolean;
34897
34946
  showReservationTotal: boolean;
@@ -40678,7 +40727,8 @@ export interface operations {
40678
40727
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
40679
40728
  taxBehavior?: ("excluded" | "included") | null;
40680
40729
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
40681
- status?: ("active" | "inactive") | null;
40730
+ /** @enum {string} */
40731
+ status: "active" | "inactive";
40682
40732
  rateType?: ("flat" | "percentage") | null;
40683
40733
  /** @enum {string} */
40684
40734
  creditParty: "manager" | "owners";
@@ -40917,6 +40967,7 @@ export interface operations {
40917
40967
  postRecurringFees: {
40918
40968
  parameters: {
40919
40969
  query?: {
40970
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
40920
40971
  dryRun?: boolean;
40921
40972
  };
40922
40973
  header?: never;
@@ -40975,7 +41026,8 @@ export interface operations {
40975
41026
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
40976
41027
  taxBehavior?: ("excluded" | "included") | null;
40977
41028
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
40978
- status?: ("active" | "inactive") | null;
41029
+ /** @enum {string} */
41030
+ status: "active" | "inactive";
40979
41031
  rateType?: ("flat" | "percentage") | null;
40980
41032
  /** @enum {string} */
40981
41033
  creditParty: "manager" | "owners";
@@ -41243,6 +41295,8 @@ export interface operations {
41243
41295
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
41244
41296
  rateType?: ("flat" | "percentage") | null;
41245
41297
  defaultRate?: number | null;
41298
+ /** @enum {string} */
41299
+ status: "active" | "inactive";
41246
41300
  };
41247
41301
  }[];
41248
41302
  pagination: {
@@ -41394,6 +41448,7 @@ export interface operations {
41394
41448
  postRecurringFeesListingPeriods: {
41395
41449
  parameters: {
41396
41450
  query?: {
41451
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
41397
41452
  dryRun?: boolean;
41398
41453
  };
41399
41454
  header?: never;
@@ -41436,6 +41491,8 @@ export interface operations {
41436
41491
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
41437
41492
  rateType?: ("flat" | "percentage") | null;
41438
41493
  defaultRate?: number | null;
41494
+ /** @enum {string} */
41495
+ status: "active" | "inactive";
41439
41496
  };
41440
41497
  };
41441
41498
  };
@@ -41577,6 +41634,7 @@ export interface operations {
41577
41634
  putRecurringFeesListingPeriodsById: {
41578
41635
  parameters: {
41579
41636
  query?: {
41637
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
41580
41638
  dryRun?: boolean;
41581
41639
  };
41582
41640
  header?: never;
@@ -41619,6 +41677,8 @@ export interface operations {
41619
41677
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
41620
41678
  rateType?: ("flat" | "percentage") | null;
41621
41679
  defaultRate?: number | null;
41680
+ /** @enum {string} */
41681
+ status: "active" | "inactive";
41622
41682
  };
41623
41683
  };
41624
41684
  };
@@ -41761,6 +41821,7 @@ export interface operations {
41761
41821
  parameters: {
41762
41822
  query?: {
41763
41823
  onLocked?: "error" | "archive";
41824
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
41764
41825
  dryRun?: boolean;
41765
41826
  };
41766
41827
  header?: never;
@@ -42266,7 +42327,8 @@ export interface operations {
42266
42327
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
42267
42328
  taxBehavior?: ("excluded" | "included") | null;
42268
42329
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
42269
- status?: ("active" | "inactive") | null;
42330
+ /** @enum {string} */
42331
+ status: "active" | "inactive";
42270
42332
  rateType?: ("flat" | "percentage") | null;
42271
42333
  /** @enum {string} */
42272
42334
  creditParty: "manager" | "owners";
@@ -42495,6 +42557,7 @@ export interface operations {
42495
42557
  putRecurringFeesById: {
42496
42558
  parameters: {
42497
42559
  query?: {
42560
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
42498
42561
  dryRun?: boolean;
42499
42562
  };
42500
42563
  header?: never;
@@ -42555,7 +42618,8 @@ export interface operations {
42555
42618
  type: "managementFee" | "additionalFee" | "bookingChannelFee" | "cleaningFee" | "merchantFee";
42556
42619
  taxBehavior?: ("excluded" | "included") | null;
42557
42620
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
42558
- status?: ("active" | "inactive") | null;
42621
+ /** @enum {string} */
42622
+ status: "active" | "inactive";
42559
42623
  rateType?: ("flat" | "percentage") | null;
42560
42624
  /** @enum {string} */
42561
42625
  creditParty: "manager" | "owners";
@@ -42785,6 +42849,7 @@ export interface operations {
42785
42849
  parameters: {
42786
42850
  query?: {
42787
42851
  onLocked?: "error" | "archive";
42852
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
42788
42853
  dryRun?: boolean;
42789
42854
  };
42790
42855
  header?: never;
@@ -55490,6 +55555,7 @@ export interface operations {
55490
55555
  postReservations: {
55491
55556
  parameters: {
55492
55557
  query?: {
55558
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
55493
55559
  dryRun?: boolean;
55494
55560
  };
55495
55561
  header?: never;
@@ -56098,6 +56164,7 @@ export interface operations {
56098
56164
  * @description Deprecated: use allowReferenceChange
56099
56165
  */
56100
56166
  noReferenceChange?: boolean;
56167
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
56101
56168
  dryRun?: boolean;
56102
56169
  };
56103
56170
  header?: never;
@@ -57969,6 +58036,7 @@ export interface operations {
57969
58036
  putReservationsById: {
57970
58037
  parameters: {
57971
58038
  query?: {
58039
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
57972
58040
  dryRun?: boolean;
57973
58041
  };
57974
58042
  header?: never;
@@ -58647,6 +58715,7 @@ export interface operations {
58647
58715
  parameters: {
58648
58716
  query?: {
58649
58717
  onLocked?: "error" | "archive";
58718
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
58650
58719
  dryRun?: boolean;
58651
58720
  };
58652
58721
  header?: never;
@@ -58810,6 +58879,7 @@ export interface operations {
58810
58879
  putReservationsByIdStatus: {
58811
58880
  parameters: {
58812
58881
  query?: {
58882
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
58813
58883
  dryRun?: boolean;
58814
58884
  };
58815
58885
  header?: never;
@@ -58978,6 +59048,7 @@ export interface operations {
58978
59048
  postReservationsByReservationIdAdjustments: {
58979
59049
  parameters: {
58980
59050
  query?: {
59051
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
58981
59052
  dryRun?: boolean;
58982
59053
  };
58983
59054
  header?: never;
@@ -59547,6 +59618,7 @@ export interface operations {
59547
59618
  putReservationsByReservationIdAdjustmentsById: {
59548
59619
  parameters: {
59549
59620
  query?: {
59621
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
59550
59622
  dryRun?: boolean;
59551
59623
  };
59552
59624
  header?: never;
@@ -60116,6 +60188,7 @@ export interface operations {
60116
60188
  deleteReservationsByReservationIdAdjustmentsById: {
60117
60189
  parameters: {
60118
60190
  query?: {
60191
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
60119
60192
  dryRun?: boolean;
60120
60193
  };
60121
60194
  header?: never;
@@ -61385,6 +61458,7 @@ export interface operations {
61385
61458
  postStatements: {
61386
61459
  parameters: {
61387
61460
  query?: {
61461
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
61388
61462
  dryRun?: boolean;
61389
61463
  };
61390
61464
  header?: never;
@@ -64743,6 +64817,7 @@ export interface operations {
64743
64817
  postStatementsHistorical: {
64744
64818
  parameters: {
64745
64819
  query?: {
64820
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
64746
64821
  dryRun?: boolean;
64747
64822
  };
64748
64823
  header?: never;
@@ -66760,6 +66835,7 @@ export interface operations {
66760
66835
  putStatementsLinesByLineIdDescription: {
66761
66836
  parameters: {
66762
66837
  query?: {
66838
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
66763
66839
  dryRun?: boolean;
66764
66840
  };
66765
66841
  header?: never;
@@ -66927,6 +67003,7 @@ export interface operations {
66927
67003
  postStatementsManagerPay: {
66928
67004
  parameters: {
66929
67005
  query?: {
67006
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
66930
67007
  dryRun?: boolean;
66931
67008
  };
66932
67009
  header?: never;
@@ -69313,6 +69390,7 @@ export interface operations {
69313
69390
  putStatementsById: {
69314
69391
  parameters: {
69315
69392
  query?: {
69393
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
69316
69394
  dryRun?: boolean;
69317
69395
  };
69318
69396
  header?: never;
@@ -70737,6 +70815,7 @@ export interface operations {
70737
70815
  parameters: {
70738
70816
  query?: {
70739
70817
  onLocked?: "error" | "unlockAndDelete";
70818
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
70740
70819
  dryRun?: boolean;
70741
70820
  };
70742
70821
  header?: never;
@@ -70902,6 +70981,7 @@ export interface operations {
70902
70981
  postStatementsByIdPay: {
70903
70982
  parameters: {
70904
70983
  query?: {
70984
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
70905
70985
  dryRun?: boolean;
70906
70986
  };
70907
70987
  header?: never;
@@ -73107,6 +73187,7 @@ export interface operations {
73107
73187
  createRate: {
73108
73188
  parameters: {
73109
73189
  query?: {
73190
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
73110
73191
  dryRun?: boolean;
73111
73192
  };
73112
73193
  header?: never;
@@ -73469,6 +73550,7 @@ export interface operations {
73469
73550
  updateRate: {
73470
73551
  parameters: {
73471
73552
  query?: {
73553
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
73472
73554
  dryRun?: boolean;
73473
73555
  };
73474
73556
  header?: never;
@@ -73663,6 +73745,7 @@ export interface operations {
73663
73745
  parameters: {
73664
73746
  query?: {
73665
73747
  onLocked?: "error" | "archive";
73748
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
73666
73749
  dryRun?: boolean;
73667
73750
  };
73668
73751
  header?: never;
@@ -73958,6 +74041,7 @@ export interface operations {
73958
74041
  statementStartAt?: string | null;
73959
74042
  effectiveStatementStartAt?: string | null;
73960
74043
  settings: {
74044
+ showVRPilotGuide: boolean;
73961
74045
  showReservations: boolean;
73962
74046
  showCancelledReservations: boolean;
73963
74047
  showReservationTotal: boolean;
@@ -74188,6 +74272,7 @@ export interface operations {
74188
74272
  supportEmail?: string | null;
74189
74273
  migratedFromTenantId?: string | null;
74190
74274
  settings?: {
74275
+ showVRPilotGuide?: boolean;
74191
74276
  showReservations?: boolean;
74192
74277
  showCancelledReservations?: boolean;
74193
74278
  showReservationTotal?: boolean;
@@ -74342,6 +74427,7 @@ export interface operations {
74342
74427
  statementStartAt?: string | null;
74343
74428
  effectiveStatementStartAt?: string | null;
74344
74429
  settings: {
74430
+ showVRPilotGuide: boolean;
74345
74431
  showReservations: boolean;
74346
74432
  showCancelledReservations: boolean;
74347
74433
  showReservationTotal: boolean;
@@ -75013,20 +75099,62 @@ export interface operations {
75013
75099
  content: {
75014
75100
  "application/json": {
75015
75101
  status: ("skipped" | "completed") | null;
75016
- welcome: ("skipped" | "completed") | null;
75017
- connectPms: ("skipped" | "completed") | null;
75018
- connectAiAgents: ("skipped" | "completed") | null;
75019
- connectBankAccounts: ("skipped" | "completed") | null;
75020
- connectRamp: ("skipped" | "completed") | null;
75021
- connectPaymentProcessors: ("skipped" | "completed") | null;
75022
- connectAirbnb: ("skipped" | "completed") | null;
75023
- addOwners: ("skipped" | "completed") | null;
75024
- reportingPreferences: ("skipped" | "completed") | null;
75025
- feesAndCommissions: ("skipped" | "completed") | null;
75026
- ownerStatementTemplate: ("skipped" | "completed") | null;
75027
- openingBalances: ("skipped" | "completed") | null;
75028
- addWorkflows: ("skipped" | "completed") | null;
75029
- validateAndGoLive: ("skipped" | "completed") | null;
75102
+ welcome: {
75103
+ status: ("skipped" | "completed") | null;
75104
+ updatedAt: string | null;
75105
+ };
75106
+ connectPms: {
75107
+ status: ("skipped" | "completed") | null;
75108
+ updatedAt: string | null;
75109
+ };
75110
+ connectAiAgents: {
75111
+ status: ("skipped" | "completed") | null;
75112
+ updatedAt: string | null;
75113
+ };
75114
+ connectBankAccounts: {
75115
+ status: ("skipped" | "completed") | null;
75116
+ updatedAt: string | null;
75117
+ };
75118
+ connectRamp: {
75119
+ status: ("skipped" | "completed") | null;
75120
+ updatedAt: string | null;
75121
+ };
75122
+ connectPaymentProcessors: {
75123
+ status: ("skipped" | "completed") | null;
75124
+ updatedAt: string | null;
75125
+ };
75126
+ connectAirbnb: {
75127
+ status: ("skipped" | "completed") | null;
75128
+ updatedAt: string | null;
75129
+ };
75130
+ addOwners: {
75131
+ status: ("skipped" | "completed") | null;
75132
+ updatedAt: string | null;
75133
+ };
75134
+ reportingPreferences: {
75135
+ status: ("skipped" | "completed") | null;
75136
+ updatedAt: string | null;
75137
+ };
75138
+ feesAndCommissions: {
75139
+ status: ("skipped" | "completed") | null;
75140
+ updatedAt: string | null;
75141
+ };
75142
+ ownerStatementTemplate: {
75143
+ status: ("skipped" | "completed") | null;
75144
+ updatedAt: string | null;
75145
+ };
75146
+ openingBalances: {
75147
+ status: ("skipped" | "completed") | null;
75148
+ updatedAt: string | null;
75149
+ };
75150
+ addWorkflows: {
75151
+ status: ("skipped" | "completed") | null;
75152
+ updatedAt: string | null;
75153
+ };
75154
+ validateAndGoLive: {
75155
+ status: ("skipped" | "completed") | null;
75156
+ updatedAt: string | null;
75157
+ };
75030
75158
  };
75031
75159
  };
75032
75160
  };
@@ -75175,20 +75303,20 @@ export interface operations {
75175
75303
  content: {
75176
75304
  "application/json": {
75177
75305
  status?: ("skipped" | "completed") | null;
75178
- welcome?: ("skipped" | "completed") | null;
75179
- connectPms?: ("skipped" | "completed") | null;
75306
+ addOwners?: ("skipped" | "completed") | null;
75307
+ addWorkflows?: ("skipped" | "completed") | null;
75180
75308
  connectAiAgents?: ("skipped" | "completed") | null;
75309
+ connectAirbnb?: ("skipped" | "completed") | null;
75181
75310
  connectBankAccounts?: ("skipped" | "completed") | null;
75182
- connectRamp?: ("skipped" | "completed") | null;
75183
75311
  connectPaymentProcessors?: ("skipped" | "completed") | null;
75184
- connectAirbnb?: ("skipped" | "completed") | null;
75185
- addOwners?: ("skipped" | "completed") | null;
75186
- reportingPreferences?: ("skipped" | "completed") | null;
75312
+ connectPms?: ("skipped" | "completed") | null;
75313
+ connectRamp?: ("skipped" | "completed") | null;
75187
75314
  feesAndCommissions?: ("skipped" | "completed") | null;
75188
- ownerStatementTemplate?: ("skipped" | "completed") | null;
75189
75315
  openingBalances?: ("skipped" | "completed") | null;
75190
- addWorkflows?: ("skipped" | "completed") | null;
75316
+ ownerStatementTemplate?: ("skipped" | "completed") | null;
75317
+ reportingPreferences?: ("skipped" | "completed") | null;
75191
75318
  validateAndGoLive?: ("skipped" | "completed") | null;
75319
+ welcome?: ("skipped" | "completed") | null;
75192
75320
  };
75193
75321
  };
75194
75322
  };
@@ -75201,20 +75329,62 @@ export interface operations {
75201
75329
  content: {
75202
75330
  "application/json": {
75203
75331
  status: ("skipped" | "completed") | null;
75204
- welcome: ("skipped" | "completed") | null;
75205
- connectPms: ("skipped" | "completed") | null;
75206
- connectAiAgents: ("skipped" | "completed") | null;
75207
- connectBankAccounts: ("skipped" | "completed") | null;
75208
- connectRamp: ("skipped" | "completed") | null;
75209
- connectPaymentProcessors: ("skipped" | "completed") | null;
75210
- connectAirbnb: ("skipped" | "completed") | null;
75211
- addOwners: ("skipped" | "completed") | null;
75212
- reportingPreferences: ("skipped" | "completed") | null;
75213
- feesAndCommissions: ("skipped" | "completed") | null;
75214
- ownerStatementTemplate: ("skipped" | "completed") | null;
75215
- openingBalances: ("skipped" | "completed") | null;
75216
- addWorkflows: ("skipped" | "completed") | null;
75217
- validateAndGoLive: ("skipped" | "completed") | null;
75332
+ welcome: {
75333
+ status: ("skipped" | "completed") | null;
75334
+ updatedAt: string | null;
75335
+ };
75336
+ connectPms: {
75337
+ status: ("skipped" | "completed") | null;
75338
+ updatedAt: string | null;
75339
+ };
75340
+ connectAiAgents: {
75341
+ status: ("skipped" | "completed") | null;
75342
+ updatedAt: string | null;
75343
+ };
75344
+ connectBankAccounts: {
75345
+ status: ("skipped" | "completed") | null;
75346
+ updatedAt: string | null;
75347
+ };
75348
+ connectRamp: {
75349
+ status: ("skipped" | "completed") | null;
75350
+ updatedAt: string | null;
75351
+ };
75352
+ connectPaymentProcessors: {
75353
+ status: ("skipped" | "completed") | null;
75354
+ updatedAt: string | null;
75355
+ };
75356
+ connectAirbnb: {
75357
+ status: ("skipped" | "completed") | null;
75358
+ updatedAt: string | null;
75359
+ };
75360
+ addOwners: {
75361
+ status: ("skipped" | "completed") | null;
75362
+ updatedAt: string | null;
75363
+ };
75364
+ reportingPreferences: {
75365
+ status: ("skipped" | "completed") | null;
75366
+ updatedAt: string | null;
75367
+ };
75368
+ feesAndCommissions: {
75369
+ status: ("skipped" | "completed") | null;
75370
+ updatedAt: string | null;
75371
+ };
75372
+ ownerStatementTemplate: {
75373
+ status: ("skipped" | "completed") | null;
75374
+ updatedAt: string | null;
75375
+ };
75376
+ openingBalances: {
75377
+ status: ("skipped" | "completed") | null;
75378
+ updatedAt: string | null;
75379
+ };
75380
+ addWorkflows: {
75381
+ status: ("skipped" | "completed") | null;
75382
+ updatedAt: string | null;
75383
+ };
75384
+ validateAndGoLive: {
75385
+ status: ("skipped" | "completed") | null;
75386
+ updatedAt: string | null;
75387
+ };
75218
75388
  };
75219
75389
  };
75220
75390
  };
@@ -75355,6 +75525,7 @@ export interface operations {
75355
75525
  postTeamInit: {
75356
75526
  parameters: {
75357
75527
  query?: {
75528
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
75358
75529
  dryRun?: boolean;
75359
75530
  };
75360
75531
  header?: never;
@@ -75498,6 +75669,7 @@ export interface operations {
75498
75669
  statementStartAt?: string | null;
75499
75670
  effectiveStatementStartAt?: string | null;
75500
75671
  settings: {
75672
+ showVRPilotGuide: boolean;
75501
75673
  showReservations: boolean;
75502
75674
  showCancelledReservations: boolean;
75503
75675
  showReservationTotal: boolean;
@@ -76375,6 +76547,7 @@ export interface operations {
76375
76547
  };
76376
76548
  content: {
76377
76549
  "application/json": {
76550
+ showVRPilotGuide: boolean;
76378
76551
  showReservations: boolean;
76379
76552
  showCancelledReservations: boolean;
76380
76553
  showReservationTotal: boolean;
@@ -76528,6 +76701,7 @@ export interface operations {
76528
76701
  requestBody?: {
76529
76702
  content: {
76530
76703
  "application/json": {
76704
+ showVRPilotGuide?: boolean;
76531
76705
  showReservations?: boolean;
76532
76706
  showCancelledReservations?: boolean;
76533
76707
  showReservationTotal?: boolean;
@@ -76545,6 +76719,7 @@ export interface operations {
76545
76719
  };
76546
76720
  content: {
76547
76721
  "application/json": {
76722
+ showVRPilotGuide: boolean;
76548
76723
  showReservations: boolean;
76549
76724
  showCancelledReservations: boolean;
76550
76725
  showReservationTotal: boolean;
@@ -76842,6 +77017,7 @@ export interface operations {
76842
77017
  statementStartAt?: string | null;
76843
77018
  effectiveStatementStartAt?: string | null;
76844
77019
  settings: {
77020
+ showVRPilotGuide: boolean;
76845
77021
  showReservations: boolean;
76846
77022
  showCancelledReservations: boolean;
76847
77023
  showReservationTotal: boolean;
@@ -77224,6 +77400,7 @@ export interface operations {
77224
77400
  statementStartAt?: string | null;
77225
77401
  effectiveStatementStartAt?: string | null;
77226
77402
  settings: {
77403
+ showVRPilotGuide: boolean;
77227
77404
  showReservations: boolean;
77228
77405
  showCancelledReservations: boolean;
77229
77406
  showReservationTotal: boolean;
@@ -78394,6 +78571,7 @@ export interface operations {
78394
78571
  statementStartAt?: string | null;
78395
78572
  effectiveStatementStartAt?: string | null;
78396
78573
  settings: {
78574
+ showVRPilotGuide: boolean;
78397
78575
  showReservations: boolean;
78398
78576
  showCancelledReservations: boolean;
78399
78577
  showReservationTotal: boolean;
@@ -78712,6 +78890,7 @@ export interface operations {
78712
78890
  statementStartAt?: string | null;
78713
78891
  effectiveStatementStartAt?: string | null;
78714
78892
  settings: {
78893
+ showVRPilotGuide: boolean;
78715
78894
  showReservations: boolean;
78716
78895
  showCancelledReservations: boolean;
78717
78896
  showReservationTotal: boolean;
@@ -79382,6 +79561,7 @@ export interface operations {
79382
79561
  postTransactions: {
79383
79562
  parameters: {
79384
79563
  query?: {
79564
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
79385
79565
  dryRun?: boolean;
79386
79566
  };
79387
79567
  header?: never;
@@ -80592,6 +80772,7 @@ export interface operations {
80592
80772
  postTransactionsBatch: {
80593
80773
  parameters: {
80594
80774
  query?: {
80775
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
80595
80776
  dryRun?: boolean;
80596
80777
  };
80597
80778
  header?: never;
@@ -82086,6 +82267,7 @@ export interface operations {
82086
82267
  postTransactionsRecurringTemplates: {
82087
82268
  parameters: {
82088
82269
  query?: {
82270
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
82089
82271
  dryRun?: boolean;
82090
82272
  };
82091
82273
  header?: never;
@@ -82975,6 +83157,7 @@ export interface operations {
82975
83157
  putTransactionsRecurringTemplatesById: {
82976
83158
  parameters: {
82977
83159
  query?: {
83160
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
82978
83161
  dryRun?: boolean;
82979
83162
  };
82980
83163
  header?: never;
@@ -83356,6 +83539,7 @@ export interface operations {
83356
83539
  parameters: {
83357
83540
  query?: {
83358
83541
  onLocked?: "error" | "archive" | "detach";
83542
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
83359
83543
  dryRun?: boolean;
83360
83544
  };
83361
83545
  header?: never;
@@ -83519,6 +83703,7 @@ export interface operations {
83519
83703
  postTransactionsRecurringTemplatesByIdRun: {
83520
83704
  parameters: {
83521
83705
  query?: {
83706
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
83522
83707
  dryRun?: boolean;
83523
83708
  };
83524
83709
  header?: never;
@@ -84419,6 +84604,7 @@ export interface operations {
84419
84604
  putTransactionsById: {
84420
84605
  parameters: {
84421
84606
  query?: {
84607
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
84422
84608
  dryRun?: boolean;
84423
84609
  };
84424
84610
  header?: never;
@@ -85044,6 +85230,7 @@ export interface operations {
85044
85230
  parameters: {
85045
85231
  query?: {
85046
85232
  onLocked?: "error" | "archive";
85233
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
85047
85234
  dryRun?: boolean;
85048
85235
  };
85049
85236
  header?: never;
@@ -85203,6 +85390,7 @@ export interface operations {
85203
85390
  putTransactionsByTransactionIdLinesById: {
85204
85391
  parameters: {
85205
85392
  query?: {
85393
+ /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
85206
85394
  dryRun?: boolean;
85207
85395
  };
85208
85396
  header?: never;