@vrplatform/api 1.3.1-4440 → 1.3.1-4444

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-4440",
6
+ "version": "1.3.1-4444",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -3106,7 +3106,7 @@ export interface paths {
3106
3106
  /** @description Reservation Line Mappings List */
3107
3107
  get: operations["getReservationsLineMappings"];
3108
3108
  put?: never;
3109
- /** @description Create reservation line mapping */
3109
+ /** @description Create a reservation line mapping. Set accountId to null to create an excluded mapping that does not post journal entries. */
3110
3110
  post: operations["postReservationsLineMappings"];
3111
3111
  delete?: never;
3112
3112
  options?: never;
@@ -3139,7 +3139,7 @@ export interface paths {
3139
3139
  cookie?: never;
3140
3140
  };
3141
3141
  get?: never;
3142
- /** @description Update reservation line mapping */
3142
+ /** @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. */
3143
3143
  put: operations["putReservationsLineMappingsByType"];
3144
3144
  post?: never;
3145
3145
  delete?: never;
@@ -3193,7 +3193,7 @@ export interface paths {
3193
3193
  };
3194
3194
  get?: never;
3195
3195
  put?: never;
3196
- /** @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. */
3196
+ /** @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. */
3197
3197
  post: operations["postReservationsByReservationIdAdjustments"];
3198
3198
  delete?: never;
3199
3199
  options?: never;
@@ -55751,6 +55751,7 @@ export interface operations {
55751
55751
  /** @enum {string} */
55752
55752
  status: "active" | "inactive";
55753
55753
  } | null;
55754
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
55754
55755
  isExcluded?: boolean | null;
55755
55756
  }[];
55756
55757
  managerCentTotal: number | null;
@@ -56306,6 +56307,7 @@ export interface operations {
56306
56307
  /** @enum {string} */
56307
56308
  status: "active" | "inactive";
56308
56309
  } | null;
56310
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
56309
56311
  isExcluded?: boolean | null;
56310
56312
  }[];
