@wix/bookings 1.0.228 → 1.0.230

package/build/cjs/src/bookings-v2-booking.universal.d.ts

@@ -588,6 +588,8 @@ export interface GetGroupedBookingsAvailabilityResponse {
     groupedBookingsPolicyViolations?: BookingPolicyViolations;
     /** Booking policy settings */
     bookingPolicySettings?: BookingPolicySettings;
+    /** Info of the grouped bookings this availability was calculated for. */
+    groupedBookingsInfo?: GroupedBookingInfo[];
 }
 export interface BookingPolicyViolations {
     /** Bookings policy violation. Too early to book this slot. */
@@ -601,6 +603,10 @@ export interface BookingPolicySettings {
     /** Booking policy settings for a given Slot/Schedule */
     maxParticipantsPerBooking?: number | null;
 }
+export interface GroupedBookingInfo {
+    /** Grouped booking id */
+    bookingId?: string | null;
+}
 export interface CancelGroupedBookingsRequest {
     /** ID of the group to cancel it's related bookings. */
     groupId?: string;
@@ -2082,6 +2088,588 @@ export interface V2UpdateNumberOfParticipantsResponse {
     /** Booking with updated number of participants. */
     booking?: Booking;
 }
+export interface CreateBookingResponseNonNullableFields {
+    booking?: {
+        totalParticipants: number;
+        participantsChoices?: {
+            serviceChoices: {
+                choices: {
+                    custom: string;
+                    optionId: string;
+                }[];
+            }[];
+        };
+        bookedEntity?: {
+            slot?: {
+                serviceId: string;
+                scheduleId: string;
+                resource?: {
+                    _id: string;
+                };
+                location?: {
+                    locationType: LocationType;
+                };
+                flowSelectedResources: {
+                    type: Type;
+                    resourceIds: string[];
+                }[];
+            };
+            schedule?: {
+                scheduleId: string;
+                location?: {
+                    locationType: LocationType;
+                };
+            };
+        };
+        contactDetails?: {
+            fullAddress?: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                    apt: string;
+                };
+                subdivisions: {
+                    code: string;
+                    name: string;
+                }[];
+            };
+        };
+        additionalFields: {
+            _id: string;
+            valueType: ValueType;
+        }[];
+        status: BookingStatus;
+        paymentStatus: PaymentStatus;
+        selectedPaymentOption: SelectedPaymentOption;
+        createdBy?: {
+            anonymousVisitorId: string;
+            memberId: string;
+            wixUserId: string;
+            appId: string;
+        };
+    };
+}
+export interface BulkCreateBookingResponseNonNullableFields {
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        item?: {
+            totalParticipants: number;
+            participantsChoices?: {
+                serviceChoices: {
+                    choices: {
+                        custom: string;
+                        optionId: string;
+                    }[];
+                }[];
+            };
+            bookedEntity?: {
+                slot?: {
+                    serviceId: string;
+                    scheduleId: string;
+                    resource?: {
+                        _id: string;
+                    };
+                    location?: {
+                        locationType: LocationType;
+                    };
+                    flowSelectedResources: {
+                        type: Type;
+                        resourceIds: string[];
+                    }[];
+                };
+                schedule?: {
+                    scheduleId: string;
+                    location?: {
+                        locationType: LocationType;
+                    };
+                };
+            };
+            contactDetails?: {
+                fullAddress?: {
+                    streetAddress?: {
+                        number: string;
+                        name: string;
+                        apt: string;
+                    };
+                    subdivisions: {
+                        code: string;
+                        name: string;
+                    }[];
+                };
+            };
+            additionalFields: {
+                _id: string;
+                valueType: ValueType;
+            }[];
+            status: BookingStatus;
+            paymentStatus: PaymentStatus;
+            selectedPaymentOption: SelectedPaymentOption;
+            createdBy?: {
+                anonymousVisitorId: string;
+                memberId: string;
+                wixUserId: string;
+                appId: string;
+            };
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
+export interface RescheduleBookingResponseNonNullableFields {
+    booking?: {
+        totalParticipants: number;
+        participantsChoices?: {
+            serviceChoices: {
+                choices: {
+                    custom: string;
+                    optionId: string;
+                }[];
+            }[];
+        };
+        bookedEntity?: {
+            slot?: {
+                serviceId: string;
+                scheduleId: string;
+                resource?: {
+                    _id: string;
+                };
+                location?: {
+                    locationType: LocationType;
+                };
+                flowSelectedResources: {
+                    type: Type;
+                    resourceIds: string[];
+                }[];
+            };
+            schedule?: {
+                scheduleId: string;
+                location?: {
+                    locationType: LocationType;
+                };
+            };
+        };
+        contactDetails?: {
+            fullAddress?: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                    apt: string;
+                };
+                subdivisions: {
+                    code: string;
+                    name: string;
+                }[];
+            };
+        };
+        additionalFields: {
+            _id: string;
+            valueType: ValueType;
+        }[];
+        status: BookingStatus;
+        paymentStatus: PaymentStatus;
+        selectedPaymentOption: SelectedPaymentOption;
+        createdBy?: {
+            anonymousVisitorId: string;
+            memberId: string;
+            wixUserId: string;
+            appId: string;
+        };
+    };
+}
+export interface ConfirmBookingResponseNonNullableFields {
+    booking?: {
+        totalParticipants: number;
+        participantsChoices?: {
+            serviceChoices: {
+                choices: {
+                    custom: string;
+                    optionId: string;
+                }[];
+            }[];
+        };
+        bookedEntity?: {
+            slot?: {
+                serviceId: string;
+                scheduleId: string;
+                resource?: {
+                    _id: string;
+                };
+                location?: {
+                    locationType: LocationType;
+                };
+                flowSelectedResources: {
+                    type: Type;
+                    resourceIds: string[];
+                }[];
+            };
+            schedule?: {
+                scheduleId: string;
+                location?: {
+                    locationType: LocationType;
+                };
+            };
+        };
+        contactDetails?: {
+            fullAddress?: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                    apt: string;
+                };
+                subdivisions: {
+                    code: string;
+                    name: string;
+                }[];
+            };
+        };
+        additionalFields: {
+            _id: string;
+            valueType: ValueType;
+        }[];
+        status: BookingStatus;
+        paymentStatus: PaymentStatus;
+        selectedPaymentOption: SelectedPaymentOption;
+        createdBy?: {
+            anonymousVisitorId: string;
+            memberId: string;
+            wixUserId: string;
+            appId: string;
+        };
+    };
+}
+export interface UpdateExtendedFieldsResponseNonNullableFields {
+    namespace: string;
+}
+export interface DeclineBookingResponseNonNullableFields {
+    booking?: {
+        totalParticipants: number;
+        participantsChoices?: {
+            serviceChoices: {
+                choices: {
+                    custom: string;
+                    optionId: string;
+                }[];
+            }[];
+        };
+        bookedEntity?: {
+            slot?: {
+                serviceId: string;
+                scheduleId: string;
+                resource?: {
+                    _id: string;
+                };
+                location?: {
+                    locationType: LocationType;
+                };
+                flowSelectedResources: {
+                    type: Type;
+                    resourceIds: string[];
+                }[];
+            };
+            schedule?: {
+                scheduleId: string;
+                location?: {
+                    locationType: LocationType;
+                };
+            };
+        };
+        contactDetails?: {
+            fullAddress?: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                    apt: string;
+                };
+                subdivisions: {
+                    code: string;
+                    name: string;
+                }[];
+            };
+        };
+        additionalFields: {
+            _id: string;
+            valueType: ValueType;
+        }[];
+        status: BookingStatus;
+        paymentStatus: PaymentStatus;
+        selectedPaymentOption: SelectedPaymentOption;
+        createdBy?: {
+            anonymousVisitorId: string;
+            memberId: string;
+            wixUserId: string;
+            appId: string;
+        };
+    };
+}
+export interface CancelBookingResponseNonNullableFields {
+    booking?: {
+        totalParticipants: number;
+        participantsChoices?: {
+            serviceChoices: {
+                choices: {
+                    custom: string;
+                    optionId: string;
+                }[];
+            }[];
+        };
+        bookedEntity?: {
+            slot?: {
+                serviceId: string;
+                scheduleId: string;
+                resource?: {
+                    _id: string;
+                };
+                location?: {
+                    locationType: LocationType;
+                };
+                flowSelectedResources: {
+                    type: Type;
+                    resourceIds: string[];
+                }[];
+            };
+            schedule?: {
+                scheduleId: string;
+                location?: {
+                    locationType: LocationType;
+                };
+            };
+        };
+        contactDetails?: {
+            fullAddress?: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                    apt: string;
+                };
+                subdivisions: {
+                    code: string;
+                    name: string;
+                }[];
+            };
+        };
+        additionalFields: {
+            _id: string;
+            valueType: ValueType;
+        }[];
+        status: BookingStatus;
+        paymentStatus: PaymentStatus;
+        selectedPaymentOption: SelectedPaymentOption;
+        createdBy?: {
+            anonymousVisitorId: string;
+            memberId: string;
+            wixUserId: string;
+            appId: string;
+        };
+    };
+}
+export interface UpdateNumberOfParticipantsResponseNonNullableFields {
+    booking?: {
+        totalParticipants: number;
+        participantsChoices?: {
+            serviceChoices: {
+                choices: {
+                    custom: string;
+                    optionId: string;
+                }[];
+            }[];
+        };
+        bookedEntity?: {
+            slot?: {
+                serviceId: string;
+                scheduleId: string;
+                resource?: {
+                    _id: string;
+                };
+                location?: {
+                    locationType: LocationType;
+                };
+                flowSelectedResources: {
+                    type: Type;
+                    resourceIds: string[];
+                }[];
+            };
+            schedule?: {
+                scheduleId: string;
+                location?: {
+                    locationType: LocationType;
+                };
+            };
+        };
+        contactDetails?: {
+            fullAddress?: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                    apt: string;
+                };
+                subdivisions: {
+                    code: string;
+                    name: string;
+                }[];
+            };
+        };
+        additionalFields: {
+            _id: string;
+            valueType: ValueType;
+        }[];
+        status: BookingStatus;
+        paymentStatus: PaymentStatus;
+        selectedPaymentOption: SelectedPaymentOption;
+        createdBy?: {
+            anonymousVisitorId: string;
+            memberId: string;
+            wixUserId: string;
+            appId: string;
+        };
+    };
+}
+export interface ConfirmOrDeclineBookingResponseNonNullableFields {
+    booking?: {
+        totalParticipants: number;
+        participantsChoices?: {
+            serviceChoices: {
+                choices: {
+                    custom: string;
+                    optionId: string;
+                }[];
+            }[];
+        };
+        bookedEntity?: {
+            slot?: {
+                serviceId: string;
+                scheduleId: string;
+                resource?: {
+                    _id: string;
+                };
+                location?: {
+                    locationType: LocationType;
+                };
+                flowSelectedResources: {
+                    type: Type;
+                    resourceIds: string[];
+                }[];
+            };
+            schedule?: {
+                scheduleId: string;
+                location?: {
+                    locationType: LocationType;
+                };
+            };
+        };
+        contactDetails?: {
+            fullAddress?: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                    apt: string;
+                };
+                subdivisions: {
+                    code: string;
+                    name: string;
+                }[];
+            };
+        };
+        additionalFields: {
+            _id: string;
+            valueType: ValueType;
+        }[];
+        status: BookingStatus;
+        paymentStatus: PaymentStatus;
+        selectedPaymentOption: SelectedPaymentOption;
+        createdBy?: {
+            anonymousVisitorId: string;
+            memberId: string;
+            wixUserId: string;
+            appId: string;
+        };
+    };
+}
+export interface BulkConfirmOrDeclineBookingResponseNonNullableFields {
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        item?: {
+            totalParticipants: number;
+            participantsChoices?: {
+                serviceChoices: {
+                    choices: {
+                        custom: string;
+                        optionId: string;
+                    }[];
+                }[];
+            };
+            bookedEntity?: {
+                slot?: {
+                    serviceId: string;
+                    scheduleId: string;
+                    resource?: {
+                        _id: string;
+                    };
+                    location?: {
+                        locationType: LocationType;
+                    };
+                    flowSelectedResources: {
+                        type: Type;
+                        resourceIds: string[];
+                    }[];
+                };
+                schedule?: {
+                    scheduleId: string;
+                    location?: {
+                        locationType: LocationType;
+                    };
+                };
+            };
+            contactDetails?: {
+                fullAddress?: {
+                    streetAddress?: {
+                        number: string;
+                        name: string;
+                        apt: string;
+                    };
+                    subdivisions: {
+                        code: string;
+                        name: string;
+                    }[];
+                };
+            };
+            additionalFields: {
+                _id: string;
+                valueType: ValueType;
+            }[];
+            status: BookingStatus;
+            paymentStatus: PaymentStatus;
+            selectedPaymentOption: SelectedPaymentOption;
+            createdBy?: {
+                anonymousVisitorId: string;
+                memberId: string;
+                wixUserId: string;
+                appId: string;
+            };
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
 /**
  * Creates a booking.
  *
@@ -2130,7 +2718,7 @@ export interface V2UpdateNumberOfParticipantsResponse {
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
  */
-export declare function createBooking(booking: Booking, options?: CreateBookingOptions): Promise<CreateBookingResponse>;
+export declare function createBooking(booking: Booking, options?: CreateBookingOptions): Promise<CreateBookingResponse & CreateBookingResponseNonNullableFields>;
 export interface CreateBookingOptions {
     /** Information about a message to send to the customer. */
     participantNotification?: ParticipantNotification;
@@ -2169,7 +2757,7 @@ export interface CreateBookingOptions {
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
  */
-export declare function bulkCreateBooking(createBookingsInfo: CreateBookingInfo[], options?: BulkCreateBookingOptions): Promise<BulkCreateBookingResponse>;
+export declare function bulkCreateBooking(createBookingsInfo: CreateBookingInfo[], options?: BulkCreateBookingOptions): Promise<BulkCreateBookingResponse & BulkCreateBookingResponseNonNullableFields>;
 export interface BulkCreateBookingOptions {
     /** Whether to return the created bookings entities. */
     returnFullEntity?: boolean;
@@ -2212,7 +2800,6 @@ export interface BulkCreateBookingOptions {
  * @public
  * @documentationMaturity preview
  * @requiredField bookingId
- * @requiredField options
  * @requiredField options.revision
  * @requiredField slot
  * @param options - An object representing the available options for rescheduling a booking.
@@ -2220,7 +2807,7 @@ export interface BulkCreateBookingOptions {
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  */
-export declare function rescheduleBooking(bookingId: string, slot: V2Slot, options: RescheduleBookingOptions): Promise<RescheduleBookingResponse>;
+export declare function rescheduleBooking(bookingId: string, slot: V2Slot, options?: RescheduleBookingOptions): Promise<RescheduleBookingResponse & RescheduleBookingResponseNonNullableFields>;
 export interface RescheduleBookingOptions extends RescheduleBookingRequestParticipantsInfoOneOf {
     /**
      * Revision number, which increments by 1 each time the booking is updated.
@@ -2292,7 +2879,7 @@ export interface RescheduleBookingOptions extends RescheduleBookingRequestPartic
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function confirmBooking(bookingId: string, revision: string | null, options?: ConfirmBookingOptions): Promise<ConfirmBookingResponse>;
+export declare function confirmBooking(bookingId: string, revision: string | null, options?: ConfirmBookingOptions): Promise<ConfirmBookingResponse & ConfirmBookingResponseNonNullableFields>;
 export interface ConfirmBookingOptions {
     /**
      * Information about whether to notify the customer about the confirmation and
@@ -2341,7 +2928,7 @@ export interface ConfirmBookingOptions {
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse>;
+export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
 export interface UpdateExtendedFieldsOptions {
     /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
     namespaceData: Record<string, any> | null;
@@ -2372,7 +2959,7 @@ export interface UpdateExtendedFieldsOptions {
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function declineBooking(bookingId: string, revision: string | null, options?: DeclineBookingOptions): Promise<DeclineBookingResponse>;
+export declare function declineBooking(bookingId: string, revision: string | null, options?: DeclineBookingOptions): Promise<DeclineBookingResponse & DeclineBookingResponseNonNullableFields>;
 export interface DeclineBookingOptions {
     /**
      * Information about whether to notify the customer about the decline and
@@ -2417,14 +3004,13 @@ export interface DeclineBookingOptions {
  * @public
  * @documentationMaturity preview
  * @requiredField bookingId
- * @requiredField options
  * @requiredField options.revision
  * @param options - An object representing the available options for canceling a booking.
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  */
-export declare function cancelBooking(bookingId: string, options: CancelBookingOptions): Promise<CancelBookingResponse>;
+export declare function cancelBooking(bookingId: string, options?: CancelBookingOptions): Promise<CancelBookingResponse & CancelBookingResponseNonNullableFields>;
 export interface CancelBookingOptions {
     /**
      * Information about whether to notify the customer about the cancelation and
@@ -2465,12 +3051,11 @@ export interface CancelBookingOptions {
  * @public
  * @documentationMaturity preview
  * @requiredField bookingId
- * @requiredField options
  * @requiredField options.revision
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function updateNumberOfParticipants(bookingId: string, options: UpdateNumberOfParticipantsOptions): Promise<UpdateNumberOfParticipantsResponse>;
+export declare function updateNumberOfParticipants(bookingId: string, options?: UpdateNumberOfParticipantsOptions): Promise<UpdateNumberOfParticipantsResponse & UpdateNumberOfParticipantsResponseNonNullableFields>;
 export interface UpdateNumberOfParticipantsOptions extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
     /**
      * Revision number, which increments by 1 each time the booking is updated.
@@ -2504,7 +3089,7 @@ export interface UpdateNumberOfParticipantsOptions extends UpdateNumberOfPartici
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function confirmOrDeclineBooking(bookingId: string, options?: ConfirmOrDeclineBookingOptions): Promise<ConfirmOrDeclineBookingResponse>;
+export declare function confirmOrDeclineBooking(bookingId: string, options?: ConfirmOrDeclineBookingOptions): Promise<ConfirmOrDeclineBookingResponse & ConfirmOrDeclineBookingResponseNonNullableFields>;
 export interface ConfirmOrDeclineBookingOptions {
     /** Current payment status of the booking. */
     paymentStatus?: PaymentStatus;
@@ -2520,7 +3105,7 @@ export interface ConfirmOrDeclineBookingOptions {
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function bulkConfirmOrDeclineBooking(details: BulkConfirmOrDeclineBookingRequestBookingDetails[], options?: BulkConfirmOrDeclineBookingOptions): Promise<BulkConfirmOrDeclineBookingResponse>;
+export declare function bulkConfirmOrDeclineBooking(details: BulkConfirmOrDeclineBookingRequestBookingDetails[], options?: BulkConfirmOrDeclineBookingOptions): Promise<BulkConfirmOrDeclineBookingResponse & BulkConfirmOrDeclineBookingResponseNonNullableFields>;
 export interface BulkConfirmOrDeclineBookingOptions {
     /**
      * Whether to return the confirmed or declined bookings entities.