@wix/auto_sdk_bookings_services 1.0.243 → 1.0.245

package/build/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-import { cJ as CreateServiceRequest$1, cK as CreateServiceResponse$1, cO as BulkCreateServicesRequest$1, a as BulkCreateServicesResponse$1, cT as GetServiceRequest$1, cU as GetServiceResponse$1, cZ as UpdateServiceRequest$1, c_ as UpdateServiceResponse$1, c$ as BulkUpdateServicesRequest$1, d as BulkUpdateServicesResponse$1, d1 as BulkUpdateServicesByFilterRequest$1, f as BulkUpdateServicesByFilterResponse$1, d2 as DeleteServiceRequest$1, d4 as DeleteServiceResponse$1, d5 as BulkDeleteServicesRequest$1, h as BulkDeleteServicesResponse$1, d6 as BulkDeleteServicesByFilterRequest$1, j as BulkDeleteServicesByFilterResponse$1, d7 as QueryServicesRequest$1, dd as QueryServicesResponse$1, dg as SearchServicesRequest$1, l as SearchServicesResponse$1, dX as QueryPoliciesRequest$1, Q as QueryPoliciesResponse$1, d_ as QueryBookingFormsRequest$1, o as QueryBookingFormsResponse$1, e2 as CountServicesRequest$1, r as CountServicesResponse$1, e3 as QueryLocationsRequest$1, t as QueryLocationsResponse$1, e8 as QueryCategoriesRequest$1, v as QueryCategoriesResponse$1, ec as SetServiceLocationsRequest$1, x as SetServiceLocationsResponse$1, eg as EnablePricingPlansForServiceRequest$1, E as EnablePricingPlansForServiceResponse$1, ej as DisablePricingPlansForServiceRequest$1, A as DisablePricingPlansForServiceResponse$1, ek as SetCustomSlugRequest$1, I as SetCustomSlugResponse$1, el as ValidateSlugRequest$1, L as ValidateSlugResponse$1, em as CloneServiceRequest$1, M as CloneServiceResponse$1, eN as CreateAddOnGroupRequest$1, P as CreateAddOnGroupResponse$1, eO as DeleteAddOnGroupRequest$1, eP as DeleteAddOnGroupResponse$1, eQ as UpdateAddOnGroupRequest$1, Y as UpdateAddOnGroupResponse$1, eR as ListAddOnGroupsByServiceIdRequest$1, $ as ListAddOnGroupsByServiceIdResponse$1, eV as SetAddOnsForGroupRequest$1, a1 as SetAddOnsForGroupResponse$1 } from './bookings-services-v2-service-services.universal-BpDjq9wo.js';
+import { cJ as CreateServiceRequest$1, cK as CreateServiceResponse$1, cO as BulkCreateServicesRequest$1, a as BulkCreateServicesResponse$1, cT as GetServiceRequest$1, cU as GetServiceResponse$1, cZ as UpdateServiceRequest$1, c_ as UpdateServiceResponse$1, c$ as BulkUpdateServicesRequest$1, d as BulkUpdateServicesResponse$1, d1 as BulkUpdateServicesByFilterRequest$1, f as BulkUpdateServicesByFilterResponse$1, d2 as DeleteServiceRequest$1, d4 as DeleteServiceResponse$1, d5 as BulkDeleteServicesRequest$1, h as BulkDeleteServicesResponse$1, d6 as BulkDeleteServicesByFilterRequest$1, j as BulkDeleteServicesByFilterResponse$1, d7 as QueryServicesRequest$1, dd as QueryServicesResponse$1, dg as SearchServicesRequest$1, l as SearchServicesResponse$1, dX as QueryPoliciesRequest$1, Q as QueryPoliciesResponse$1, d_ as QueryBookingFormsRequest$1, o as QueryBookingFormsResponse$1, e2 as CountServicesRequest$1, r as CountServicesResponse$1, e3 as QueryLocationsRequest$1, t as QueryLocationsResponse$1, e8 as QueryCategoriesRequest$1, v as QueryCategoriesResponse$1, ec as SetServiceLocationsRequest$1, x as SetServiceLocationsResponse$1, eg as EnablePricingPlansForServiceRequest$1, E as EnablePricingPlansForServiceResponse$1, ej as DisablePricingPlansForServiceRequest$1, A as DisablePricingPlansForServiceResponse$1, ek as SetCustomSlugRequest$1, I as SetCustomSlugResponse$1, el as ValidateSlugRequest$1, L as ValidateSlugResponse$1, em as CloneServiceRequest$1, M as CloneServiceResponse$1, eN as CreateAddOnGroupRequest$1, P as CreateAddOnGroupResponse$1, eO as DeleteAddOnGroupRequest$1, eP as DeleteAddOnGroupResponse$1, eQ as UpdateAddOnGroupRequest$1, Y as UpdateAddOnGroupResponse$1, eR as ListAddOnGroupsByServiceIdRequest$1, $ as ListAddOnGroupsByServiceIdResponse$1, eV as SetAddOnsForGroupRequest$1, a1 as SetAddOnsForGroupResponse$1 } from './bookings-services-v2-service-services.universal-e-XkT__j.js';
 import '@wix/sdk-types';
 
 /** The `service` object represents an offering that a business provides to its customers. */
