@vrplatform/api 1.3.1-4440 → 1.3.1-4447

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.
@@ -3105,7 +3105,7 @@ export interface paths {
3105
3105
  /** @description Reservation Line Mappings List */
3106
3106
  get: operations["getReservationsLineMappings"];
3107
3107
  put?: never;
3108
- /** @description Create reservation line mapping */
3108
+ /** @description Create a reservation line mapping. Set accountId to null to create an excluded mapping that does not post journal entries. */
3109
3109
  post: operations["postReservationsLineMappings"];
3110
3110
  delete?: never;
3111
3111
  options?: never;
@@ -3138,7 +3138,7 @@ export interface paths {
3138
3138
  cookie?: never;
3139
3139
  };
3140
3140
  get?: never;
3141
- /** @description Update reservation line mapping */
3141
+ /** @description Update a reservation line mapping. Set accountId to null to exclude the line type from journal posting; status=excluded and reservation line isExcluded are derived read-only values. */
3142
3142
  put: operations["putReservationsLineMappingsByType"];
3143
3143
  post?: never;
3144
3144
  delete?: never;
@@ -3192,7 +3192,7 @@ export interface paths {
3192
3192
  };
3193
3193
  get?: never;
3194
3194
  put?: never;
3195
- /** @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. */
3195
+ /** @description Create a reservation adjustment line. Adjustments post additional journal entries for the reservation and are the supported way to change locked reservations. Pass onLocked=nextOpen to resolve and persist the earliest valid posting date, or provide generalLedgerPostingAt explicitly. The two options cannot be combined. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations#adjustments-and-posting-dates. */
3196
3196
  post: operations["postReservationsByReservationIdAdjustments"];
3197
3197
  delete?: never;
3198
3198
  options?: never;
@@ -55750,6 +55750,7 @@ export interface operations {
55750
55750
  /** @enum {string} */
55751
55751
  status: "active" | "inactive";
55752
55752
  } | null;
55753
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
55753
55754
  isExcluded?: boolean | null;
55754
55755
  }[];
55755
55756
  managerCentTotal: number | null;
@@ -56305,6 +56306,7 @@ export interface operations {
56305
56306
  /** @enum {string} */
56306
56307
  status: "active" | "inactive";
56307
56308
  } | null;
56309
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
56308
56310
  isExcluded?: boolean | null;
56309
56311
  }[];
