@v-office/website-sdk 2.28.1 → 2.30.0

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.
Files changed (43) hide show
  1. package/README.md +8 -0
  2. package/dist/cli.mjs +406 -12
  3. package/dist/{client-EtS0Qm3i.mjs → client-CKVwzIQ4.mjs} +381 -53
  4. package/dist/index.d.mts +45 -6
  5. package/dist/index.mjs +1 -1
  6. package/dist/instructions/CHANGELOG.md +2 -0
  7. package/dist/instructions/MIGRATION.md +2 -0
  8. package/dist/instructions/README.md +3 -2
  9. package/dist/instructions/availability.md +22 -2
  10. package/dist/instructions/creation.md +35 -4
  11. package/dist/instructions/custom-attributes.md +2 -2
  12. package/dist/instructions/filter.md +5 -3
  13. package/dist/instructions/quote.md +1 -1
  14. package/dist/instructions/rentals.md +36 -0
  15. package/dist/instructions/search.md +220 -6
  16. package/dist/instructions/versions/2.29.0/CHANGELOG.md +62 -0
  17. package/dist/instructions/versions/2.29.0/MIGRATION.md +97 -0
  18. package/dist/instructions/versions/2.30.0/CHANGELOG.md +40 -0
  19. package/dist/instructions/versions/2.30.0/MIGRATION.md +30 -0
  20. package/dist/{v9-data-C3SWtDGs.mjs → operations-CfjJjdrw.mjs} +3122 -1
  21. package/dist/{rentals-B4g91vwW.mjs → rentals-cmqp5dTw.mjs} +4 -5
  22. package/dist/{search-B-lvOmXL.mjs → search-DPsBki_9.mjs} +6 -5
  23. package/dist/{to-rental-highlights-BL5m3Uen.mjs → to-rental-highlights-D7oepO6s.mjs} +1 -1
  24. package/dist/translations/v9/de-DE/core.json +8 -1
  25. package/dist/translations/v9/en-US/core.json +8 -1
  26. package/instructions/CHANGELOG.md +2 -0
  27. package/instructions/MIGRATION.md +2 -0
  28. package/instructions/README.md +3 -2
  29. package/instructions/availability.md +22 -2
  30. package/instructions/creation.md +35 -4
  31. package/instructions/custom-attributes.md +2 -2
  32. package/instructions/filter.md +5 -3
  33. package/instructions/quote.md +1 -1
  34. package/instructions/rentals.md +36 -0
  35. package/instructions/search.md +220 -6
  36. package/instructions/versions/2.29.0/CHANGELOG.md +62 -0
  37. package/instructions/versions/2.29.0/MIGRATION.md +97 -0
  38. package/instructions/versions/2.29.0/release.json +3 -0
  39. package/instructions/versions/2.30.0/CHANGELOG.md +40 -0
  40. package/instructions/versions/2.30.0/MIGRATION.md +30 -0
  41. package/instructions/versions/2.30.0/release.json +3 -0
  42. package/package.json +6 -4
  43. package/dist/operations-DwURbo0b.mjs +0 -2850
package/dist/index.d.mts CHANGED
@@ -1,6 +1,7 @@
1
- import { AdditionalServiceLimitExceeded, AvailabilityGetInitialAvailabilityInput, AvailabilityGetInitialAvailabilityInput as AvailabilityGetInitialAvailabilityInput$1, AvailabilityGetInitialAvailabilityOutput, AvailabilityGetInitialAvailabilityOutput as AvailabilityGetInitialAvailabilityOutput$1, AvailabilityGetStartDateSelectedAvailabilityInput, AvailabilityGetStartDateSelectedAvailabilityInput as AvailabilityGetStartDateSelectedAvailabilityInput$1, AvailabilityGetStartDateSelectedAvailabilityOutput, AvailabilityGetStartDateSelectedAvailabilityOutput as AvailabilityGetStartDateSelectedAvailabilityOutput$1, AvailabilityService, BackendKind, BookingBankTransferDetails, BookingBankTransferDetails as BookingBankTransferDetails$1, BookingBookInput, BookingBookInput as BookingBookInput$1, BookingBookOutput, BookingBookOutput as BookingBookOutput$1, BookingPayment, BookingPaymentAlternative, BookingPaymentOption, BookingPaymentScheduleItem, BookingPaymentScheduleKind, BookingPaymentScheduleLine, BookingService, ContactService, ContactSubmitInput, ContactSubmitInput as ContactSubmitInput$1, ContactSubmitOutput, ContactSubmitOutput as ContactSubmitOutput$1, ContactSubmitValidationIssue, ContactSubmitValidationIssueCode, CoreSDKError, CoreSDKError as CMSError, CoreSDKError as CoreSDKError$1, CustomAttributeCatalog, CustomAttributeCatalogDefinitionInput, CustomAttributeCatalogInput, CustomAttributeCatalogSchema, CustomAttributeCategoryKey, CustomAttributeFilterCategoryKey, CustomAttributeFilterDefinition, CustomAttributeFilterDefinition as CustomAttributeFilterDefinition$1, CustomAttributeFilterExpression, CustomAttributeFilterLabel, CustomAttributeFilterNumericBounds, CustomAttributeFilterOption, CustomAttributeOverridesInput, CustomAttributeRegistry, CustomAttributeRegistrySnapshot, CustomAttributeRegistrySnapshot as CustomAttributeRegistrySnapshot$1, CustomAttributeSelection, DocumentsGetTermsAndPrivacyPolicyInput, DocumentsGetTermsAndPrivacyPolicyInput as DocumentsGetTermsAndPrivacyPolicyInput$1, DocumentsGetTermsAndPrivacyPolicyOutput, DocumentsGetTermsAndPrivacyPolicyOutput as DocumentsGetTermsAndPrivacyPolicyOutput$1, DocumentsService, FilterGetFiltersInput, FilterGetFiltersInput as FilterGetFiltersInput$1, FilterGetFiltersOutput, FilterGetFiltersOutput as FilterGetFiltersOutput$1, FilterService, GuestQuote, GuestQuoteInput, GuestQuoteInsurance, GuestQuoteResult, GuestQuoteSchema, GuestQuoteSelectionResult, GuestQuoteVoucher, InsuranceBookingOutput, InsuranceCustomerInformationInput, InsurancePaymentInformationInput, InsurancePaymentOptionOutput, InsurancePreContractOutput, InvalidAdditionalServiceQuantity, Locale, Locale as Locale$1, LocaleSchema, QuoteAddAdditionalServiceInput, QuoteAddAdditionalServiceOutput, QuoteBookInsuranceInput, QuoteBookInsuranceOutput, QuoteClearAdditionalServicesInput, QuoteClearAdditionalServicesOutput, QuoteCreateInsurancePreContractInput, QuoteCreateInsurancePreContractOutput, QuoteQuoteInput, QuoteQuoteInput as QuoteQuoteInput$1, QuoteQuoteOutput, QuoteQuoteOutput as QuoteQuoteOutput$1, QuoteRemoveAdditionalServiceInput, QuoteRemoveAdditionalServiceOutput, QuoteSelectCancellationPolicyInput, QuoteSelectCancellationPolicyOutput, QuoteSelectInsuranceInput, QuoteSelectInsuranceOutput, QuoteSelectInsurancePaymentInput, QuoteSelectInsurancePaymentOutput, QuoteService as QuoteService$1, RentalGetRentalsInput, RentalGetRentalsInput as RentalGetRentalsInput$1, RentalGetRentalsOutput, RentalGetRentalsOutput as RentalGetRentalsOutput$1, RentalHighlightPrioritizationKey, RentalHighlightPrioritizationKey as RentalHighlightPrioritizationKey$1, RentalPropertyHighlightPrioritizationKey, RentalPropertyHighlightPrioritizationKey as RentalPropertyHighlightPrioritizationKey$1, RentalScope, RentalService, ResolvedCustomAttribute, SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS, SearchAllRentalsAtOnceInput, SearchAllRentalsAtOnceInput as SearchAllRentalsAtOnceInput$1, SearchMapSearchInput, SearchMapSearchInput as SearchMapSearchInput$1, SearchMapSearchInputSchema, SearchMapSearchOutput, SearchMapSearchOutput as SearchMapSearchOutput$1, SearchMapSearchOutputItem, SearchMapSearchOutputSchema, SearchSearchAlternative, SearchSearchFieldOrderBy, SearchSearchFieldOrderBySchema, SearchSearchFieldSort, SearchSearchFieldSort as SearchSearchFieldSort$1, SearchSearchFieldSortSchema, SearchSearchInput, SearchSearchInput as SearchSearchInput$1, SearchSearchInputSchema, SearchSearchOutput, SearchSearchOutput as SearchSearchOutput$1, SearchSearchOutputItem, SearchSearchOutputSchema, SearchSearchPriceSort, SearchSearchPriceSortSchema, SearchSearchRandomSort, SearchSearchRandomSortSchema, SearchSearchRatingSort, SearchSearchRatingSortSchema, SearchSearchSort, SearchSearchSort as SearchSearchSort$1, SearchSearchSortSchema, SearchService, SearchSortDirection, SearchSortDirectionSchema, SelectableInsuranceOptionOutput, SelectedInsuranceInformationInput, SubmittableBookingPaymentOption, SubmittableBookingPaymentOption as SubmittableBookingPaymentOption$1, TranslationOverrides, TranslationOverrides as TranslationOverrides$1, UnknownAdditionalService, V10CoreConfig, V9OnlyCustomAttributeInput, defineCustomAttributes, defineCustomAttributesFromUnknown, fetchCustomAttributeCatalog, parseCustomAttributeCatalog, validateContactSubmitInput } from "@v-office/sdk-core";
1
+ import { AdditionalServiceLimitExceeded, AvailabilityEndDateOption, AvailabilityGetInitialAvailabilityInput, AvailabilityGetInitialAvailabilityInput as AvailabilityGetInitialAvailabilityInput$1, AvailabilityGetInitialAvailabilityOutput, AvailabilityGetInitialAvailabilityOutput as AvailabilityGetInitialAvailabilityOutput$1, AvailabilityGetStartDateSelectedAvailabilityInput, AvailabilityGetStartDateSelectedAvailabilityInput as AvailabilityGetStartDateSelectedAvailabilityInput$1, AvailabilityGetStartDateSelectedAvailabilityOutput, AvailabilityGetStartDateSelectedAvailabilityOutput as AvailabilityGetStartDateSelectedAvailabilityOutput$1, AvailabilityService, BackendKind, BookingBankTransferDetails, BookingBankTransferDetails as BookingBankTransferDetails$1, BookingBookInput, BookingBookInput as BookingBookInput$1, BookingBookOutput, BookingBookOutput as BookingBookOutput$1, BookingPayment, BookingPaymentAlternative, BookingPaymentOption, BookingPaymentScheduleItem, BookingPaymentScheduleKind, BookingPaymentScheduleLine, BookingService, ContactService, ContactSubmitInput, ContactSubmitInput as ContactSubmitInput$1, ContactSubmitOutput, ContactSubmitOutput as ContactSubmitOutput$1, ContactSubmitValidationIssue, ContactSubmitValidationIssueCode, CoreSDKError, CoreSDKError as CMSError, CoreSDKError as CoreSDKError$1, CustomAttributeCatalog, CustomAttributeCatalogDefinitionInput, CustomAttributeCatalogInput, CustomAttributeCatalogSchema, CustomAttributeCategoryKey, CustomAttributeFilterCategoryKey, CustomAttributeFilterDefinition, CustomAttributeFilterDefinition as CustomAttributeFilterDefinition$1, CustomAttributeFilterExpression, CustomAttributeFilterLabel, CustomAttributeFilterNumericBounds, CustomAttributeFilterOption, CustomAttributeOverridesInput, CustomAttributeRegistry, CustomAttributeRegistrySnapshot, CustomAttributeRegistrySnapshot as CustomAttributeRegistrySnapshot$1, CustomAttributeSelection, DocumentsGetTermsAndPrivacyPolicyInput, DocumentsGetTermsAndPrivacyPolicyInput as DocumentsGetTermsAndPrivacyPolicyInput$1, DocumentsGetTermsAndPrivacyPolicyOutput, DocumentsGetTermsAndPrivacyPolicyOutput as DocumentsGetTermsAndPrivacyPolicyOutput$1, DocumentsService, FilterGetFiltersInput, FilterGetFiltersInput as FilterGetFiltersInput$1, FilterGetFiltersOutput, FilterGetFiltersOutput as FilterGetFiltersOutput$1, FilterService, GuestQuote, GuestQuoteInput, GuestQuoteInsurance, GuestQuoteResult, GuestQuoteSchema, GuestQuoteSelectionResult, GuestQuoteVoucher, InsuranceBookingOutput, InsuranceCustomerInformationInput, InsurancePaymentInformationInput, InsurancePaymentOptionOutput, InsurancePreContractOutput, InvalidAdditionalServiceQuantity, LocalDateString, Locale, Locale as Locale$1, LocaleSchema, QuoteAddAdditionalServiceInput, QuoteAddAdditionalServiceOutput, QuoteBookInsuranceInput, QuoteBookInsuranceOutput, QuoteClearAdditionalServicesInput, QuoteClearAdditionalServicesOutput, QuoteCreateInsurancePreContractInput, QuoteCreateInsurancePreContractOutput, QuoteQuoteInput, QuoteQuoteInput as QuoteQuoteInput$1, QuoteQuoteOutput, QuoteQuoteOutput as QuoteQuoteOutput$1, QuoteRemoveAdditionalServiceInput, QuoteRemoveAdditionalServiceOutput, QuoteSelectCancellationPolicyInput, QuoteSelectCancellationPolicyOutput, QuoteSelectInsuranceInput, QuoteSelectInsuranceOutput, QuoteSelectInsurancePaymentInput, QuoteSelectInsurancePaymentOutput, QuoteService as QuoteService$1, RentalGetRentalsInput, RentalGetRentalsInput as RentalGetRentalsInput$1, RentalGetRentalsOutput, RentalGetRentalsOutput as RentalGetRentalsOutput$1, RentalHighlightPrioritizationKey, RentalHighlightPrioritizationKey as RentalHighlightPrioritizationKey$1, RentalPropertyHighlightPrioritizationKey, RentalPropertyHighlightPrioritizationKey as RentalPropertyHighlightPrioritizationKey$1, RentalScope, RentalService, ResolvedCustomAttribute, SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS, SearchAllRentalsAtOnceInput, SearchAllRentalsAtOnceInput as SearchAllRentalsAtOnceInput$1, SearchMapSearchInput, SearchMapSearchInput as SearchMapSearchInput$1, SearchMapSearchInputSchema, SearchMapSearchOutput, SearchMapSearchOutput as SearchMapSearchOutput$1, SearchMapSearchOutputItem, SearchMapSearchOutputSchema, SearchSearchAlternative, SearchSearchFieldOrderBy, SearchSearchFieldOrderBySchema, SearchSearchFieldSort, SearchSearchFieldSort as SearchSearchFieldSort$1, SearchSearchFieldSortSchema, SearchSearchInput, SearchSearchInput as SearchSearchInput$1, SearchSearchInputSchema, SearchSearchOutput, SearchSearchOutput as SearchSearchOutput$1, SearchSearchOutputItem, SearchSearchOutputSchema, SearchSearchPriceSort, SearchSearchPriceSortSchema, SearchSearchRandomSort, SearchSearchRandomSortSchema, SearchSearchRatingSort, SearchSearchRatingSortSchema, SearchSearchSort, SearchSearchSort as SearchSearchSort$1, SearchSearchSortSchema, SearchService, SearchSortDirection, SearchSortDirectionSchema, SelectableInsuranceOptionOutput, SelectedInsuranceInformationInput, SubmittableBookingPaymentOption, SubmittableBookingPaymentOption as SubmittableBookingPaymentOption$1, TranslationOverrides, TranslationOverrides as TranslationOverrides$1, UnknownAdditionalService, V10CoreConfig, V9OnlyCustomAttributeInput, defineCustomAttributes, defineCustomAttributesFromUnknown, fetchCustomAttributeCatalog, parseCustomAttributeCatalog, validateContactSubmitInput } from "@v-office/sdk-core";
2
2
  import { Context, Effect, Layer, Schema } from "effect";
