@wix/auto_sdk_bookings_catalog-search 1.0.0 → 1.0.2

package/build/cjs/index.d.ts

@@ -2,7 +2,7 @@ interface CatalogSearchResult {
     /** @format GUID */
     _id?: string;
 }
-interface QueryServicesByAvailabilityRequest {
+interface QueryServicesByFiltersRequest {
     /**
      * Query against the service catalog — WQL filter, sort, and cursor paging.
      * Supports the same fields as QueryServices.
@@ -12,7 +12,7 @@ interface QueryServicesByAvailabilityRequest {
      * Availability and resource constraints applied on top of the service query.
      * When absent, no availability check is performed and all pre-filtered services are returned.
      */
-    availabilityFilter?: AvailabilityFilter;
+    serviceFilters?: ServiceFilters;
 }
 interface QueryV2 extends QueryV2PagingMethodOneOf {
     paging?: Paging;
@@ -60,7 +60,7 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface AvailabilityFilter {
+interface ServiceFilters {
     /**
      * Start of the availability window (ISO local date-time, e.g. "2024-03-25T09:00:00").
      * Must be provided together with local_end_date.
@@ -127,10 +127,18 @@ interface Attribute extends AttributeValueOneOf {
      * @maxLength 40
      */
     enumValue?: string;
-    /** Exact number value to match. */
-    numberValue?: number;
+    /**
+     * Inclusive number range to match. At least one bound must be present; min must not exceed max.
+     * To match an exact number, set min and max to the same value.
+     */
+    numberRangeValue?: NumberRange;
     /** Exact boolean value to match. */
     boolValue?: boolean;
+    /**
+     * Discrete set of numbers to match. At least one value must be present.
+     * A resource matches if its stored number equals any value in the set.
+     */
+    numberValues?: NumberValues;
     /**
      * ID of the attribute definition to filter by.
      * @format GUID
@@ -144,12 +152,35 @@ interface AttributeValueOneOf {
      * @maxLength 40
      */
     enumValue?: string;
-    /** Exact number value to match. */
-    numberValue?: number;
+    /**
+     * Inclusive number range to match. At least one bound must be present; min must not exceed max.
+     * To match an exact number, set min and max to the same value.
+     */
+    numberRangeValue?: NumberRange;
     /** Exact boolean value to match. */
     boolValue?: boolean;
+    /**
+     * Discrete set of numbers to match. At least one value must be present.
+     * A resource matches if its stored number equals any value in the set.
+     */
+    numberValues?: NumberValues;
 }
-interface QueryServicesByAvailabilityResponse {
+/** Inclusive numeric range filter. At least one bound must be present. */
+interface NumberRange {
+    /** Minimum value (inclusive). If absent, no lower bound is applied. */
+    min?: number | null;
+    /** Maximum value (inclusive). If absent, no upper bound is applied. */
+    max?: number | null;
+}
+/** Discrete set of numeric values to match. At least one value must be present. */
+interface NumberValues {
+    /**
+     * Numbers to match against. A resource matches if its stored number equals any entry.
+     * @maxSize 10
+     */
+    values?: number[];
+}
+interface QueryServicesByFiltersResponse {
     /** Services matching the query, each enriched with availability data. */
     results?: ServiceWithAvailability[];
     /**
@@ -428,6 +459,13 @@ interface Payment extends PaymentRateOneOf {
      * Required when: `rateType` is `VARIED`
      */
     varied?: VariedPayment;
+    /**
+     * Subscription pricing details for the service. Supported for course services only.
+     * The business charges recurring monthly payments instead of a one-time fee.
+     *
+     * Required when: `rateType` is `SUBSCRIPTION`.
+     */
+    subscription?: SubscriptionPayment;
     /** The rate the customer is expected to pay for the service. */
     rateType?: RateTypeWithLiterals;
     /** The payment options a customer can use to pay for the service. */
@@ -479,6 +517,13 @@ interface PaymentRateOneOf {
      * Required when: `rateType` is `VARIED`
      */
     varied?: VariedPayment;
+    /**
+     * Subscription pricing details for the service. Supported for course services only.
+     * The business charges recurring monthly payments instead of a one-time fee.
+     *
+     * Required when: `rateType` is `SUBSCRIPTION`.
+     */
+    subscription?: SubscriptionPayment;
 }
 declare enum RateType {
     /** The service has a fixed price. */
@@ -488,10 +533,15 @@ declare enum RateType {
     /** This service is offered with a set of different prices based on different terms. */
     VARIED = "VARIED",
     /** This service is offered free of charge. */
-    NO_FEE = "NO_FEE"
+    NO_FEE = "NO_FEE",
+    /**
+     * The service charges recurring monthly payments. Supported for course services only.
+     * @documentationMaturity preview
+     */
+    SUBSCRIPTION = "SUBSCRIPTION"
 }
 /** @enumType */
-type RateTypeWithLiterals = RateType | 'FIXED' | 'CUSTOM' | 'VARIED' | 'NO_FEE';
+type RateTypeWithLiterals = RateType | 'FIXED' | 'CUSTOM' | 'VARIED' | 'NO_FEE' | 'SUBSCRIPTION';
 interface FixedPayment {
     /**
      * The fixed price required to book the service.
@@ -573,24 +623,38 @@ interface VariedPayment {
     fullUpfrontPaymentAllowed?: boolean | null;
 }
 interface SubscriptionPayment {
-    /** Amount charged each billing cycle. */
+    /**
+     * Base price charged per billing cycle before tax and discounts.
+     * The actual amount charged may differ after checkout applies tax and discounts.
+     */
     amountPerBillingCycle?: Money;
-    /** Billing frequency used for recurring subscription charges. */
+    /**
+     * Billing frequency for recurring subscription charges.
+     * Reflected as `billingFrequency` in the booking's subscription info.
+     *
+     * Currently supports `MONTHLY` only.
+     */
     frequency?: FrequencyTypeWithLiterals;
     /**
-     * Total number of recurring payments in the subscription.
-     * Value must be greater than `1`.
-     * Required when: `rateType` is `SUBSCRIPTION`
+     * Total number of billing cycles in the subscription. For example, `12` for a 12-month subscription with monthly payments.
+     * Reflected as `totalCycles` in the booking's subscription info.
+     *
+     * Required when: `rateType` is `SUBSCRIPTION`.
      * @min 2
      */
     totalPayments?: number | null;
-    /** When the first recurring payment is charged. */
+    /** Determines when the first billing cycle payment is charged. Used together with `recurringStartDate` to define the subscription billing schedule. */
     firstChargeDate?: FirstChargeDateTypeWithLiterals;
     /**
-     * Date and time when recurring payments start in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * Date and time when recurring billing starts.
+     *
+     * When `firstChargeDate` is `CHECKOUT`, the first charge occurs at checkout and subsequent billing cycles start from this date.
+     *
      * When `firstChargeDate` is `SCHEDULED`, the first charge occurs on this date.
-     * When `firstChargeDate` is `CHECKOUT`, the first charge occurs at checkout and recurring billing begins on this date.
-     * Required when: `rateType` is `SUBSCRIPTION`. Sets the future billing cycle dates.
+     *
+     * Customers who book after recurring billing starts are billed for the remaining billing cycles only.
+     *
+     * Required when: `rateType` is `SUBSCRIPTION`.
      */
     recurringStartDate?: Date | null;
     /**
@@ -607,15 +671,15 @@ interface SubscriptionPayment {
     fullUpfrontPayment?: FullUpfrontPayment;
 }
 declare enum FrequencyType {
-    /** Payment is charged once every month. */
+    /** Billing cycle repeats once per month. */
     MONTHLY = "MONTHLY"
 }
 /** @enumType */
 type FrequencyTypeWithLiterals = FrequencyType | 'MONTHLY';
 declare enum FirstChargeDateType {
-    /** Charge the first billing cycle at checkout. */
+    /** The first billing cycle is charged at checkout. Recurring billing continues from the `recurringStartDate`. */
     CHECKOUT = "CHECKOUT",
-    /** Charge the first billing cycle on the `recurringStartDate`. */
+    /** The first billing cycle is charged on the `recurringStartDate`. */
     SCHEDULED = "SCHEDULED"
 }
 /** @enumType */
@@ -1768,7 +1832,7 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface QueryServicesByAvailabilityOptions {
+interface QueryServicesByFiltersOptions {
     /**
      * Query against the service catalog — WQL filter, sort, and cursor paging.
      * Supports the same fields as QueryServices.
@@ -1778,7 +1842,7 @@ interface QueryServicesByAvailabilityOptions {
      * Availability and resource constraints applied on top of the service query.
      * When absent, no availability check is performed and all pre-filtered services are returned.
      */
-    availabilityFilter?: AvailabilityFilter;
+    serviceFilters?: ServiceFilters;
 }
 
-export { type AddOnDetails, type AddOnGroup, AddOnPaymentOptions, type AddOnPaymentOptionsWithLiterals, type Address, type AddressLocation, type AddressStreetOneOf, type Attribute, type AttributeValueOneOf, type AvailabilityConstraints, type AvailabilityFilter, type BookAfterStartPolicy, type BookingPolicy, type BusinessLocationOptions, type CancellationFeePolicy, type CancellationPolicy, type CancellationWindow, type CancellationWindowFeeOneOf, type CatalogSearchResult, type Category, CompletionRequirement, type CompletionRequirementWithLiterals, type Conferencing, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomLocationOptions, type CustomOptions, type CustomPayment, type DailyConfig, type DiscountInfo, type Duration, type DurationRange, type DurationRangeConfigOneOf, type ExtendedFields, FirstChargeDateType, type FirstChargeDateTypeWithLiterals, type FixedPayment, type Form, type FormSettings, FrequencyType, type FrequencyTypeWithLiterals, type FullUpfrontPayment, type HourlyConfig, type IntakeFormPolicy, type Keyword, type LimitEarlyBookingPolicy, type LimitLateBookingPolicy, type Location, type LocationOptionsOneOf, LocationType, type LocationTypeWithLiterals, type Media, type MediaItem, type MediaItemItemOneOf, type Money, type OnlineBooking, type Paging, type ParticipantsPolicy, type Payment, type PaymentOptions, type PaymentRateOneOf, type PhoneCall, type PolicyDescription, type QueryServicesByAvailabilityOptions, type QueryServicesByAvailabilityRequest, type QueryServicesByAvailabilityResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RankingOptions, RankingOrder, type RankingOrderWithLiterals, RateType, type RateTypeWithLiterals, type ReschedulePolicy, type ResourceDetails, type ResourceGroup, type ResourceIds, type ResourceInfo, type ResourceType, type ResourcesPolicy, type SaveCreditCardPolicy, type Schedule, type SeoSchema, type Service, type ServiceResource, type ServiceResourceSelectionOneOf, ServiceType, type ServiceTypeWithLiterals, type ServiceWithAvailability, type Settings, type Slug, SortOrder, type SortOrderWithLiterals, type Sorting, SortingMethodType, type SortingMethodTypeWithLiterals, type StaffMediaItem, type StaffMediaItemItemOneOf, type StaffMember, type StaffMemberDetails, type StaffSortingPolicy, type StaffSortingPolicyOptionsOneOf, type StreetAddress, type SubscriptionPayment, type Tag, type TaxableAddress, TaxableAddressType, type TaxableAddressTypeWithLiterals, Timing, type TimingWithLiterals, type URLs, UnitType, type UnitTypeWithLiterals, type VariedPayment, type WaitlistPolicy, type WorkingHoursLocationCoverage };
+export { type AddOnDetails, type AddOnGroup, AddOnPaymentOptions, type AddOnPaymentOptionsWithLiterals, type Address, type AddressLocation, type AddressStreetOneOf, type Attribute, type AttributeValueOneOf, type AvailabilityConstraints, type BookAfterStartPolicy, type BookingPolicy, type BusinessLocationOptions, type CancellationFeePolicy, type CancellationPolicy, type CancellationWindow, type CancellationWindowFeeOneOf, type CatalogSearchResult, type Category, CompletionRequirement, type CompletionRequirementWithLiterals, type Conferencing, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomLocationOptions, type CustomOptions, type CustomPayment, type DailyConfig, type DiscountInfo, type Duration, type DurationRange, type DurationRangeConfigOneOf, type ExtendedFields, FirstChargeDateType, type FirstChargeDateTypeWithLiterals, type FixedPayment, type Form, type FormSettings, FrequencyType, type FrequencyTypeWithLiterals, type FullUpfrontPayment, type HourlyConfig, type IntakeFormPolicy, type Keyword, type LimitEarlyBookingPolicy, type LimitLateBookingPolicy, type Location, type LocationOptionsOneOf, LocationType, type LocationTypeWithLiterals, type Media, type MediaItem, type MediaItemItemOneOf, type Money, type NumberRange, type NumberValues, type OnlineBooking, type Paging, type ParticipantsPolicy, type Payment, type PaymentOptions, type PaymentRateOneOf, type PhoneCall, type PolicyDescription, type QueryServicesByFiltersOptions, type QueryServicesByFiltersRequest, type QueryServicesByFiltersResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RankingOptions, RankingOrder, type RankingOrderWithLiterals, RateType, type RateTypeWithLiterals, type ReschedulePolicy, type ResourceDetails, type ResourceGroup, type ResourceIds, type ResourceInfo, type ResourceType, type ResourcesPolicy, type SaveCreditCardPolicy, type Schedule, type SeoSchema, type Service, type ServiceFilters, type ServiceResource, type ServiceResourceSelectionOneOf, ServiceType, type ServiceTypeWithLiterals, type ServiceWithAvailability, type Settings, type Slug, SortOrder, type SortOrderWithLiterals, type Sorting, SortingMethodType, type SortingMethodTypeWithLiterals, type StaffMediaItem, type StaffMediaItemItemOneOf, type StaffMember, type StaffMemberDetails, type StaffSortingPolicy, type StaffSortingPolicyOptionsOneOf, type StreetAddress, type SubscriptionPayment, type Tag, type TaxableAddress, TaxableAddressType, type TaxableAddressTypeWithLiterals, Timing, type TimingWithLiterals, type URLs, UnitType, type UnitTypeWithLiterals, type VariedPayment, type WaitlistPolicy, type WorkingHoursLocationCoverage };

package/build/cjs/index.js

@@ -33,7 +33,7 @@ __export(index_exports, {
   TaxableAddressType: () => TaxableAddressType,
   Timing: () => Timing,
   UnitType: () => UnitType,
-  queryServicesByAvailability: () => queryServicesByAvailability4
+  queryServicesByFilters: () => queryServicesByFilters4
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -58,12 +58,12 @@ function resolveWixBookingsCatalogSearchV1CatalogSearchUrl(opts) {
   return (0, import_rest_modules.resolveUrl)(Object.assign(opts, { domainToMappings }));
 }
 var PACKAGE_NAME = "@wix/auto_sdk_bookings_catalog-search";
-function queryServicesByAvailability(payload) {
-  function __queryServicesByAvailability({ host }) {
+function queryServicesByFilters(payload) {
+  function __queryServicesByFilters({ host }) {
     const metadata = {
       entityFqdn: "wix.bookings.catalog_search.v1.catalog_search",
       method: "POST",
-      methodFqn: "wix.bookings.catalog.search.v1.CatalogSearch.QueryServicesByAvailability",
+      methodFqn: "wix.bookings.catalog.search.v1.CatalogSearch.QueryServicesByFilters",
       packageName: PACKAGE_NAME,
       migrationOptions: {
         optInTransformResponse: true
@@ -131,7 +131,7 @@ function queryServicesByAvailability(payload) {
     };
     return metadata;
   }
-  return __queryServicesByAvailability;
+  return __queryServicesByFilters;
 }
 
 // src/bookings-catalog-search-v1-catalog-search-catalog-search.universal.ts
@@ -209,13 +209,13 @@ var TaxableAddressType = /* @__PURE__ */ ((TaxableAddressType2) => {
   TaxableAddressType2["BILLING"] = "BILLING";
   return TaxableAddressType2;
 })(TaxableAddressType || {});
-async function queryServicesByAvailability2(options) {
+async function queryServicesByFilters2(options) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     query: options?.query,
-    availabilityFilter: options?.availabilityFilter
+    serviceFilters: options?.serviceFilters
   });
-  const reqOpts = queryServicesByAvailability(
+  const reqOpts = queryServicesByFilters(
     payload
   );
   sideEffects?.onSiteCall?.();
@@ -261,7 +261,7 @@ async function queryServicesByAvailability2(options) {
         spreadPathsToArguments: {},
         explicitPathsToArguments: {
           query: "$[0].query",
-          availabilityFilter: "$[0].availabilityFilter"
+          serviceFilters: "$[0].serviceFilters"
         },
         singleArgumentUnchanged: false
       },
@@ -273,8 +273,8 @@ async function queryServicesByAvailability2(options) {
 }
 
 // src/bookings-catalog-search-v1-catalog-search-catalog-search.public.ts
-function queryServicesByAvailability3(httpClient) {
-  return (options) => queryServicesByAvailability2(
+function queryServicesByFilters3(httpClient) {
+  return (options) => queryServicesByFilters2(
     options,
     // @ts-ignore
     { httpClient }
@@ -283,7 +283,7 @@ function queryServicesByAvailability3(httpClient) {
 
 // src/bookings-catalog-search-v1-catalog-search-catalog-search.context.ts
 var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
-var queryServicesByAvailability4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(queryServicesByAvailability3);
+var queryServicesByFilters4 = /* @__PURE__ */ (0, import_rest_modules2.createRESTModule)(queryServicesByFilters3);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AddOnPaymentOptions,
@@ -299,6 +299,6 @@ var queryServicesByAvailability4 = /* @__PURE__ */ (0, import_rest_modules2.crea
   TaxableAddressType,
   Timing,
   UnitType,
-  queryServicesByAvailability
+  queryServicesByFilters
 });
 //# sourceMappingURL=index.js.map