@wix/ditto-codegen-public 1.0.162 → 1.0.164

package/dist/docs-output/api-docs/bookings-bookings-onBookingCanceled-doc.txt

@@ -0,0 +1,169 @@
+<bookings_bookings_onBookingCanceled>
+<description>
+# This is a Webhook method
+
+# Method name:
+
+bookings.bookings.onBookingCanceled(handler: OnBookingCanceledHandler)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/on-booking-canceled
+
+# Method Description:
+
+Triggered when a booking is canceled.
+
+
+</description>
+<usage>
+import { bookings } from "@wix/bookings";
+
+   bookings.onBookingCanceled((event) => {
+     // handle your event here
+   });
+   
+</usage>
+<type_definition>
+```
+Method: bookings.bookings.onBookingCanceled(handler)
+Description: Triggered when a booking is canceled.
+Method parameters:
+  param name:  handler | type: OnBookingCanceledHandler | description:  none 
+      - name: event  | type: BookingCanceledEnvelope | description:  none 
+          - name: data  | type: BookingCanceled | description:  none 
+              - name: booking  | type: Booking | description:  The canceled booking object. 
+                  - name: bookedAddOns  | type: Array<BookedAddOn> | description:  List of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) associated with the booking. 
+                        - name: _id  | type: string | description:  The GUID of the add-on. 
+                        - name: groupId  | type: string | description:  The GUID of the add-on group. 
+                        - name: quantity  | type: number | description:  The quantity of booked add-ons. 
+                  - name: bookedEntity  | type: BookedEntity | description:  An object describing the bookable entity - either a specific time slot or a recurring schedule.  The structure depends on the type of service being booked:  __For appointment services__: Use `slot` to book a specific time slot with a service provider. Appointments are typically one-time sessions at a specific date and time.  __For class services__: Use `slot` to book a specific class session. Classes are individual sessions that can have multiple participants.  __For course services__: Use `schedule` to book an entire course consisting of multiple sessions over time. Courses are recurring, multi-session offerings.  Choose the appropriate field based on your service type and booking requirements. 
+                      - name: tags  | type: Array<string> | description:  List of tags for the booking.  - "INDIVIDUAL": For bookings of appointment-based services. Including when the appointment is for a group of participants. - "GROUP": For bookings of individual class sessions. - "COURSE": For course bookings. 
+                      - ONE-OF: 
+                        - name: schedule  | type: BookedSchedule | description:  [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).  Specify `schedule` when creating bookings for: - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs). Wix Bookings enrolls participants in all sessions defined by the course schedule. 
+                            - name: scheduleId  | type: string | description:  [Schedule GUID](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction). 
+                            - name: serviceId  | type: string | description:  Booked service GUID. 
+                            - name: timezone  | type: string | description:  Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database). For example, `America/New_York` or `UTC`. This is the time zone in which the schedule was shown to the customer at the time of booking. Wix Bookings ensures that the schedule is always displayed in this same time zone to the customer, including when they view or edit their booking in the future. 
+                        - name: slot  | type: BookedSlot | description:  [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).  Specify `slot` when creating bookings for: - __Appointment-based services__: Individual sessions with service providers (consultations, treatments). Wix Bookings creates a new session when the booking is confirmed. - __Class services__: Group sessions at specific times (fitness classes, workshops). Wix Bookings links the booking to an existing scheduled session.  For course services, specify `schedule` instead of `slot`. 
+                            - name: endDate  | type: string | description:  The end time of this slot in `YYYY-MM-DDThh:mm:ss`, `YYYY-MM-DDThh:mm:ss:SSS`, or `YYYY-MM-DDThh:mm:ss:SSSZZ` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`, `2026-01-30T13:30:00:000`, or `2026-01-30T13:30:00:000-05:00`. 
+                            - name: eventId  | type: string | description:  GUID of the corresponding [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction). Available for both appointment and class bookings, not available for course bookings. For appointment-based services, Wix Bookings automatically populates `eventId` when the booking `status` changes to `CONFIRMED`. For class bookings, Wix Bookings automatically populates `eventId` upon booking creation. 
+                            - name: location  | type: Location | description:  Location where the session takes place. 
+                                - name: _id  | type: string | description:  Business location GUID. Available only for locations that are business locations, meaning the `location_type` is `"OWNER_BUSINESS"`. 
+                                - name: formattedAddress  | type: string | description:  The full address of this location. 
+                                - name: formattedAddressTranslated  | type: string | description:  The full translated address of this location. 
+                                - name: locationType  | type: LocationType | description:  Location type.  - `"OWNER_BUSINESS"`: The business address, as set in the site’s general settings. - `"OWNER_CUSTOM"`: The address as set when creating the service. - `"CUSTOM"`: The address as set for the individual session. 
+                                    enum: CUSTOM, OWNER_BUSINESS, OWNER_CUSTOM, UNDEFINED
+                                - name: name  | type: string | description:  Location name. 
+                            - name: resource  | type: BookedResource | description:  [Primary resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) for the booking. For example, the [staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction) providing the service. 
+                                - name: _id  | type: string | description:  GUID of the booking's primary resource. 
+                                - name: email  | type: string | description:  Resource's email at the time of booking. 
+                                - name: name  | type: string | description:  Resource's name at the time of booking. 
+                                - name: scheduleId  | type: string | description:  GUID of the schedule belonging to the booking's primary resource. 
+                            - name: scheduleId  | type: string | description:  Schedule GUID. 
+                            - name: serviceId  | type: string | description:  Service GUID. 
+                            - name: startDate  | type: string | description:  The start time of this slot in `YYYY-MM-DDThh:mm:ss`, `YYYY-MM-DDThh:mm:ss:SSS`, or `YYYY-MM-DDThh:mm:ss:SSSZZ` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`, `2026-01-30T13:30:00:000`, or `2026-01-30T13:30:00:000-05:00`. 
+                            - name: timezone  | type: string | description:  Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database). For example, `America/New_York` or `UTC`. This is the time zone in which the slot was shown to the customer at the time of booking. Wix Bookings ensures that the slot is always displayed in this same time zone to the customer, including when they view or edit their booking in the future. 
+                  - name: contactDetails  | type: ContactDetails | description:  Contact details of the site visitor or [member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction)) making the booking. 
+                      - name: contactId  | type: string | description:  Contact GUID. 
+                      - name: countryCode  | type: string | description:  Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. 
+                      - name: email  | type: string | description:  Contact's email. If no [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object) with this email exist, a new contact is created. Used to validate coupon usage limitations per contact. If not specified, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet). 
+                      - name: firstName  | type: string | description:  Contact's first name. When populated from a standard booking form, this property corresponds to the `name` field. 
+                      - name: fullAddress  | type: Address | description:  Contact's full address. 
+                          - name: addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. 
+                          - name: city  | type: string | description:  City name. 
+                          - name: country  | type: string | description:  Country code. 
+                          - name: countryFullname  | type: string | description:  Country full name. 
+                          - name: formattedAddress  | type: string | description:  A string containing the full address of this location. 
+                          - name: geocode  | type: AddressLocation | description:  Coordinates of the physical address. 
+                              - name: latitude  | type: number | description:  Address latitude. 
+                              - name: longitude  | type: number | description:  Address longitude. 
+                          - name: hint  | type: string | description:  Free text to help find the address. 
+                          - name: postalCode  | type: string | description:  Zip/postal code. 
+                          - name: subdivision  | type: string | description:  Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). 
+                          - name: subdivisions  | type: Array<Subdivision> | description:  Multi-level subdivisions from top to bottom. 
+                                - name: code  | type: string | description:  Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). 
+                                - name: name  | type: string | description:  Subdivision full name. 
+                          - ONE-OF: 
+                            - name: addressLine  | type: string | description:  Main address line, usually street and number, as free text. 
+                            - name: streetAddress  | type: StreetAddress | description:  Street name, number and apartment number. 
+                                - name: apt  | type: string | description:  Apartment number. 
+                                - name: name  | type: string | description:  Street name. 
+                                - name: number  | type: string | description:  Street number. 
+                      - name: lastName  | type: string | description:  Contact's last name. 
+                      - name: phone  | type: string | description:  Contact's phone number. 
+                  - name: extendedFields  | type: ExtendedFields | description:  Custom field data for this object. Extended fields must be configured in the app dashboard before they can be accessed with API calls. 
+                      - name: namespaces  | type: Record<string, undefined> | description:  Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). 
+                  - name: externalUserId  | type: string | description:  External user GUID that you can provide. 
+                  - name: formSubmissionId  | type: string | description:  GUID of the [form submission](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction) associated with this booking. 
+                  - name: paymentStatus  | type: PaymentStatus | description:  The payment status of the booking. This field automatically syncs with the `paymentStatus` of the corresponding [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/introduction) when customers use Wix eCommerce checkout.  ### Integration patterns  __When using Wix eCommerce checkout__: Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status. Do not manually update this field.  __When using custom payment flows__: You can manually update the payment status with [Confirm Booking or Decline Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to reflect the customer's payment state.  __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active [pricing plan](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/introduction) subscription.  All payment statuses are supported for every booking `status`. 
+                      enum: 
+                           EXEMPT: The booking is free of charge.
+                           NOT_PAID: The booking isn't paid.
+                           PAID: The booking is fully paid.
+                           PARTIALLY_PAID: The booking is partially paid.
+                           REFUNDED: The booking is refunded.
+                           UNDEFINED: Undefined payment status.
+                  - name: revision  | type: string | description:  Revision number to be used when updating, rescheduling, or cancelling the booking. Increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes, the current revision must be specified when updating the booking. 
+                  - name: selectedPaymentOption  | type: SelectedPaymentOption | description:  Payment option selected by the customer. If the customer hasn't completed their checkout, they may still change the payment method. Must be one of the payment options offered by the [service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction), unless `skipSelectedPaymentOptionValidation` is `true`.  When the customer pays with a [Wix eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/checkout/introduction), this field is required. Otherwise, the Create Booking call fails. For custom checkouts, you don't have to specify this field. 
+                      enum: 
+                           MEMBERSHIP: Payment using a Wix Pricing Plan.
+                           MEMBERSHIP_OFFLINE: Customers can pay only in person with a Wix Pricing Plan, while the Wix user must manually redeem the pricing plan in the dashboard.
+                           OFFLINE: Offline payment.
+                           ONLINE: Online payment.
+                           UNDEFINED: Undefined payment option.
+                  - name: status  | type: BookingStatus | description:  Booking status. A booking is automatically confirmed if the service allows it and an eCommerce order is created. It is automatically declined if there is a double booking and the customer hasn't paid or is eligible for an automatic refund. Currently, only payments with pricing plans are automatically refundable. 
+                      enum: 
+                           CANCELED: The customer has canceled the booking. Depending on the relevant service's [policy snapshot](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction) they may have to pay a [cancellation fee](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction).
+                           CONFIRMED: The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) to automatically confirm all `PENDING` bookings.
+                           CREATED: The booking was created, but the customer hasn't completed the related eCommerce order yet.
+                           DECLINED: The merchant has declined the booking before the customer was charged.
+                           PENDING: The merchant must manually confirm the booking before it appears in the business calendar.
+                           WAITING_LIST: Currently, you can't call [Register to Waitlist](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist) for course or appointment bookings, even though this is supported in live sites.
+                  - ONE-OF: 
+                    - name: participantsChoices  | type: ParticipantChoices | description:  Information about the booked service choices and participant count for each choice. When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).  For example, use this for a spa package booking that includes different service levels: - 2 participants chose "Standard Package". - 1 participant chose "VIP Package". 
+                        - name: serviceChoices  | type: Array<ServiceChoices> | description:  Information about the booked service choices. Includes the number of participants. 
+                              - name: choices  | type: Array<ServiceChoice> | description:  Service choices for these participants. 
+                                    - name: optionId  | type: string | description:  GUID of the corresponding option for the choice. For example, the choice `child` could correspond to the option `ageGroup`. In this case, `optionId` is the GUID for the `ageGroup` option. 
+                                    - ONE-OF: 
+                                      - name: custom  | type: string | description:  Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list. Choices are specific values for an option the customer can choose to book. For example, the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`. Each choice may have a different price. 
+                                      - name: duration  | type: Duration | description:  none 
+                                          - name: minutes  | type: number | description:  Duration of the service in minutes. Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes 
+                                          - name: name  | type: string | description:  Name of the duration option. Defaults to the formatted duration e.g. "1 hour, 30 minutes". 
+                              - name: numberOfParticipants  | type: number | description:  Number of participants for this [variant](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction). 
+                    - name: totalParticipants  | type: number | description:  Total number of participants. When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction). 
+              - name: flowControlSettings  | type: CancelBookingFlowControlSettings | description:  Information about whether specific procedures of the standard Wix Bookings cancellation flow are changed. For example, whether you can cancel a booking even though the cancellation policy doesn't allow it or whether to issue a refund. 
+                  - name: ignoreCancellationPolicy  | type: boolean | description:  Whether the cancellation policy applies when canceling the booking.  When passing `false`, you can only cancel a booking if the cancellation policy allows it. Default: `false`. 
+                  - name: waiveCancellationFee  | type: boolean | description:  Whether to waive the cancellation fee when canceling the booking.  - `true`: The customer doesn't have to pay a cancellation fee. - `false`: The customer must pay the cancellation fee that's defined in the service's [policy](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction).  Default: `false`. 
+                  - name: withRefund  | type: boolean | description:  Whether to issue a refund when canceling the booking.  The refund will be issued only if the booking is refundable. Currently, a booking is considered refundable when it was paid by membership. If you specify `true`, the booking flow control settings is set to include a refund. If `false` is specified or the field remains empty, the booking flow control settings are set without refund.  Default: `false`. 
+              - name: initiatedBy  | type: IdentificationData | description:  GUID of the cancellation initiator. 
+                  - ONE-OF: 
+                    - name: anonymousVisitorId  | type: string | description:  GUID of a site visitor that has not logged in to the site. 
+                    - name: appId  | type: string | description:  GUID of an app. 
+                    - name: memberId  | type: string | description:  GUID of a site visitor that has logged in to the site. 
+                    - name: wixUserId  | type: string | description:  GUID of a Wix user (site owner, contributor, etc.). 
+              - name: participantNotification  | type: ParticipantNotification | description:  Information about whether to notify the customer about the cancellation and the message to send. 
+                  - name: message  | type: string | description:  Custom message to send to the participants about the changes to the booking. 
+                  - name: notifyParticipants  | type: boolean | description:  Whether to send a message about the changes to the customer.  Default: `false` 
+              - name: previousStatus  | type: BookingStatus | description:  The previous status of the booking. 
+          - name: metadata  | type: EventMetadata | description:  none 
+              - name: _id  | type: string | description:  Event GUID. With this GUID you can easily spot duplicated events and ignore them. 
+              - name: entityEventSequence  | type: string | description:  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. 
+              - name: entityFqdn  | type: string | description:  Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. 
+              - name: entityId  | type: string | description:  GUID of the entity associated with the event. 
+              - name: eventTime  | type: Date | description:  Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. 
+              - name: eventType  | type: string | description:  Event type. 
+              - name: identity  | type: WebhooksIdentificationData | description:  The identification type and identity data. 
+                  - ONE-OF: 
+                    - name: anonymousVisitorId  | type: string | description:  GUID of a site visitor that has not logged in to the site. 
+                    - name: appId  | type: string | description:  GUID of an app. 
+                    - name: memberId  | type: string | description:  GUID of a site visitor that has logged in to the site. 
+                    - name: wixUserId  | type: string | description:  GUID of a Wix user (site owner, contributor, etc.). 
+              - name: instanceId  | type: string | description:  App instance GUID. 
+              - name: originatedFrom  | type: string | description:  If present, indicates the action that triggered the event. 
+              - name: slug  | type: string | description:  Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. 
+              - name: triggeredByAnonymizeRequest  | type: boolean | description:  Whether the event was triggered as a result of a privacy regulation application (for example, GDPR). 
+Return type: PRIMITIVE<void>
+
+```
+</type_definition>
+</bookings_bookings_onBookingCanceled>

package/dist/docs-output/api-docs/bookings-bookings-onBookingCreated-doc.txt

@@ -0,0 +1,154 @@
+<bookings_bookings_onBookingCreated>
+<description>
+# This is a Webhook method
+
+# Method name:
+
+bookings.bookings.onBookingCreated(handler: OnBookingCreatedHandler)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/bookings/bookings/on-booking-created
+
+# Method Description:
+
+Triggered when a booking is created.
+
+
+</description>
+<usage>
+import { bookings } from "@wix/bookings";
+
+   bookings.onBookingCreated((event) => {
+     // handle your event here
+   });
+   
+</usage>
+<type_definition>
+```
+Method: bookings.bookings.onBookingCreated(handler)
+Description: Triggered when a booking is created.
+Method parameters:
+  param name:  handler | type: OnBookingCreatedHandler | description:  none 
+      - name: event  | type: BookingCreatedEnvelope | description:  none 
+          - name: entity  | type: Booking | description:  none 
+              - name: bookedAddOns  | type: Array<BookedAddOn> | description:  List of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) associated with the booking. 
+                    - name: _id  | type: string | description:  The GUID of the add-on. 
+                    - name: groupId  | type: string | description:  The GUID of the add-on group. 
+                    - name: quantity  | type: number | description:  The quantity of booked add-ons. 
+              - name: bookedEntity  | type: BookedEntity | description:  An object describing the bookable entity - either a specific time slot or a recurring schedule.  The structure depends on the type of service being booked:  __For appointment services__: Use `slot` to book a specific time slot with a service provider. Appointments are typically one-time sessions at a specific date and time.  __For class services__: Use `slot` to book a specific class session. Classes are individual sessions that can have multiple participants.  __For course services__: Use `schedule` to book an entire course consisting of multiple sessions over time. Courses are recurring, multi-session offerings.  Choose the appropriate field based on your service type and booking requirements. 
+                  - name: tags  | type: Array<string> | description:  List of tags for the booking.  - "INDIVIDUAL": For bookings of appointment-based services. Including when the appointment is for a group of participants. - "GROUP": For bookings of individual class sessions. - "COURSE": For course bookings. 
+                  - ONE-OF: 
+                    - name: schedule  | type: BookedSchedule | description:  [Booked schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction).  Specify `schedule` when creating bookings for: - __Course services__: Multi-session offerings spanning weeks or months (educational courses, training programs). Wix Bookings enrolls participants in all sessions defined by the course schedule. 
+                        - name: scheduleId  | type: string | description:  [Schedule GUID](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction). 
+                        - name: serviceId  | type: string | description:  Booked service GUID. 
+                        - name: timezone  | type: string | description:  Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database). For example, `America/New_York` or `UTC`. This is the time zone in which the schedule was shown to the customer at the time of booking. Wix Bookings ensures that the schedule is always displayed in this same time zone to the customer, including when they view or edit their booking in the future. 
+                    - name: slot  | type: BookedSlot | description:  [Booked slot](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/time-slots/availability-calendar/query-availability).  Specify `slot` when creating bookings for: - __Appointment-based services__: Individual sessions with service providers (consultations, treatments). Wix Bookings creates a new session when the booking is confirmed. - __Class services__: Group sessions at specific times (fitness classes, workshops). Wix Bookings links the booking to an existing scheduled session.  For course services, specify `schedule` instead of `slot`. 
+                        - name: endDate  | type: string | description:  The end time of this slot in `YYYY-MM-DDThh:mm:ss`, `YYYY-MM-DDThh:mm:ss:SSS`, or `YYYY-MM-DDThh:mm:ss:SSSZZ` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`, `2026-01-30T13:30:00:000`, or `2026-01-30T13:30:00:000-05:00`. 
+                        - name: eventId  | type: string | description:  GUID of the corresponding [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction). Available for both appointment and class bookings, not available for course bookings. For appointment-based services, Wix Bookings automatically populates `eventId` when the booking `status` changes to `CONFIRMED`. For class bookings, Wix Bookings automatically populates `eventId` upon booking creation. 
+                        - name: location  | type: Location | description:  Location where the session takes place. 
+                            - name: _id  | type: string | description:  Business location GUID. Available only for locations that are business locations, meaning the `location_type` is `"OWNER_BUSINESS"`. 
+                            - name: formattedAddress  | type: string | description:  The full address of this location. 
+                            - name: formattedAddressTranslated  | type: string | description:  The full translated address of this location. 
+                            - name: locationType  | type: LocationType | description:  Location type.  - `"OWNER_BUSINESS"`: The business address, as set in the site’s general settings. - `"OWNER_CUSTOM"`: The address as set when creating the service. - `"CUSTOM"`: The address as set for the individual session. 
+                                enum: CUSTOM, OWNER_BUSINESS, OWNER_CUSTOM, UNDEFINED
+                            - name: name  | type: string | description:  Location name. 
+                        - name: resource  | type: BookedResource | description:  [Primary resource](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/introduction) for the booking. For example, the [staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction) providing the service. 
+                            - name: _id  | type: string | description:  GUID of the booking's primary resource. 
+                            - name: email  | type: string | description:  Resource's email at the time of booking. 
+                            - name: name  | type: string | description:  Resource's name at the time of booking. 
+                            - name: scheduleId  | type: string | description:  GUID of the schedule belonging to the booking's primary resource. 
+                        - name: scheduleId  | type: string | description:  Schedule GUID. 
+                        - name: serviceId  | type: string | description:  Service GUID. 
+                        - name: startDate  | type: string | description:  The start time of this slot in `YYYY-MM-DDThh:mm:ss`, `YYYY-MM-DDThh:mm:ss:SSS`, or `YYYY-MM-DDThh:mm:ss:SSSZZ` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`, `2026-01-30T13:30:00:000`, or `2026-01-30T13:30:00:000-05:00`. 
+                        - name: timezone  | type: string | description:  Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database). For example, `America/New_York` or `UTC`. This is the time zone in which the slot was shown to the customer at the time of booking. Wix Bookings ensures that the slot is always displayed in this same time zone to the customer, including when they view or edit their booking in the future. 
+              - name: contactDetails  | type: ContactDetails | description:  Contact details of the site visitor or [member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction)) making the booking. 
+                  - name: contactId  | type: string | description:  Contact GUID. 
+                  - name: countryCode  | type: string | description:  Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. 
+                  - name: email  | type: string | description:  Contact's email. If no [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object) with this email exist, a new contact is created. Used to validate coupon usage limitations per contact. If not specified, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet). 
+                  - name: firstName  | type: string | description:  Contact's first name. When populated from a standard booking form, this property corresponds to the `name` field. 
+                  - name: fullAddress  | type: Address | description:  Contact's full address. 
+                      - name: addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. 
+                      - name: city  | type: string | description:  City name. 
+                      - name: country  | type: string | description:  Country code. 
+                      - name: countryFullname  | type: string | description:  Country full name. 
+                      - name: formattedAddress  | type: string | description:  A string containing the full address of this location. 
+                      - name: geocode  | type: AddressLocation | description:  Coordinates of the physical address. 
+                          - name: latitude  | type: number | description:  Address latitude. 
+                          - name: longitude  | type: number | description:  Address longitude. 
+                      - name: hint  | type: string | description:  Free text to help find the address. 
+                      - name: postalCode  | type: string | description:  Zip/postal code. 
+                      - name: subdivision  | type: string | description:  Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). 
+                      - name: subdivisions  | type: Array<Subdivision> | description:  Multi-level subdivisions from top to bottom. 
+                            - name: code  | type: string | description:  Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). 
+                            - name: name  | type: string | description:  Subdivision full name. 
+                      - ONE-OF: 
+                        - name: addressLine  | type: string | description:  Main address line, usually street and number, as free text. 
+                        - name: streetAddress  | type: StreetAddress | description:  Street name, number and apartment number. 
+                            - name: apt  | type: string | description:  Apartment number. 
+                            - name: name  | type: string | description:  Street name. 
+                            - name: number  | type: string | description:  Street number. 
+                  - name: lastName  | type: string | description:  Contact's last name. 
+                  - name: phone  | type: string | description:  Contact's phone number. 
+              - name: extendedFields  | type: ExtendedFields | description:  Custom field data for this object. Extended fields must be configured in the app dashboard before they can be accessed with API calls. 
+                  - name: namespaces  | type: Record<string, undefined> | description:  Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). 
+              - name: externalUserId  | type: string | description:  External user GUID that you can provide. 
+              - name: formSubmissionId  | type: string | description:  GUID of the [form submission](https://dev.wix.com/docs/rest/crm/forms/form-submissions/introduction) associated with this booking. 
+              - name: paymentStatus  | type: PaymentStatus | description:  The payment status of the booking. This field automatically syncs with the `paymentStatus` of the corresponding [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/introduction) when customers use Wix eCommerce checkout.  ### Integration patterns  __When using Wix eCommerce checkout__: Wix Bookings automatically syncs the payment status based on the eCommerce order's payment status. Do not manually update this field.  __When using custom payment flows__: You can manually update the payment status with [Confirm Booking or Decline Booking](https://dev.wix.com/docs/api-reference/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking) to reflect the customer's payment state.  __For membership/pricing plan payments__: Wix Bookings automatically manages the payment status when customers pay with an active [pricing plan](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans/introduction) subscription.  All payment statuses are supported for every booking `status`. 
+                  enum: 
+                       EXEMPT: The booking is free of charge.
+                       NOT_PAID: The booking isn't paid.
+                       PAID: The booking is fully paid.
+                       PARTIALLY_PAID: The booking is partially paid.
+                       REFUNDED: The booking is refunded.
+                       UNDEFINED: Undefined payment status.
+              - name: revision  | type: string | description:  Revision number to be used when updating, rescheduling, or cancelling the booking. Increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes, the current revision must be specified when updating the booking. 
+              - name: selectedPaymentOption  | type: SelectedPaymentOption | description:  Payment option selected by the customer. If the customer hasn't completed their checkout, they may still change the payment method. Must be one of the payment options offered by the [service](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction), unless `skipSelectedPaymentOptionValidation` is `true`.  When the customer pays with a [Wix eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/checkout/introduction), this field is required. Otherwise, the Create Booking call fails. For custom checkouts, you don't have to specify this field. 
+                  enum: 
+                       MEMBERSHIP: Payment using a Wix Pricing Plan.
+                       MEMBERSHIP_OFFLINE: Customers can pay only in person with a Wix Pricing Plan, while the Wix user must manually redeem the pricing plan in the dashboard.
+                       OFFLINE: Offline payment.
+                       ONLINE: Online payment.
+                       UNDEFINED: Undefined payment option.
+              - name: status  | type: BookingStatus | description:  Booking status. A booking is automatically confirmed if the service allows it and an eCommerce order is created. It is automatically declined if there is a double booking and the customer hasn't paid or is eligible for an automatic refund. Currently, only payments with pricing plans are automatically refundable. 
+                  enum: 
+                       CANCELED: The customer has canceled the booking. Depending on the relevant service's [policy snapshot](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policy-snapshots/introduction) they may have to pay a [cancellation fee](https://dev.wix.com/docs/rest/business-solutions/bookings/pricing/booking-fees/introduction).
+                       CONFIRMED: The merchant has confirmed the booking and it appears in the business calendar. Merchants can set up their [services](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/introduction) to automatically confirm all `PENDING` bookings.
+                       CREATED: The booking was created, but the customer hasn't completed the related eCommerce order yet.
+                       DECLINED: The merchant has declined the booking before the customer was charged.
+                       PENDING: The merchant must manually confirm the booking before it appears in the business calendar.
+                       WAITING_LIST: Currently, you can't call [Register to Waitlist](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/waitlist/register-to-waitlist) for course or appointment bookings, even though this is supported in live sites.
+              - ONE-OF: 
+                - name: participantsChoices  | type: ParticipantChoices | description:  Information about the booked service choices and participant count for each choice. When creating a booking, use this field only if the booking includes multiple [service variants](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction).  For example, use this for a spa package booking that includes different service levels: - 2 participants chose "Standard Package". - 1 participant chose "VIP Package". 
+                    - name: serviceChoices  | type: Array<ServiceChoices> | description:  Information about the booked service choices. Includes the number of participants. 
+                          - name: choices  | type: Array<ServiceChoice> | description:  Service choices for these participants. 
+                                - name: optionId  | type: string | description:  GUID of the corresponding option for the choice. For example, the choice `child` could correspond to the option `ageGroup`. In this case, `optionId` is the GUID for the `ageGroup` option. 
+                                - ONE-OF: 
+                                  - name: custom  | type: string | description:  Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list. Choices are specific values for an option the customer can choose to book. For example, the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`. Each choice may have a different price. 
+                                  - name: duration  | type: Duration | description:  none 
+                                      - name: minutes  | type: number | description:  Duration of the service in minutes. Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes 
+                                      - name: name  | type: string | description:  Name of the duration option. Defaults to the formatted duration e.g. "1 hour, 30 minutes". 
+                          - name: numberOfParticipants  | type: number | description:  Number of participants for this [variant](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction). 
+                - name: totalParticipants  | type: number | description:  Total number of participants. When creating a booking, use this field only if the relevant service has fixed pricing and doesn't offer [variants and options](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction). 
+          - name: metadata  | type: EventMetadata | description:  none 
+              - name: _id  | type: string | description:  Event GUID. With this GUID you can easily spot duplicated events and ignore them. 
+              - name: entityEventSequence  | type: string | description:  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. 
+              - name: entityFqdn  | type: string | description:  Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. 
+              - name: entityId  | type: string | description:  GUID of the entity associated with the event. 
+              - name: eventTime  | type: Date | description:  Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. 
+              - name: eventType  | type: string | description:  Event type. 
+              - name: identity  | type: WebhooksIdentificationData | description:  The identification type and identity data. 
+                  - ONE-OF: 
+                    - name: anonymousVisitorId  | type: string | description:  GUID of a site visitor that has not logged in to the site. 
+                    - name: appId  | type: string | description:  GUID of an app. 
+                    - name: memberId  | type: string | description:  GUID of a site visitor that has logged in to the site. 
+                    - name: wixUserId  | type: string | description:  GUID of a Wix user (site owner, contributor, etc.). 
+              - name: instanceId  | type: string | description:  App instance GUID. 
+              - name: originatedFrom  | type: string | description:  If present, indicates the action that triggered the event. 
+              - name: slug  | type: string | description:  Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. 
+              - name: triggeredByAnonymizeRequest  | type: boolean | description:  Whether the event was triggered as a result of a privacy regulation application (for example, GDPR). 
+Return type: PRIMITIVE<void>
+
+```
+</type_definition>
+</bookings_bookings_onBookingCreated>