3
3
  import { HttpClient } from "effect/unstable/http";
4
+ import "@graphql-typed-document-node/core";
4
5
  //#region src/legacy-v9/property-highlight-sources.d.ts
5
6
  type V9PropertyHighlightDataAttribute = `p_${number}`;
6
7
  type V9PropertyHighlightSourceInput = {
@@ -43,7 +44,10 @@ type WebsiteV9Config = {
43
44
  readonly rentalDataAttributes?: readonly string[];
44
45
  /** Facility p_* attribute whose value contains related vOffice object-group IDs. */
45
46
  readonly facilityObjectGroupRelationAttributeId?: number;
47
+ readonly rentalScopePropertyKind?: V9RentalScopePropertyKind;
48
+ readonly rentalIdsSearch?: boolean;
46
49
  };
50
+ type V9RentalScopePropertyKind = "facility" | "objectGroup";
47
51
  //#endregion
48
52
  //#region src/config.d.ts
49
53
  type WebsiteV10Config = V10CoreConfig & {
@@ -95,12 +99,22 @@ type V9InitialAvailabilityOutput = AvailabilityGetInitialAvailabilityOutput$1 &
95
99
  readonly childrenAllowed: boolean | null;
96
100
  readonly maxPets: number | null;
97
101
  };
102
+ type V9EndDateOption = AvailabilityEndDateOption & {
103
+ readonly formattedPrice: string | null;
104
+ };
105
+ type V9StartDateSelectedAvailabilityOutput = {
106
+ readonly calendarDays: Record<LocalDateString, V9EndDateOption>;
107
+ };
108
+ //#endregion
109
+ //#region src/legacy-v9/rental-ids.d.ts
110
+ type V9RentalsGetRentalsByIdsInput = {
111
+ readonly locale: Locale$1;
112
+ readonly rentalIds: ReadonlyArray<string>;
113
+ };
98
114
  //#endregion
99
115
  //#region src/legacy-v9/search-input.d.ts
100
116
  type V9SearchSearchSort = Exclude<SearchSearchSort$1, SearchSearchFieldSort$1>;
101
- type V9SearchSearchInput = Omit<SearchSearchInput$1, "rentalIdsIn" | "voucher" | "sort"> & {
102
- readonly rentalIdsIn?: never;
103
- readonly voucher?: never;
117
+ type V9SearchSearchInput = Omit<SearchSearchInput$1, "sort"> & {
104
118
  readonly sort?: V9SearchSearchSort;
105
119
  };
106
120
  type V9SearchPagesInput = Omit<V9SearchSearchInput, "cursor" | "limit"> & {
@@ -121,6 +135,20 @@ type V9SearchSearchOutput = Omit<SearchSearchOutput$1, "items"> & {
121
135
  readonly items: readonly V9SearchSearchOutputItem[];
122
136
  };
123
137
  //#endregion
138
+ //#region src/legacy-v9/voucher-input.d.ts
139
+ type V9VoucherValidityReason = "valid" | "not_yet_valid" | "expired" | "unknown" | "stay_too_short" | "outside_booking_window" | "rate_limited";
140
+ type V9VoucherValidateInput = {
141
+ readonly code: string;
142
+ readonly start?: string;
143
+ readonly end?: string;
144
+ readonly locale: Locale$1;
145
+ };
146
+ type V9VoucherValidateOutput = {
147
+ readonly valid: boolean;
148
+ readonly reason: V9VoucherValidityReason;
149
+ readonly label: string;
150
+ };
151
+ //#endregion
124
152
  //#region src/client.d.ts
125
153
  type WebsiteSDKSharedStatic = {
126
154
  readonly rentals: {
@@ -185,11 +213,20 @@ type WebsiteSDKV10AllRentalsAtOnceLive = Omit<WebsiteSDKSharedLive, "search"> &
185
213
  readonly search: (input: SearchAllRentalsAtOnceInput$1) => Promise<SearchSearchOutput$1>;
186
214
  };
187
215
  };
188
- type WebsiteSDKV9LiveAvailability = Omit<WebsiteSDKSharedLive["availability"], "getInitialAvailability"> & {
216
+ type WebsiteSDKV9LiveAvailability = {
189
217
  readonly getInitialAvailability: (input: AvailabilityGetInitialAvailabilityInput$1) => Promise<V9InitialAvailabilityOutput>;
218
+ readonly getStartDateSelectedAvailability: (input: AvailabilityGetStartDateSelectedAvailabilityInput$1) => Promise<V9StartDateSelectedAvailabilityOutput>;
219
+ };
220
+ type WebsiteSDKV9LiveVoucher = {
221
+ readonly validate: (input: V9VoucherValidateInput) => Promise<V9VoucherValidateOutput>;
222
+ };
223
+ type WebsiteSDKV9LiveRentals = {
224
+ readonly getRentalsByIds: (input: V9RentalsGetRentalsByIdsInput) => Promise<RentalGetRentalsOutput$1>;
190
225
  };
191
226
  type WebsiteSDKV9Live = Omit<WebsiteSDKSharedLive, "search" | "availability"> & {
192
227
  readonly availability: WebsiteSDKV9LiveAvailability;
228
+ readonly voucher: WebsiteSDKV9LiveVoucher;
229
+ readonly rentals: WebsiteSDKV9LiveRentals;
193
230
  readonly search: {
194
231
  readonly search: (input: V9SearchSearchInput) => Promise<V9SearchSearchOutput>;
195
232
  readonly mapSearch: WebsiteSDKSharedLive["search"]["mapSearch"];
@@ -199,6 +236,8 @@ type WebsiteSDKV9Live = Omit<WebsiteSDKSharedLive, "search" | "availability"> &
199
236
  /** `live` of a v9 SDK created with `searchAllRentalsAtOnce: true`. */
200
237
  type WebsiteSDKV9AllRentalsAtOnceLive = Omit<WebsiteSDKSharedLive, "search" | "availability"> & {
201
238
  readonly availability: WebsiteSDKV9LiveAvailability;
239
+ readonly voucher: WebsiteSDKV9LiveVoucher;
240
+ readonly rentals: WebsiteSDKV9LiveRentals;
202
241
  readonly search: {
203
242
  /** Every result with its price in one call; at most `SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS`. */
204
243
  readonly search: (input: V9SearchAllRentalsAtOnceInput) => Promise<V9SearchSearchOutput>;
@@ -7628,4 +7667,4 @@ export type RentalRentalsOutput = RentalGetRentalsOutput$1[number];
7628
7667
  export type RentalSearchInput = SearchSearchInput$1;
7629
7668
  export type RentalSearchOutput = SearchSearchOutput$1;
7630
7669
  //#endregion
7631
- export { AdditionalServiceLimitExceeded, type AvailabilityGetInitialAvailabilityInput, type AvailabilityGetInitialAvailabilityOutput, type AvailabilityGetStartDateSelectedAvailabilityInput, type AvailabilityGetStartDateSelectedAvailabilityOutput, type BackendKind, type BookingBankTransferDetails, type BookingBookInput, type BookingBookOutput, type BookingPayment, type BookingPaymentAlternative, type BookingPaymentOption, type BookingPaymentScheduleItem, type BookingPaymentScheduleKind, type BookingPaymentScheduleLine, CMSError, type ContactSubmitInput, type ContactSubmitOutput, type ContactSubmitValidationIssue, type ContactSubmitValidationIssueCode, CoreSDKError, type CustomAttributeCatalog, type CustomAttributeCatalogDefinitionInput, type CustomAttributeCatalogInput, CustomAttributeCatalogSchema, type CustomAttributeCategoryKey, type CustomAttributeFilterCategoryKey, type CustomAttributeFilterDefinition, type CustomAttributeFilterExpression, type CustomAttributeFilterLabel, type CustomAttributeFilterNumericBounds, type CustomAttributeFilterOption, type CustomAttributeOverridesInput, type CustomAttributeRegistry, type CustomAttributeRegistrySnapshot, type CustomAttributeSelection, type CustomDataAttribute, type DataAttribute, type DocumentsGetTermsAndPrivacyPolicyInput, type DocumentsGetTermsAndPrivacyPolicyOutput, type FilterGetFiltersInput, type FilterGetFiltersOutput, type GeoLocation, type GuestQuote, type GuestQuoteInput, type GuestQuoteInsurance, type GuestQuoteResult, GuestQuoteSchema, type GuestQuoteSelectionResult, type GuestQuoteVoucher, type ImageData, type InsuranceBookingOutput, type InsuranceCustomerInformationInput, type InsurancePaymentInformationInput, type InsurancePaymentOptionOutput, type InsurancePreContractOutput, InvalidAdditionalServiceQuantity, type KnownVofficeFacilityData, type KnownVofficeFacilityDataAttribute, type KnownVofficeFeedbackData, type KnownVofficeFeedbackDataAttribute, type KnownVofficeImageData, type KnownVofficeImageDataAttribute, type KnownVofficeOfferData, type KnownVofficeOfferDataAttribute, type KnownVofficePriceData, type KnownVofficePriceDataAttribute, type KnownVofficeRatingData, type KnownVofficeRatingDataAttribute, type KnownVofficeServiceData, type KnownVofficeServiceDataAttribute, type KnownVofficeTotalRatingData, type KnownVofficeTotalRatingDataAttribute, type KnownVofficeUnitData, type KnownVofficeUnitDataAttribute, type Locale, LocaleSchema, type ParsedJsonData, type ParsedVofficeFacilityData, type ParsedVofficeFeedbackData, type ParsedVofficeImageData, type ParsedVofficeOfferData, type ParsedVofficePriceData, type ParsedVofficeRatingData, type ParsedVofficeServiceData, type ParsedVofficeTotalRatingData, type ParsedVofficeUnitData, type QuoteQuoteInput, type QuoteQuoteOutput, type RentalGetRentalsInput, type RentalGetRentalsOutput, type RentalHighlightPrioritizationKey, type RentalPropertyHighlightPrioritizationKey, type ResolvedCustomAttribute, type ResolvedV9PropertyHighlightSource, SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS, type SearchAllRentalsAtOnceInput, type SearchMapSearchInput, SearchMapSearchInputSchema, type SearchMapSearchOutput, type SearchMapSearchOutputItem, SearchMapSearchOutputSchema, type SearchSearchFieldOrderBy, SearchSearchFieldOrderBySchema, type SearchSearchFieldSort, SearchSearchFieldSortSchema, type SearchSearchInput, SearchSearchInputSchema, type SearchSearchOutput, SearchSearchOutputSchema, type SearchSearchPriceSort, SearchSearchPriceSortSchema, type SearchSearchRandomSort, SearchSearchRandomSortSchema, type SearchSearchRatingSort, SearchSearchRatingSortSchema, type SearchSearchSort, SearchSearchSortSchema, type SearchSortDirection, SearchSortDirectionSchema, type SelectableInsuranceOptionOutput, type SelectedInsuranceInformationInput, type SubmittableBookingPaymentOption, type TranslationOverrides, UnknownAdditionalService, type V0OpenApiClientOptions, type V0OpenApiOperationId, type V0OpenApiOperationRequest, type V0OpenApiOperationResponse, type V1OpenApiClientOptions, type components as V1OpenApiComponents, type V1OpenApiOperationId, type V1OpenApiOperationRequest, type V1OpenApiOperationResponse, type operations as V1OpenApiOperations, type paths as V1OpenApiPaths, type V9InitialAvailabilityOutput, type V9OnlyCustomAttributeInput, type V9PropertyHighlightDataAttribute, type V9PropertyHighlightSourceInput, type V9PropertyHighlightSourceRegistry, type V9PropertyHighlightSourcesInput, type V9ReviewCriterion, type V9ReviewCriterionDataAttribute, type V9ReviewsOptions, type V9SearchAllRentalsAtOnceInput, type V9SearchPagesInput, type V9SearchSearchInput, type V9SearchSearchOutput, type V9SearchSearchOutputItem, type V9SearchSearchSort, type VofficeFacilityDataAttribute, type VofficeFacilityDataAttributes, type VofficeFeedbackDataAttribute, type VofficeFeedbackDataAttributes, type VofficeImageDataAttribute, type VofficeImageDataAttributes, type VofficeOfferDataAttribute, type VofficeOfferDataAttributes, type VofficePriceDataAttribute, type VofficePriceDataAttributes, type VofficeRatingDataAttribute, type VofficeRatingDataAttributes, type VofficeServiceDataAttribute, type VofficeServiceDataAttributes, type VofficeTotalRatingDataAttribute, type VofficeTotalRatingDataAttributes, type VofficeUnitDataAttribute, type VofficeUnitDataAttributes, type WebsiteSDK, type WebsiteSDKAllRentalsAtOnce, type WebsiteSDKConfig, type WebsiteSDKOptions, type WebsiteSDKSharedLive, type WebsiteSDKSharedStatic, type WebsiteSDKV10, type WebsiteSDKV10AllRentalsAtOnce, type WebsiteSDKV10AllRentalsAtOnceLive, type WebsiteSDKV10Live, type WebsiteSDKV10Static, type WebsiteSDKV9, type WebsiteSDKV9AllRentalsAtOnce, type WebsiteSDKV9AllRentalsAtOnceLive, type WebsiteSDKV9Live, defineWebsiteSDKOptions as defineCMSSDKOptions, defineCustomAttributes, defineCustomAttributesFromUnknown, fetchCustomAttributeCatalog, parseCustomAttributeCatalog, validateContactSubmitInput };
7670
+ export { AdditionalServiceLimitExceeded, type AvailabilityGetInitialAvailabilityInput, type AvailabilityGetInitialAvailabilityOutput, type AvailabilityGetStartDateSelectedAvailabilityInput, type AvailabilityGetStartDateSelectedAvailabilityOutput, type BackendKind, type BookingBankTransferDetails, type BookingBookInput, type BookingBookOutput, type BookingPayment, type BookingPaymentAlternative, type BookingPaymentOption, type BookingPaymentScheduleItem, type BookingPaymentScheduleKind, type BookingPaymentScheduleLine, CMSError, type ContactSubmitInput, type ContactSubmitOutput, type ContactSubmitValidationIssue, type ContactSubmitValidationIssueCode, CoreSDKError, type CustomAttributeCatalog, type CustomAttributeCatalogDefinitionInput, type CustomAttributeCatalogInput, CustomAttributeCatalogSchema, type CustomAttributeCategoryKey, type CustomAttributeFilterCategoryKey, type CustomAttributeFilterDefinition, type CustomAttributeFilterExpression, type CustomAttributeFilterLabel, type CustomAttributeFilterNumericBounds, type CustomAttributeFilterOption, type CustomAttributeOverridesInput, type CustomAttributeRegistry, type CustomAttributeRegistrySnapshot, type CustomAttributeSelection, type CustomDataAttribute, type DataAttribute, type DocumentsGetTermsAndPrivacyPolicyInput, type DocumentsGetTermsAndPrivacyPolicyOutput, type FilterGetFiltersInput, type FilterGetFiltersOutput, type GeoLocation, type GuestQuote, type GuestQuoteInput, type GuestQuoteInsurance, type GuestQuoteResult, GuestQuoteSchema, type GuestQuoteSelectionResult, type GuestQuoteVoucher, type ImageData, type InsuranceBookingOutput, type InsuranceCustomerInformationInput, type InsurancePaymentInformationInput, type InsurancePaymentOptionOutput, type InsurancePreContractOutput, InvalidAdditionalServiceQuantity, type KnownVofficeFacilityData, type KnownVofficeFacilityDataAttribute, type KnownVofficeFeedbackData, type KnownVofficeFeedbackDataAttribute, type KnownVofficeImageData, type KnownVofficeImageDataAttribute, type KnownVofficeOfferData, type KnownVofficeOfferDataAttribute, type KnownVofficePriceData, type KnownVofficePriceDataAttribute, type KnownVofficeRatingData, type KnownVofficeRatingDataAttribute, type KnownVofficeServiceData, type KnownVofficeServiceDataAttribute, type KnownVofficeTotalRatingData, type KnownVofficeTotalRatingDataAttribute, type KnownVofficeUnitData, type KnownVofficeUnitDataAttribute, type Locale, LocaleSchema, type ParsedJsonData, type ParsedVofficeFacilityData, type ParsedVofficeFeedbackData, type ParsedVofficeImageData, type ParsedVofficeOfferData, type ParsedVofficePriceData, type ParsedVofficeRatingData, type ParsedVofficeServiceData, type ParsedVofficeTotalRatingData, type ParsedVofficeUnitData, type QuoteQuoteInput, type QuoteQuoteOutput, type RentalGetRentalsInput, type RentalGetRentalsOutput, type RentalHighlightPrioritizationKey, type RentalPropertyHighlightPrioritizationKey, type ResolvedCustomAttribute, type ResolvedV9PropertyHighlightSource, SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS, type SearchAllRentalsAtOnceInput, type SearchMapSearchInput, SearchMapSearchInputSchema, type SearchMapSearchOutput, type SearchMapSearchOutputItem, SearchMapSearchOutputSchema, type SearchSearchFieldOrderBy, SearchSearchFieldOrderBySchema, type SearchSearchFieldSort, SearchSearchFieldSortSchema, type SearchSearchInput, SearchSearchInputSchema, type SearchSearchOutput, SearchSearchOutputSchema, type SearchSearchPriceSort, SearchSearchPriceSortSchema, type SearchSearchRandomSort, SearchSearchRandomSortSchema, type SearchSearchRatingSort, SearchSearchRatingSortSchema, type SearchSearchSort, SearchSearchSortSchema, type SearchSortDirection, SearchSortDirectionSchema, type SelectableInsuranceOptionOutput, type SelectedInsuranceInformationInput, type SubmittableBookingPaymentOption, type TranslationOverrides, UnknownAdditionalService, type V0OpenApiClientOptions, type V0OpenApiOperationId, type V0OpenApiOperationRequest, type V0OpenApiOperationResponse, type V1OpenApiClientOptions, type components as V1OpenApiComponents, type V1OpenApiOperationId, type V1OpenApiOperationRequest, type V1OpenApiOperationResponse, type operations as V1OpenApiOperations, type paths as V1OpenApiPaths, type V9EndDateOption, type V9InitialAvailabilityOutput, type V9OnlyCustomAttributeInput, type V9PropertyHighlightDataAttribute, type V9PropertyHighlightSourceInput, type V9PropertyHighlightSourceRegistry, type V9PropertyHighlightSourcesInput, type V9RentalsGetRentalsByIdsInput, type V9ReviewCriterion, type V9ReviewCriterionDataAttribute, type V9ReviewsOptions, type V9SearchAllRentalsAtOnceInput, type V9SearchPagesInput, type V9SearchSearchInput, type V9SearchSearchOutput, type V9SearchSearchOutputItem, type V9SearchSearchSort, type V9StartDateSelectedAvailabilityOutput, type V9VoucherValidateInput, type V9VoucherValidateOutput, type V9VoucherValidityReason, type VofficeFacilityDataAttribute, type VofficeFacilityDataAttributes, type VofficeFeedbackDataAttribute, type VofficeFeedbackDataAttributes, type VofficeImageDataAttribute, type VofficeImageDataAttributes, type VofficeOfferDataAttribute, type VofficeOfferDataAttributes, type VofficePriceDataAttribute, type VofficePriceDataAttributes, type VofficeRatingDataAttribute, type VofficeRatingDataAttributes, type VofficeServiceDataAttribute, type VofficeServiceDataAttributes, type VofficeTotalRatingDataAttribute, type VofficeTotalRatingDataAttributes, type VofficeUnitDataAttribute, type VofficeUnitDataAttributes, type WebsiteSDK, type WebsiteSDKAllRentalsAtOnce, type WebsiteSDKConfig, type WebsiteSDKOptions, type WebsiteSDKSharedLive, type WebsiteSDKSharedStatic, type WebsiteSDKV10, type WebsiteSDKV10AllRentalsAtOnce, type WebsiteSDKV10AllRentalsAtOnceLive, type WebsiteSDKV10Live, type WebsiteSDKV10Static, type WebsiteSDKV9, type WebsiteSDKV9AllRentalsAtOnce, type WebsiteSDKV9AllRentalsAtOnceLive, type WebsiteSDKV9Live, defineWebsiteSDKOptions as defineCMSSDKOptions, defineCustomAttributes, defineCustomAttributesFromUnknown, fetchCustomAttributeCatalog, parseCustomAttributeCatalog, validateContactSubmitInput };
package/dist/index.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { $ as SearchPropertiesResponseSchema, A as ErgoBankSchema, At as getStartDateSelectedAvailabilityEffect, B as OnOfficeUnitCollectionResponseSchema, Bt as submitPaymentOption, C as DocumentResourceResponseSchema, Ct as bookInsuranceEffect, D as DocumentSummarySchema, Dt as getFiltersEffect, E as DocumentStatusUpdateRequestSchema, Et as getBankTransferDetailsEffect, F as ErgoPlanSearchRequestSchema, Ft as searchEffect, G as QuotePricesPayloadSchema, H as PaymentScheduleItemSchema, Ht as defineWebsiteSDKOptions, I as ErgoPolicyNumberRequestSchema, It as selectCancellationPolicyEffect, J as QuoteServiceSchema, K as QuotePricesResponseSchema, L as ErgoReadPreContractRequestSchema, Lt as selectInsuranceEffect, M as ErgoCommonFieldsSchema, Mt as mapSearchEffect, N as ErgoCreatePreContractRequestSchema, Nt as quoteEffect, O as DocumentTypeSchema, Ot as getInitialAvailabilityEffect, P as ErgoPersonSchema, Pt as removeAdditionalServiceEffect, Q as RoomImageSchema, R as ErgoTripAndCustomerRequestSchema, Rt as selectInsurancePaymentEffect, S as DocumentCollectionResponseSchema, St as bookEffect, T as DocumentStatusSchema, Tt as createInsurancePreContractEffect, U as PaymentScheduleSchema, Ut as defineV9PropertyHighlightSources, V as OnOfficeUnitSchema, Vt as submitPaymentOptionEffect, W as QuoteLineSchema, Wt as defineV9PropertyHighlightSourcesFromUnknown, X as RawVofficeObjectSchema, Y as RawObjectResponseSchema, Z as RegionListResponseSchema, _ as ApiEnvelopeBaseSchema, _t as V1_BASE_URL, at as SetupResponseSchema, b as CurrentMemberResponseSchema, bt as decodeV1OperationResponse, ct as TileTagSchema, d as makeV0OpenApiClientFetchLive, dt as UnitIdsResponseSchema, et as ServiceBeonDataSchema, f as makeV0OpenApiClientLive, ft as UnitListItemSchema, g as makeV1OpenApiClientLive, gt as UnitServicePriceSchema, h as makeV1OpenApiClientFetchLive, ht as UnitResponseSchema, it as SetupDataSchema, j as ErgoBookRequestSchema, jt as getTermsAndPrivacyPolicyEffect, k as ErgoAddressSchema, kt as getRentalsEffect, l as V0OpenApiClient, lt as TravelInsuranceBookingSchema, m as V1OpenApiClientError, mt as UnitOfferSchema, nt as ServiceLimitSchema, ot as TileCollectionResponseSchema, p as V1OpenApiClient, pt as UnitListResponseSchema, q as QuoteSchema, rt as ServiceListResponseSchema, st as TileSchema, t as createWebsiteSDK, tt as ServiceImageSchema, u as V0OpenApiClientError, ut as TravelInsuranceBookingStoreRequestSchema, v as CalendarDaySchema, vt as V1_OPERATIONS, w as DocumentResourceSchema, wt as clearAdditionalServicesEffect, x as CustomerUnitSummarySchema, xt as addAdditionalServiceEffect, y as CalendarResponseSchema, yt as VideoResponseSchema, z as FacilityListResponseSchema, zt as submitContactEffect } from "./client-EtS0Qm3i.mjs";
1
+ import { $ as RawObjectResponseSchema, A as DocumentStatusUpdateRequestSchema, At as getBankTransferDetailsEffect, B as ErgoPolicyNumberRequestSchema, Bt as selectCancellationPolicyEffect, C as CalendarResponseSchema, Ct as VideoResponseSchema, D as DocumentResourceResponseSchema, Dt as bookInsuranceEffect, E as DocumentCollectionResponseSchema, Et as bookEffect, F as ErgoBookRequestSchema, Ft as getTermsAndPrivacyPolicyEffect, G as OnOfficeUnitSchema, Gt as submitPaymentOptionEffect, H as ErgoTripAndCustomerRequestSchema, Ht as selectInsurancePaymentEffect, I as ErgoCommonFieldsSchema, It as mapSearchEffect, J as QuoteLineSchema, Jt as defineV9PropertyHighlightSourcesFromUnknown, K as PaymentScheduleItemSchema, Kt as defineWebsiteSDKOptions, L as ErgoCreatePreContractRequestSchema, Lt as quoteEffect, M as DocumentTypeSchema, Mt as getInitialAvailabilityEffect, N as ErgoAddressSchema, Nt as getRentalsEffect, O as DocumentResourceSchema, Ot as clearAdditionalServicesEffect, P as ErgoBankSchema, Pt as getStartDateSelectedAvailabilityEffect, Q as QuoteServiceSchema, R as ErgoPersonSchema, Rt as removeAdditionalServiceEffect, S as CalendarDaySchema, St as V1_OPERATIONS, T as CustomerUnitSummarySchema, Tt as addAdditionalServiceEffect, U as FacilityListResponseSchema, Ut as submitContactEffect, V as ErgoReadPreContractRequestSchema, Vt as selectInsuranceEffect, W as OnOfficeUnitCollectionResponseSchema, Wt as submitPaymentOption, X as QuotePricesResponseSchema, Y as QuotePricesPayloadSchema, Z as QuoteSchema, _ as V1OpenApiClient, _t as UnitListResponseSchema, at as ServiceImageSchema, b as makeV1OpenApiClientLive, bt as UnitServicePriceSchema, ct as SetupDataSchema, dt as TileSchema, et as RawVofficeObjectSchema, ft as TileTagSchema, g as makeV0OpenApiClientLive, gt as UnitListItemSchema, h as makeV0OpenApiClientFetchLive, ht as UnitIdsResponseSchema, it as ServiceBeonDataSchema, j as DocumentSummarySchema, jt as getFiltersEffect, k as DocumentStatusSchema, kt as createInsurancePreContractEffect, lt as SetupResponseSchema, m as V0OpenApiClientError, mt as TravelInsuranceBookingStoreRequestSchema, nt as RoomImageSchema, ot as ServiceLimitSchema, p as V0OpenApiClient, pt as TravelInsuranceBookingSchema, q as PaymentScheduleSchema, qt as defineV9PropertyHighlightSources, rt as SearchPropertiesResponseSchema, st as ServiceListResponseSchema, t as createWebsiteSDK, tt as RegionListResponseSchema, ut as TileCollectionResponseSchema, v as V1OpenApiClientError, vt as UnitOfferSchema, w as CurrentMemberResponseSchema, wt as decodeV1OperationResponse, x as ApiEnvelopeBaseSchema, xt as V1_BASE_URL, y as makeV1OpenApiClientFetchLive, yt as UnitResponseSchema, z as ErgoPlanSearchRequestSchema, zt as searchEffect } from "./client-CKVwzIQ4.mjs";
2
2
  import { AdditionalServiceLimitExceeded, CoreSDKError, CoreSDKError as CMSError, CustomAttributeCatalogSchema, GuestQuoteSchema, InvalidAdditionalServiceQuantity, LocaleSchema, SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS, SearchMapSearchInputSchema, SearchMapSearchOutputSchema, SearchSearchFieldOrderBySchema, SearchSearchFieldSortSchema, SearchSearchInputSchema, SearchSearchOutputSchema, SearchSearchPriceSortSchema, SearchSearchRandomSortSchema, SearchSearchRatingSortSchema, SearchSearchSortSchema, SearchSortDirectionSchema, UnknownAdditionalService, defineCustomAttributes, defineCustomAttributesFromUnknown, fetchCustomAttributeCatalog, parseCustomAttributeCatalog, validateContactSubmitInput } from "@v-office/sdk-core";
3
3
  //#region codegen/v9/heuristic-generation/public-api.ts
4
4
  const customDataAttribute = (name) => name;
@@ -4,6 +4,8 @@
4
4
 
5
5
  Release notes of `@v-office/website-sdk`, newest first. Each version has its own directory.
6
6
 
7
+ - `versions/2.30.0/CHANGELOG.md`: release notes for 2.30.0
8
+ - `versions/2.29.0/CHANGELOG.md`: release notes for 2.29.0
7
9
  - `versions/2.28.1/CHANGELOG.md`: release notes for 2.28.1
8
10
  - `versions/2.28.0/CHANGELOG.md`: release notes for 2.28.0
9
11
  - `versions/2.27.0/CHANGELOG.md`: release notes for 2.27.0
@@ -4,6 +4,8 @@
4
4
 
5
5
  Migration guides of `@v-office/website-sdk`, newest first. Apply them in order when skipping versions.
6
6
 
7
+ - `versions/2.30.0/MIGRATION.md`: Migration: 2.29.0 to 2.30.0
8
+ - `versions/2.29.0/MIGRATION.md`: Migration: 2.28.1 to 2.29.0
7
9
  - `versions/2.28.1/MIGRATION.md`: Migration: 2.28.0 to 2.28.1
8
10
  - `versions/2.28.0/MIGRATION.md`: Migration: 2.27.0 to 2.28.0
9
11
  - `versions/2.27.0/MIGRATION.md`: Migration: 2.26.0 to 2.27.0
@@ -7,10 +7,10 @@ workflow performs the coordinated core and website bumps.
7
7
  Use this directory as the consumer-facing reference for the package:
8
8
 
9
9
  - `creation.md`: SDK construction, config, options, and CLI config files.
10
- - `rentals.md`: `sdk.static.rentals.getRentals`.
10
+ - `rentals.md`: `sdk.static.rentals.getRentals` and, on v9, `sdk.live.rentals.getRentalsByIds`.
11
11
  - `filter.md`: `sdk.static.filter.getFilters`.
12
12
  - `custom-attributes.md`: custom attribute catalog, configuration, per-backend behaviour, and the v9-to-v10 move.
13
- - `search.md`: `sdk.live.search.search` and, on v9, `sdk.live.search.searchPages`.
13
+ - `search.md`: `sdk.live.search.search`, vouchers, and, on v9, `sdk.live.search.searchPages`, Hub filters, and `sdk.live.voucher.validate`.
14
14
  - `availability.md`: date-picker availability flows.
15
15
  - `quote.md`: quote booking-card modifiers, additional services, cancellation policy, and insurance flows.
16
16
  - `booking.md`: booking, payment option submission, and
@@ -110,6 +110,7 @@ website-sdk --backend v10 rentals --locale de-DE
110
110
  website-sdk --backend v9 filters --locale en-US
111
111
  website-sdk --backend v10 search --locale de-DE --query "adults=2"
112
112
  website-sdk --backend v10 search --locale de-DE --query "adults=2" --sort '{"by":"field","orderBy":{"label":"ASC"}}'
113
+ website-sdk --backend v9 hub-filters request --object-group
113
114
  ```
114
115
 
115
116
  Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced
@@ -107,9 +107,9 @@ From 2.18.0, available dates that cannot be used as a start date also expose a
107
107
  price when the source supplies one. The same rule applies to v10 initial
108
108
  availability. `formattedPrice` remains `null` when the date is unavailable or
109
109
  the source supplies no numeric price.
110
- Start-date-selected availability does not include calendar prices.
110
+ v10 start-date-selected availability does not include calendar prices.
111
111
 
112
- When no successful unit lookup is cached, a v9 initial-availability request loads
112
+ When no successful unit lookup is cached, a v9 availability request loads
113
113
  the calendar and a unit record. Successful unit responses are cached by unit ID
114
114
  for the lifetime of the SDK instance, including responses without a currency.
115
115
  Failed unit requests are not cached and are retried on the next call. A missing
@@ -122,6 +122,26 @@ No new configuration is required. The currency lookup uses the existing
122
122
  See `versions/2.18.0/CHANGELOG.md` and
123
123
  `versions/2.18.0/MIGRATION.md`.
124
124
 
125
+ ### Legacy v9 Prices by Length of Stay
126
+
127
+ From 2.30.0, v9 calendar prices follow the rental's rates by number of nights.
128
+ Each night is priced by its own season, as the quote does.
129
+
130
+ - `getInitialAvailability` prices each day at the rate for the minimum stay
131
+ that applies from that day.
132
+ - `getStartDateSelectedAvailability` returns `formattedPrice` on every day
133
+ (`V9StartDateSelectedAvailabilityOutput`). On a day that can be the end date
134
+ it is the price of the last night of a stay from the selected start date to
135
+ that day, at the rate for that number of nights. On all other days it is
136
+ `null`.
137
+
138
+ When the rental's price list cannot be loaded or has no rate for a day, both
139
+ calls use the calendar price described above. The price list is cached per
140
+ rental for five minutes for the lifetime of the SDK instance.
141
+
142
+ See `versions/2.30.0/CHANGELOG.md` and
143
+ `versions/2.30.0/MIGRATION.md`.
144
+
125
145
  ### Legacy v9 Occupancy Limits
126
146
 
127
147
  From 2.28.0, v9 initial availability reads its occupancy limits from the same
@@ -49,10 +49,21 @@ const sdk = createWebsiteSDK({
49
49
  imageProxyBaseUrl: "https://images.example.com",
50
50
  rentalDataAttributes: ["name", "description"],
51
51
  facilityObjectGroupRelationAttributeId: 18962,
52
+ rentalScopePropertyKind: "objectGroup",
52
53
  },
53
54
  });
54
55
  ```
55
56
 
57
+ `rentalScopePropertyKind` is an optional v9-only setting that says what
58
+ `rentalScope.propertyId` names: `"facility"` (the default), a facility, or
59
+ `"objectGroup"`, a vOffice object group. It does not change `rental.property`, which
60
+ is always a facility. See [Rental Scope](#rental-scope).
61
+
62
+ `rentalIdsSearch` is an optional v9-only setting, `false` by default. With `true`, v9
63
+ search accepts `rentalIdsIn` (for example a favourites search). It needs the Hub
64
+ filter `voffice_id`; see
65
+ [v9: Favourites As A Search Filter](search.md#v9-favourites-as-a-search-filter).
66
+
56
67
  `facilityObjectGroupRelationAttributeId` is an optional v9-only compatibility
57
68
  setting for tenants whose units are associated with facilities through vOffice
58
69
  object groups instead of the native facility relation. Its numeric value `N`
@@ -193,8 +204,22 @@ const options = defineWebsiteSDKOptions({
193
204
 
194
205
  `propertyId` is a unified SDK option:
195
206
 
196
- - `v9` static rentals are filtered by `voffice_facility_id`.
197
- - `v9` live search maps it to the generated `VofficeFilter.falicityid` field.
207
+ - `v9` follows the config `rentalScopePropertyKind`:
208
+ - `"facility"` or unset: `propertyId` is the facility ID that `rental.property.id`
209
+ shows. Static rentals are filtered by it.
210
+ - `"objectGroup"`: `propertyId` is a vOffice object group ID. Static rentals keep
211
+ the members of the group.
212
+ - Search, `searchPages` and `mapSearch` apply the scope through the Hub filter
213
+ `facility_scope` or `objectGroup_scope`, with and without a period. The static
214
+ `getRentals` fails the build until the be-on! Hub has that entry, and names the
215
+ missing key. Run `website-sdk hub-filters request`; the user adds the entries in
216
+ the be-on! Hub, see [v9: Hub Filters](search.md#v9-hub-filters).
217
+ - `getRentals` fails the build for a facility scope next to
218
+ `facilityObjectGroupRelationAttributeId`: the listings would use the facilities
219
+ derived from object groups, the search the facility stored on each rental. If the
220
+ facilities are maintained on the rentals in vOffice, remove
221
+ `facilityObjectGroupRelationAttributeId`; otherwise scope by `"objectGroup"`.
222
+ - `propertyId` must be a positive decimal integer up to 2147483647.
198
223
  - `v10` static rentals and live search map it to the generated `rentals_RentalSummaryFilter.propertyId` field.
199
224
 
200
225
  The scope is always applied internally and is not returned by `static.filter.getFilters(...)`. Use it for website-level or tenant-level constraints.
@@ -262,8 +287,9 @@ Supported sources:
262
287
  active backend, and no generated leaf is committed unless all leaves are valid.
263
288
  Nested compositions are rejected while recursive expansion is unsupported.
264
289
 
265
- For a new v9 `backendFilter` key, ask someone at be-on! with Hub access to add or
266
- confirm the backend filter before configuring it in the SDK.
290
+ For a new v9 `backendFilter` key, the Hub filter must exist first; see
291
+ [v9: Hub Filters](search.md#v9-hub-filters). The keys `voffice_id`, `facility_scope` and
292
+ `objectGroup_scope` belong to the SDK: a v9 `backendFilter` cannot use them.
267
293
 
268
294
  Exposure:
269
295
 
@@ -309,6 +335,11 @@ Example `website-sdk-config.v10.json`:
309
335
  }
310
336
  ```
311
337
 
338
+ With environment configuration, the CLI reads the v9 settings `rentalScopePropertyKind`
339
+ and `rentalIdsSearch` from the optional `HUB_RENTAL_SCOPE_PROPERTY_KIND`
340
+ (`facility` or `objectGroup`) and `HUB_RENTAL_IDS_SEARCH` (`true` or `false`). Without
341
+ them, it treats a rental scope as a facility scope and keeps `rentalIdsIn` off.
342
+
312
343
  Example `website-sdk-options.json`:
313
344
 
314
345
  ```json
@@ -390,8 +390,8 @@ These are **not** custom attributes and stay in `customAttributeFilterDefinition
390
390
  backend with its configured value.
391
391
 
392
392
  Compositions may reference stable v9 built-ins directly; `backendFilter` is only for
393
- additional v9 keys. SDK configuration does not create those keys in Hub; ask someone
394
- at be-on! with Hub access to add or confirm the filter before configuring it.
393
+ additional v9 keys. SDK configuration does not create those keys in Hub: they are added
394
+ there first; see [v9: Hub Filters](search.md#v9-hub-filters).
395
395
 
396
396
  ```ts
397
397
  const options = defineWebsiteSDKOptions({
@@ -120,9 +120,11 @@ when it has a public filter and the selected backend can execute it. v9 has no
120
120
  custom-attribute search path, so v9 never advertises one; see `custom-attributes.md`.
121
121
 
122
122
  Backend filters and compositions come from `customAttributeFilterDefinitions`.
123
- SDK configuration cannot create a Hub filter: for another v9 key, first ask someone
124
- at be-on! with Hub access to add or confirm it, then configure that key as a
125
- `backendFilter`.
123
+ SDK configuration cannot create a Hub filter: for another v9 key, the entry is added
124
+ to the be-on! Hub first, then you configure that key as a `backendFilter`. Without
125
+ the Hub entry, the filter does nothing. See [v9: Hub Filters](search.md#v9-hub-filters)
126
+ for the fixed keys (object group, facility, special offers) and for
127
+ `website-sdk hub-filters request`.
126
128
 
127
129
  ```json
128
130
  {
@@ -62,7 +62,7 @@ Sample:
62
62
  ```
63
63
 
64
64
  Dates are local dates formatted as `YYYY-MM-DD`. For `v9`, `rentalId` must be a numeric vOffice unit id.
65
- Both backends accept `voucher` on quote and booking flows. On `v10`, applied voucher and non-voucher modifiers can be exposed through the booking-card fields described below. `v9` reflects voucher effects in quoted totals but does not expose booking-card modifier details.
65
+ Both backends accept `voucher` on quote and booking flows. On `v9`, `sdk.live.voucher.validate` checks a code before the quote; see [Vouchers](search.md#vouchers). On `v10`, applied voucher and non-voucher modifiers can be exposed through the booking-card fields described below. `v9` reflects voucher effects in quoted totals but does not expose booking-card modifier details.
66
66
 
67
67
  ## Output
68
68
 
@@ -10,6 +10,8 @@ const rentals = await sdk.static.rentals.getRentals({ locale: "de-DE" });
10
10
 
11
11
  The service is implemented for both `v9` and `v10` backends and returns one normalized item per rental.
12
12
 
13
+ On v9, `getRentals` fails when the site sets a rental scope or `rentalIdsSearch: true` and the be-on! Hub lacks the filter the search needs. The error names the missing key; see [Rental Scope](creation.md#rental-scope). For a favourites page, use `sdk.live.rentals.getRentalsByIds` (see [Legacy v9 Rentals By ID](#legacy-v9-rentals-by-id)).
14
+
13
15
  ## Input
14
16
 
15
17
  ```ts
@@ -211,6 +213,14 @@ several facilities fail the static rentals request instead of selecting an
211
213
  arbitrary property. The request also fails when no facility has a usable
212
214
  configured relation value.
213
215
 
216
+ A facility `rentalScope` does not work with this mode: the listings would use
217
+ the facilities derived from object groups, while the search filters by the
218
+ facility stored on each unit. `getRentals` fails the build for that
219
+ combination. If the facilities are maintained on the units in vOffice, remove
220
+ `facilityObjectGroupRelationAttributeId`. Otherwise set
221
+ `rentalScopePropertyKind: "objectGroup"` and use the object group ID as
222
+ `rentalScope.propertyId`.
223
+
214
224
  The relation attribute may contain positive numeric IDs as numbers, strings,
215
225
  localized string records, arrays, or strings separated by whitespace, commas,
216
226
  or semicolons. The association is locale-independent. The configured GraphQL
@@ -419,6 +429,26 @@ A feedback with neither rating nor text is never an item. `summary.rating` and
419
429
  covers the included items. When no included item has a rating, `reviews` has
420
430
  `items` and no `summary`. A text answer to a `text` criterion counts as text.
421
431
 
432
+ ## Legacy v9 Rentals By ID
433
+
434
+ `sdk.live.rentals.getRentalsByIds` loads the rentals with the given IDs, for example the
435
+ favourites a visitor saved in the browser. It needs no Hub entry, and it is v9 only:
436
+
437
+ ```ts
438
+ const rentalIds: string[] = JSON.parse(localStorage.getItem("favoredRentalIDs") ?? "[]");
439
+
440
+ const rentals = await sdk.live.rentals.getRentalsByIds({ locale: "de-DE", rentalIds });
441
+ ```
442
+
443
+ - It returns the same items as `getRentals`, reviews included.
444
+ - The result keeps the order of `rentalIds` and drops duplicates.
445
+ - An ID that is unknown, not a positive whole number, or outside the rental scope is
446
+ left out without an error. The browser may hold IDs of rentals that no longer exist.
447
+ - An empty list returns an empty array.
448
+
449
+ To combine favourites with the search filters, see
450
+ [v9: Favourites As A Search Filter](search.md#v9-favourites-as-a-search-filter).
451
+
422
452
  ## Configuration
423
453
 
424
454
  `v9` config:
@@ -531,6 +561,12 @@ website-sdk --backend v9 rentals --locale en-US
531
561
  website-sdk --backend v10 rentals --locale de-DE
532
562
  ```
533
563
 
564
+ Fetch v9 rentals by ID:
565
+
566
+ ```sh
567
+ website-sdk --backend v9 rentals-by-ids --locale en-US --rental-ids 12,34
568
+ ```
569
+
534
570
  Use files instead of environment variables:
535
571
 
536
572
  ```sh