56310
56312
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -57095,6 +57097,7 @@ export interface operations {
57095
57097
  query?: {
57096
57098
  search?: string;
57097
57099
  appId?: string;
57100
+ /** @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping */
57098
57101
  status?: "mapped" | "unmapped" | "excluded";
57099
57102
  /** @description Filter by account id(s) */
57100
57103
  accountId?: string;
@@ -57122,7 +57125,10 @@ export interface operations {
57122
57125
  id: string;
57123
57126
  name: string;
57124
57127
  } | null;
57125
- /** @enum {string} */
57128
+ /**
57129
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57130
+ * @enum {string}
57131
+ */
57126
57132
  status: "mapped" | "unmapped" | "excluded";
57127
57133
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57128
57134
  type: string;
@@ -57137,7 +57143,10 @@ export interface operations {
57137
57143
  id: string;
57138
57144
  name: string;
57139
57145
  } | null;
57140
- /** @enum {string} */
57146
+ /**
57147
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57148
+ * @enum {string}
57149
+ */
57141
57150
  status: "mapped" | "unmapped" | "excluded";
57142
57151
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57143
57152
  bookingChannel: string;
@@ -57301,6 +57310,7 @@ export interface operations {
57301
57310
  "application/json": {
57302
57311
  type: string;
57303
57312
  description?: string | null;
57313
+ /** @description Set to null to create an excluded line mapping */
57304
57314
  accountId?: string | null;
57305
57315
  revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
57306
57316
  };
@@ -57320,7 +57330,10 @@ export interface operations {
57320
57330
  id: string;
57321
57331
  name: string;
57322
57332
  } | null;
57323
- /** @enum {string} */
57333
+ /**
57334
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57335
+ * @enum {string}
57336
+ */
57324
57337
  status: "mapped" | "unmapped" | "excluded";
57325
57338
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57326
57339
  type: string;
@@ -57335,7 +57348,10 @@ export interface operations {
57335
57348
  id: string;
57336
57349
  name: string;
57337
57350
  } | null;
57338
- /** @enum {string} */
57351
+ /**
57352
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57353
+ * @enum {string}
57354
+ */
57339
57355
  status: "mapped" | "unmapped" | "excluded";
57340
57356
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57341
57357
  bookingChannel: string;
@@ -57482,6 +57498,7 @@ export interface operations {
57482
57498
  query?: {
57483
57499
  search?: string;
57484
57500
  appId?: string;
57501
+ /** @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping */
57485
57502
  status?: "mapped" | "unmapped" | "excluded";
57486
57503
  /** @description Filter by account id(s) */
57487
57504
  accountId?: string;
@@ -57650,10 +57667,12 @@ export interface operations {
57650
57667
  content: {
57651
57668
  "application/json": {
57652
57669
  description?: string | null;
57670
+ /** @description Set to null to exclude this line type from journal posting */
57653
57671
  accountId?: string | null;
57654
57672
  revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
57655
57673
  channelMappings?: {
57656
57674
  bookingChannel: string;
57675
+ /** @description Set to null to exclude this channel-specific line mapping */
57657
57676
  accountId?: string | null;
57658
57677
  revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
57659
57678
  }[] | null;
@@ -57674,7 +57693,10 @@ export interface operations {
57674
57693
  id: string;
57675
57694
  name: string;
57676
57695
  } | null;
57677
- /** @enum {string} */
57696
+ /**
57697
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57698
+ * @enum {string}
57699
+ */
57678
57700
  status: "mapped" | "unmapped" | "excluded";
57679
57701
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57680
57702
  type: string;
@@ -57689,7 +57711,10 @@ export interface operations {
57689
57711
  id: string;
57690
57712
  name: string;
57691
57713
  } | null;
57692
- /** @enum {string} */
57714
+ /**
57715
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57716
+ * @enum {string}
57717
+ */
57693
57718
  status: "mapped" | "unmapped" | "excluded";
57694
57719
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57695
57720
  bookingChannel: string;
@@ -58184,6 +58209,7 @@ export interface operations {
58184
58209
  /** @enum {string} */
58185
58210
  status: "active" | "inactive";
58186
58211
  } | null;
58212
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
58187
58213
  isExcluded?: boolean | null;
58188
58214
  }[];
58189
58215
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -58862,6 +58888,7 @@ export interface operations {
58862
58888
  /** @enum {string} */
58863
58889
  status: "active" | "inactive";
58864
58890
  } | null;
58891
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
58865
58892
  isExcluded?: boolean | null;
58866
58893
  }[];
58867
58894
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -59398,6 +59425,8 @@ export interface operations {
59398
59425
  postReservationsByReservationIdAdjustments: {
59399
59426
  parameters: {
59400
59427
  query?: {
59428
+ /** @description Use nextOpen to resolve and persist the earliest valid posting date when the natural date is locked */
59429
+ onLocked?: "error" | "nextOpen";
59401
59430
  /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
59402
59431
  dryRun?: boolean;
59403
59432
  };
@@ -59766,6 +59795,7 @@ export interface operations {
59766
59795
  /** @enum {string} */
59767
59796
  status: "active" | "inactive";
59768
59797
  } | null;
59798
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
59769
59799
  isExcluded?: boolean | null;
59770
59800
  }[];
59771
59801
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -60336,6 +60366,7 @@ export interface operations {
60336
60366
  /** @enum {string} */
60337
60367
  status: "active" | "inactive";
60338
60368
  } | null;
60369
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
60339
60370
  isExcluded?: boolean | null;
60340
60371
  }[];
60341
60372
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -60888,6 +60919,7 @@ export interface operations {
60888
60919
  /** @enum {string} */
60889
60920
  status: "active" | "inactive";
60890
60921
  } | null;
60922
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
60891
60923
  isExcluded?: boolean | null;
60892
60924
  }[];
60893
60925
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */