@wix/bookings 1.0.231 → 1.0.233

package/build/cjs/src/bookings-catalog-v1-resource.types.d.ts

@@ -930,313 +930,6 @@ export interface UnLinkResourceFromOwnerResponse {
     /** The updated resource. */
     resource?: Resource;
 }
-export interface ListResourcesResponseNonNullableFields {
-    resources: {
-        images: {
-            id: string;
-            url: string;
-            height: number;
-            width: number;
-        }[];
-        schedules: {
-            id: string;
-            intervals: {
-                id: string;
-                interval?: {
-                    daysOfWeek: Day;
-                    duration: number;
-                };
-                affectedSchedules: {
-                    scheduleId: string;
-                    transparency: Transparency;
-                    scheduleOwnerId: string;
-                }[];
-                intervalType: RecurringIntervalType;
-            }[];
-            location?: {
-                locationType: LocationType;
-                customAddress?: {
-                    streetAddress?: {
-                        number: string;
-                        name: string;
-                        apt: string;
-                    };
-                    subdivisions: {
-                        code: string;
-                        name: string;
-                    }[];
-                };
-                businessLocation?: {
-                    name: string;
-                    default: boolean;
-                    status: LocationStatus;
-                    locationType: LocationsLocationType;
-                    address?: {
-                        streetAddress?: {
-                            number: string;
-                            name: string;
-                            apt: string;
-                        };
-                    };
-                    businessSchedule?: {
-                        periods: {
-                            openDay: DayOfWeek;
-                            openTime: string;
-                            closeDay: DayOfWeek;
-                            closeTime: string;
-                        }[];
-                        specialHourPeriod: {
-                            startDate: string;
-                            endDate: string;
-                            isClosed: boolean;
-                            comment: string;
-                        }[];
-                    };
-                    archived: boolean;
-                };
-            };
-            rate?: {
-                labeledPriceOptions?: {
-                    amount: string;
-                    currency: string;
-                    downPayAmount: string;
-                };
-                defaultVariedPrice?: {
-                    amount: string;
-                    currency: string;
-                    downPayAmount: string;
-                };
-            };
-            availability?: {
-                linkedSchedules: {
-                    scheduleId: string;
-                    transparency: Transparency;
-                    scheduleOwnerId: string;
-                }[];
-                constraints?: {
-                    slotDurations: number[];
-                    timeBetweenSlots: number;
-                };
-                locations: {
-                    locationType: LocationType;
-                    customAddress?: {
-                        streetAddress?: {
-                            number: string;
-                            name: string;
-                            apt: string;
-                        };
-                        subdivisions: {
-                            code: string;
-                            name: string;
-                        }[];
-                    };
-                    businessLocation?: {
-                        name: string;
-                        default: boolean;
-                        status: LocationStatus;
-                        locationType: LocationsLocationType;
-                        address?: {
-                            streetAddress?: {
-                                number: string;
-                                name: string;
-                                apt: string;
-                            };
-                        };
-                        businessSchedule?: {
-                            periods: {
-                                openDay: DayOfWeek;
-                                openTime: string;
-                                closeDay: DayOfWeek;
-                                closeTime: string;
-                            }[];
-                            specialHourPeriod: {
-                                startDate: string;
-                                endDate: string;
-                                isClosed: boolean;
-                                comment: string;
-                            }[];
-                        };
-                        archived: boolean;
-                    };
-                }[];
-            };
-            totalNumberOfParticipants: number;
-            participants: {
-                id: string;
-                partySize: number;
-                approvalStatus: ApprovalStatus;
-                inherited: boolean;
-            }[];
-            status: ScheduleStatus;
-            version: number;
-            inheritedFields: string[];
-            conferenceProvider?: {
-                providerId: string;
-            };
-            calendarConference?: {
-                id: string;
-                externalId: string;
-                providerId: string;
-                hostUrl: string;
-                guestUrl: string;
-                conferenceType: ConferenceType;
-            };
-        }[];
-        status: ResourceStatus;
-        businessLocation?: {
-            locationId: string;
-        };
-        eventsSchedule?: {
-            id: string;
-            intervals: {
-                id: string;
-                interval?: {
-                    daysOfWeek: Day;
-                    duration: number;
-                };
-                affectedSchedules: {
-                    scheduleId: string;
-                    transparency: Transparency;
-                    scheduleOwnerId: string;
-                }[];
-                intervalType: RecurringIntervalType;
-            }[];
-            location?: {
-                locationType: LocationType;
-                customAddress?: {
-                    streetAddress?: {
-                        number: string;
-                        name: string;
-                        apt: string;
-                    };
-                    subdivisions: {
-                        code: string;
-                        name: string;
-                    }[];
-                };
-                businessLocation?: {
-                    name: string;
-                    default: boolean;
-                    status: LocationStatus;
-                    locationType: LocationsLocationType;
-                    address?: {
-                        streetAddress?: {
-                            number: string;
-                            name: string;
-                            apt: string;
-                        };
-                    };
-                    businessSchedule?: {
-                        periods: {
-                            openDay: DayOfWeek;
-                            openTime: string;
-                            closeDay: DayOfWeek;
-                            closeTime: string;
-                        }[];
-                        specialHourPeriod: {
-                            startDate: string;
-                            endDate: string;
-                            isClosed: boolean;
-                            comment: string;
-                        }[];
-                    };
-                    archived: boolean;
-                };
-            };
-            rate?: {
-                labeledPriceOptions?: {
-                    amount: string;
-                    currency: string;
-                    downPayAmount: string;
-                };
-                defaultVariedPrice?: {
-                    amount: string;
-                    currency: string;
-                    downPayAmount: string;
-                };
-            };
-            availability?: {
-                linkedSchedules: {
-                    scheduleId: string;
-                    transparency: Transparency;
-                    scheduleOwnerId: string;
-                }[];
-                constraints?: {
-                    slotDurations: number[];
-                    timeBetweenSlots: number;
-                };
-                locations: {
-                    locationType: LocationType;
-                    customAddress?: {
-                        streetAddress?: {
-                            number: string;
-                            name: string;
-                            apt: string;
-                        };
-                        subdivisions: {
-                            code: string;
-                            name: string;
-                        }[];
-                    };
-                    businessLocation?: {
-                        name: string;
-                        default: boolean;
-                        status: LocationStatus;
-                        locationType: LocationsLocationType;
-                        address?: {
-                            streetAddress?: {
-                                number: string;
-                                name: string;
-                                apt: string;
-                            };
-                        };
-                        businessSchedule?: {
-                            periods: {
-                                openDay: DayOfWeek;
-                                openTime: string;
-                                closeDay: DayOfWeek;
-                                closeTime: string;
-                            }[];
-                            specialHourPeriod: {
-                                startDate: string;
-                                endDate: string;
-                                isClosed: boolean;
-                                comment: string;
-                            }[];
-                        };
-                        archived: boolean;
-                    };
-                }[];
-            };
-            totalNumberOfParticipants: number;
-            participants: {
-                id: string;
-                partySize: number;
-                approvalStatus: ApprovalStatus;
-                inherited: boolean;
-            }[];
-            status: ScheduleStatus;
-            version: number;
-            inheritedFields: string[];
-            conferenceProvider?: {
-                providerId: string;
-            };
-            calendarConference?: {
-                id: string;
-                externalId: string;
-                providerId: string;
-                hostUrl: string;
-                guestUrl: string;
-                conferenceType: ConferenceType;
-            };
-        };
-    }[];
-    metadata?: {
-        items: number;
-        offset: number;
-        totalCount: number;
-    };
-}
 export interface QueryResourcesResponseNonNullableFields {
     resources: {
         images: {

package/build/cjs/src/bookings-catalog-v1-resource.universal.d.ts

@@ -924,86 +924,6 @@ export interface UnLinkResourceFromOwnerResponse {
     /** The updated resource. */
     resource?: Resource;
 }
-export interface ListResourcesResponseNonNullableFields {
-    resources: {
-        images: string;
-        schedules: {
-            _id: string;
-            intervals: {
-                _id: string;
-                interval?: {
-                    daysOfWeek: Day;
-                    duration: number;
-                };
-                affectedSchedules: {
-                    scheduleId: string;
-                    transparency: Transparency;
-                    scheduleOwnerId: string;
-                }[];
-                intervalType: RecurringIntervalType;
-            }[];
-            location?: {
-                locationType: LocationType;
-                customAddress?: {
-                    streetAddress?: {
-                        number: string;
-                        name: string;
-                        apt: string;
-                    };
-                    subdivisions: {
-                        code: string;
-                        name: string;
-                    }[];
-                };
-            };
-            rate?: {
-                labeledPriceOptions?: {
-                    amount: string;
-                    currency: string;
-                    downPayAmount: string;
-                };
-            };
-            availability?: {
-                linkedSchedules: {
-                    scheduleId: string;
-                    transparency: Transparency;
-                    scheduleOwnerId: string;
-                }[];
-                constraints?: {
-                    slotDurations: number[];
-                    timeBetweenSlots: number;
-                };
-            };
-            totalNumberOfParticipants: number;
-            participants: {
-                _id: string;
-                partySize: number;
-                approvalStatus: ApprovalStatus;
-                inherited: boolean;
-            }[];
-            status: ScheduleStatus;
-            version: number;
-            inheritedFields: string[];
-            conferenceProvider?: {
-                providerId: string;
-            };
-            calendarConference?: {
-                _id: string;
-                externalId: string;
-                providerId: string;
-                hostUrl: string;
-                guestUrl: string;
-                conferenceType: ConferenceType;
-            };
-        }[];
-        status: ResourceStatus;
-    }[];
-    metadata?: {
-        items: number;
-        offset: number;
-        totalCount: number;
-    };
-}
 export interface QueryResourcesResponseNonNullableFields {
     resources: {
         images: string;
@@ -1512,21 +1432,6 @@ export interface UpdateScheduleResponseNonNullableFields {
 export interface DeleteResourceResponseNonNullableFields {
     _id: string;
 }
-/**
- * @internal
- * @public
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScope Read Bookings - Public Data
- * @permissionScope Read bookings calendar - including participants
- * @permissionScope Read Bookings Calendar
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function list(options?: ListOptions): Promise<ListResourcesResponse & ListResourcesResponseNonNullableFields>;
-export interface ListOptions {
-    query?: Query;
-}
 /**
  * Retrieves a list of the resources according to the specified filters and paging.
  *
@@ -1559,54 +1464,33 @@ export interface ListOptions {
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
  */
-export declare function query(options?: QueryOptions): Promise<QueryResourcesResponse & QueryResourcesResponseNonNullableFields>;
-export interface QueryOptions {
+export declare function queryResources(options?: QueryResourcesOptions): Promise<QueryResourcesResponse & QueryResourcesResponseNonNullableFields>;
+export interface QueryResourcesOptions {
     query?: QueryV2;
 }
 /**
  * Creates a resource.
- * <!--ONLY:VELO
- * The `createResource()` function returns a Promise that resolves to the created resource.
- * <!--END:ONLY:VELO-->
  *
- * Bookings resources are created with a schedule. The schedule and its sessions determine the resource's availability. Note that the schedule must contain a start date in the `availability.start` property.
- * For resources that are available during the business's default hours, add the business's schedule as a linked schedule in the resource's schedule. For resources that have their own hours, create sessions with type `"WORKING_HOURS"` using the resource's schedule.
- * You can use both individual and recurring sessions to define resource availability. You cannot use availability constraints for resource schedules.
  *
- * <!--ONLY:VELO
- * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
- * + If the resource uses the default business hours, get the business resource's schedule ID  and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
- * + If the resource has its own custom working hours, create the resource, then create sessions of type `"WORKING_HOURS"` using the [`createSession()`](wix-bookings-backend.Sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
- * + You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
- *
- * > **Notes:**
- * > + The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working.
- * > + The Wix Bookings app does not show non-recurring `WORKING_HOURS` sessions in the resource calendar.
- * > + You can only add the business resource's schedule as a linked schedule for a resource.
- * > + A resource can have one schedule only.
- * > + You can have up to 135 active resources and an additional 135 deleted resources.
- * > + Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can create a resource. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
- * <!--END:ONLY:VELO-->
- *
- * <!--ONLY:REST-->
- * Use the following steps to create resources:
- * - Create the resource using including schedule information.
- * - If the resource uses the default business hours, get the business resource's schedule ID  and include it in the `scheduleInfo.availability.linkedSchedules` array in the in the schedule parameters.
- * - If the resource has its own custom working hours, create sessions of type `"WORKING_HOURS"`. Use the `scheduleId` of the new resource when creating the sessions. These session can be single sessions or recurring sessions. You can have both business hours and custom hours for the same resource schedule.
+ * The `createResource()` function returns a Promise that resolves to the created resource.
+ * Bookings resources are created with a schedule. The schedule and its sessions determine the resource's availability. Note that the schedule must contain a start date in the availability.start property. For resources that are available during the business's default hours, add the business's schedule as a linked schedule in the resource's schedule. For resources that have their own hours, create sessions with type `WORKING_HOURS` using the resource's schedule. You can use both individual and recurring sessions to define resource availability. You cannot use availability constraints for resource schedules.
  *
- * >**Notes:**
- * > + A resource can have one schedule only.
- * > + You can have up to 135 active resources and an additional 135 deleted resources.
- * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.
  *
+ * When creating a resource using `createResource()`, include the resource's schedule information. Set the schedule information as follows:
+ * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the `scheduleInfo` parameter. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.
+ * - If the resource has its own custom working hours, create the resource, then create sessions of type `WORKING_HOURS` using the [`createSession()`](wix-bookings-v2/sessions/createsession) function. Use the `scheduleId` returned from `createResource()` when creating the sessions. These session can be single sessions or recurring sessions.
+ * - You can have both default business hours and custom hours for the same resource schedule by combining the steps above.
  *
  *
- * >**Permissions:**
- * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
- * <!--END:ONLY:REST-->
+ * > **Notes:**
+ * - The Wix Bookings app does not show both default business hours and custom hours on the **Staff** page in the dashboard. If you've set up both custom and default business hours, only the default business hours will appear in the app, although both are working.
+ * - The Wix Bookings app does not show non-recurring `WORKING_HOURS` sessions in the resource calendar.
+ * - You can only add the business resource's schedule as a linked schedule for a resource.
+ * - A resource can have one schedule only.
+ * - You can have up to 135 active resources and an additional 135 deleted resources.
+ * - Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can create a resource.
  * @param resource - Resource details.
  * @public
- * @documentationMaturity preview
  * @requiredField options.schedules.availability.start
  * @requiredField options.schedules.intervals.start
  * @requiredField resource
@@ -1614,8 +1498,8 @@ export interface QueryOptions {
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function create(resource: Resource, options?: CreateOptions): Promise<CreateResourceResponse & CreateResourceResponseNonNullableFields>;
-export interface CreateOptions {
+export declare function createResource(resource: Resource, options?: CreateResourceOptions): Promise<CreateResourceResponse & CreateResourceResponseNonNullableFields>;
+export interface CreateResourceOptions {
     /**
      * List of schedules to be assigned for the created resource. Currently only a single schedule is allowed.
      * If provided, any schedules in the resource entity will be ignored.
@@ -1624,35 +1508,22 @@ export interface CreateOptions {
 }
 /**
  * Updates a resource.
- * <!--ONLY:VELO
- * The `updateResource()` function returns a Promise that resolves when a resource is updated.
- * Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](wix-bookings-backend/resource/updateresourceschedule).
  *
- * >**Notes:**
- * > + When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`.
- * > + Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
- * <!--END:ONLY:VELO-->
- * <!--ONLY:REST-->
- * Use this endpoint to update all resource information except for the resource's schedule. To update a resource's schedule use
- * the [Update Schedule](https://dev.wix.com/api/rest/wix-bookings/resources/update-schedule) endpoint.
  *
- * >**Notes:**
- * > + When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`.
- * > + When updating a resource's schedule you cannot change the resource tag used by the Wix Bookings app. Tags used by the app have the values `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE”`.
- * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.
+ * The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateResourceSchedule()`](#updateresourceschedule).
  *
- * >**Permissions:**
- * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
- * <!--END:ONLY:REST-->
+ *
+ * >**Notes:**
+ * - When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`.
+ * - Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can update a resource.
  * @param _id - Resource ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function update(_id: string | null, options?: UpdateOptions): Promise<UpdateResourceResponse & UpdateResourceResponseNonNullableFields>;
-export interface UpdateOptions {
+export declare function updateResource(_id: string | null, options?: UpdateResourceOptions): Promise<UpdateResourceResponse & UpdateResourceResponseNonNullableFields>;
+export interface UpdateResourceOptions {
     resource: {
         /**
          * Resource ID.
@@ -1667,17 +1538,13 @@ export interface UpdateOptions {
         phone?: string | null;
         /** Resource description. */
         description?: string | null;
-        /**
-         * @internal
-         * @internal */
+        /** @internal */
         tag?: string | null;
         /** Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'. */
         tags?: string[] | null;
         /** Resource images. */
         images?: string[];
-        /**
-         * @internal
-         * @internal */
+        /** @internal */
         schedules?: Schedule[];
         /**
          * List of IDs of schedules owned by this resource.
@@ -1777,28 +1644,19 @@ export interface UpdateScheduleOptions {
 }
 /**
  * Deletes a resource.
- * <!--ONLY:VELO
+ *
  * The `deleteResource()` function returns a Promise that is resolved when a resource is deleted.
- * <!--END:ONLY:VELO-->
- * Deleting a resource updates its `status` to `"DELETED"`.
+ *
+ *
+ * Deleting a resource updates its status to `DELETED`.
  *
  * You cannot delete a resource if it has booked sessions.
  *
- * <!--ONLY:VELO
- * >**Notes:**
- * > + The Bookings app automatically creates a resource with a name and tag of value `"business"``. This resource is used for the business's schedule and working hours and cannot be deleted.
- * > + You can have up to 135 active resources and an additional 135 deleted resources.
- * > + Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can delete a resource. You can override the role permissions by setting the `options.suppressAuth` parameter to `true`.
- * <!--END:ONLY:VELO-->
  *
- * <!--ONLY:REST-->
  * >**Notes:**
- * > + The Bookings app creates a resource with `"business"` in name and tag values. This resource is used for the business's schedule and working hours and cannot be deleted.
- * > + You can have up to 135 active resources and an additional 135 deleted resources.
- *
- * >**Permissions:**
- * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).
- * <!--END:ONLY:REST-->
+ * - The Bookings app automatically creates a resource with a name and tag of value `business`. This resource is used for the business's schedule and working hours and cannot be deleted.
+ * - You can have up to 135 active resources and an additional 135 deleted resources.
+ * - Only users with the **Bookings Admin** [role](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin) can delete a resource.
  * @param _id - ID of the resource to delete.
  * @public
  * @documentationMaturity preview
@@ -1806,4 +1664,4 @@ export interface UpdateScheduleOptions {
  * @permissionScope Manage Bookings
  * @applicableIdentity APP
  */
-export declare function _delete(_id: string): Promise<DeleteResourceResponse & DeleteResourceResponseNonNullableFields>;
+export declare function deleteResource(_id: string): Promise<DeleteResourceResponse & DeleteResourceResponseNonNullableFields>;