@@ -287,6 +287,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. */
@@ -338,6 +345,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. */
@@ -347,10 +361,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.
@@ -432,24 +451,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;
     /**
@@ -466,15 +499,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 */
@@ -491,12 +524,18 @@ interface FullUpfrontPayment {
      */
     discountPercent?: string | null;
 }
+/**
+ * The payment options a customer can use to pay for the service.
+ * For payments of type `FIXED` or `VARIED`, at least one of `online`, `inPerson`, or `pricingPlan` must be `true`.
+ */
 interface PaymentOptions {
     /**
      * Customers can pay for the service online.
      * When `true`:
-     * + `rateType` must be `FIXED` or `VARIED`.
-     * + `fixed.price` or `varied.defaultPrice` must be specified respectively.
+     * + `rateType` must be `FIXED`, `VARIED`, or `SUBSCRIPTION`.
+     * + `fixed.price`, `varied.defaultPrice`, or `subscription.amountPerBillingCycle` must be specified respectively.
+     *
+     * Required when: `rateType` is `SUBSCRIPTION`.
      * Read more about [getting paid online](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online).
      */
     online?: boolean | null;
@@ -507,6 +546,8 @@ interface PaymentOptions {
      * When `true`:
      * + `rateType` must be `VARIED` or `FIXED`.
      * + A `deposit` must be specified.
+     * + `online` must be `true`.
+     * + `inPerson` must be `false`.
      */
     deposit?: boolean | null;
     /**
@@ -2257,10 +2298,15 @@ declare enum PaymentStatus {
     /** The booking is refunded. */
     REFUNDED = "REFUNDED",
     /** The booking is free of charge. */
-    EXEMPT = "EXEMPT"
+    EXEMPT = "EXEMPT",
+    /**
+     * The most recent subscription payment for this booking failed. If the payment is later recovered, the status changes back to `PAID`. Returned only for course bookings with subscription pricing.
+     * @documentationMaturity preview
+     */
+    FAILED = "FAILED"
 }
 /** @enumType */
-type PaymentStatusWithLiterals = PaymentStatus | 'UNDEFINED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_PAID' | 'REFUNDED' | 'EXEMPT';
+type PaymentStatusWithLiterals = PaymentStatus | 'UNDEFINED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_PAID' | 'REFUNDED' | 'EXEMPT' | 'FAILED';
 /**
  * Selected payment option.
  *
@@ -2591,7 +2637,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
      * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;

package/build/cjs/meta.js

@@ -1832,6 +1832,7 @@ var RateType = /* @__PURE__ */ ((RateType2) => {
   RateType2["CUSTOM"] = "CUSTOM";
   RateType2["VARIED"] = "VARIED";
   RateType2["NO_FEE"] = "NO_FEE";
+  RateType2["SUBSCRIPTION"] = "SUBSCRIPTION";
   return RateType2;
 })(RateType || {});
 var FrequencyType = /* @__PURE__ */ ((FrequencyType2) => {
@@ -1934,6 +1935,7 @@ var PaymentStatus = /* @__PURE__ */ ((PaymentStatus2) => {
   PaymentStatus2["PARTIALLY_PAID"] = "PARTIALLY_PAID";
   PaymentStatus2["REFUNDED"] = "REFUNDED";
   PaymentStatus2["EXEMPT"] = "EXEMPT";
+  PaymentStatus2["FAILED"] = "FAILED";
   return PaymentStatus2;
 })(PaymentStatus || {});
 var SelectedPaymentOption = /* @__PURE__ */ ((SelectedPaymentOption2) => {