56311
56313
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -57096,6 +57098,7 @@ export interface operations {
57096
57098
  query?: {
57097
57099
  search?: string;
57098
57100
  appId?: string;
57101
+ /** @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping */
57099
57102
  status?: "mapped" | "unmapped" | "excluded";
57100
57103
  /** @description Filter by account id(s) */
57101
57104
  accountId?: string;
@@ -57123,7 +57126,10 @@ export interface operations {
57123
57126
  id: string;
57124
57127
  name: string;
57125
57128
  } | null;
57126
- /** @enum {string} */
57129
+ /**
57130
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57131
+ * @enum {string}
57132
+ */
57127
57133
  status: "mapped" | "unmapped" | "excluded";
57128
57134
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57129
57135
  type: string;
@@ -57138,7 +57144,10 @@ export interface operations {
57138
57144
  id: string;
57139
57145
  name: string;
57140
57146
  } | null;
57141
- /** @enum {string} */
57147
+ /**
57148
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57149
+ * @enum {string}
57150
+ */
57142
57151
  status: "mapped" | "unmapped" | "excluded";
57143
57152
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57144
57153
  bookingChannel: string;
@@ -57302,6 +57311,7 @@ export interface operations {
57302
57311
  "application/json": {
57303
57312
  type: string;
57304
57313
  description?: string | null;
57314
+ /** @description Set to null to create an excluded line mapping */
57305
57315
  accountId?: string | null;
57306
57316
  revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
57307
57317
  };
@@ -57321,7 +57331,10 @@ export interface operations {
57321
57331
  id: string;
57322
57332
  name: string;
57323
57333
  } | null;
57324
- /** @enum {string} */
57334
+ /**
57335
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57336
+ * @enum {string}
57337
+ */
57325
57338
  status: "mapped" | "unmapped" | "excluded";
57326
57339
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57327
57340
  type: string;
@@ -57336,7 +57349,10 @@ export interface operations {
57336
57349
  id: string;
57337
57350
  name: string;
57338
57351
  } | null;
57339
- /** @enum {string} */
57352
+ /**
57353
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57354
+ * @enum {string}
57355
+ */
57340
57356
  status: "mapped" | "unmapped" | "excluded";
57341
57357
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57342
57358
  bookingChannel: string;
@@ -57483,6 +57499,7 @@ export interface operations {
57483
57499
  query?: {
57484
57500
  search?: string;
57485
57501
  appId?: string;
57502
+ /** @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping */
57486
57503
  status?: "mapped" | "unmapped" | "excluded";
57487
57504
  /** @description Filter by account id(s) */
57488
57505
  accountId?: string;
@@ -57651,10 +57668,12 @@ export interface operations {
57651
57668
  content: {
57652
57669
  "application/json": {
57653
57670
  description?: string | null;
57671
+ /** @description Set to null to exclude this line type from journal posting */
57654
57672
  accountId?: string | null;
57655
57673
  revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
57656
57674
  channelMappings?: {
57657
57675
  bookingChannel: string;
57676
+ /** @description Set to null to exclude this channel-specific line mapping */
57658
57677
  accountId?: string | null;
57659
57678
  revenueRecognition?: ("checkIn" | "checkOut" | "proRata") | null;
57660
57679
  }[] | null;
@@ -57675,7 +57694,10 @@ export interface operations {
57675
57694
  id: string;
57676
57695
  name: string;
57677
57696
  } | null;
57678
- /** @enum {string} */
57697
+ /**
57698
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57699
+ * @enum {string}
57700
+ */
57679
57701
  status: "mapped" | "unmapped" | "excluded";
57680
57702
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57681
57703
  type: string;
@@ -57690,7 +57712,10 @@ export interface operations {
57690
57712
  id: string;
57691
57713
  name: string;
57692
57714
  } | null;
57693
- /** @enum {string} */
57715
+ /**
57716
+ * @description Derived status: mapped has an account, excluded has an explicit mapping with no account, and unmapped has no mapping
57717
+ * @enum {string}
57718
+ */
57694
57719
  status: "mapped" | "unmapped" | "excluded";
57695
57720
  revenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
57696
57721
  bookingChannel: string;
@@ -58185,6 +58210,7 @@ export interface operations {
58185
58210
  /** @enum {string} */
58186
58211
  status: "active" | "inactive";
58187
58212
  } | null;
58213
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
58188
58214
  isExcluded?: boolean | null;
58189
58215
  }[];
58190
58216
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -58863,6 +58889,7 @@ export interface operations {
58863
58889
  /** @enum {string} */
58864
58890
  status: "active" | "inactive";
58865
58891
  } | null;
58892
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
58866
58893
  isExcluded?: boolean | null;
58867
58894
  }[];
58868
58895
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -59399,6 +59426,8 @@ export interface operations {
59399
59426
  postReservationsByReservationIdAdjustments: {
59400
59427
  parameters: {
59401
59428
  query?: {
59429
+ /** @description Use nextOpen to resolve and persist the earliest valid posting date when the natural date is locked */
59430
+ onLocked?: "error" | "nextOpen";
59402
59431
  /** @description Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode. */
59403
59432
  dryRun?: boolean;
59404
59433
  };
@@ -59767,6 +59796,7 @@ export interface operations {
59767
59796
  /** @enum {string} */
59768
59797
  status: "active" | "inactive";
59769
59798
  } | null;
59799
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
59770
59800
  isExcluded?: boolean | null;
59771
59801
  }[];
59772
59802
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -60337,6 +60367,7 @@ export interface operations {
60337
60367
  /** @enum {string} */
60338
60368
  status: "active" | "inactive";
60339
60369
  } | null;
60370
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
60340
60371
  isExcluded?: boolean | null;
60341
60372
  }[];
60342
60373
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */
@@ -60889,6 +60920,7 @@ export interface operations {
60889
60920
  /** @enum {string} */
60890
60921
  status: "active" | "inactive";
60891
60922
  } | null;
60923
+ /** @description Read-only derived value indicating that the effective line mapping is explicitly excluded */
60892
60924
  isExcluded?: boolean | null;
60893
60925
  }[];
60894
60926
  /** @description Adjustments are manually added financial lines that are not part of the booking platform */