@wix/auto_sdk_bookings_categories 1.0.7 → 1.0.9

package/build/{internal/cjs/src/bookings-v1-category-categories.types.d.ts → bookings-v1-category-categories.universal-D73Eabxz.d.mts}

@@ -1,33 +1,24 @@
 /** Categories are used to group multiple services together. A service must be associated with a category in order to be exposed in the Wix Bookings UI. */
-export interface Category {
+interface Category {
     /**
      * Category ID.
      * @format GUID
      * @readonly
      */
-    id?: string | null;
+    _id?: string | null;
     /**
      * Category name.
      * @maxLength 500
      */
     name?: string | null;
-    /**
-     * Category status.
-     *
-     * Default: `CREATED`
-     * @readonly
-     */
-    status?: Status;
-    /** Sort order of the category in the live site and dashboard. */
-    sortOrder?: number | null;
 }
-export declare enum Status {
+declare enum Status {
     /** The category was created. */
     CREATED = "CREATED",
     /** The category was deleted. */
     DELETED = "DELETED"
 }
-export interface ListCategoryRequest {
+interface ListCategoryRequest {
     /**
      * IDs of the categories to retrieve.
      *
@@ -35,23 +26,17 @@ export interface ListCategoryRequest {
      * @format GUID
      */
     categoryIds?: string[];
-    /**
-     * Whether to include deleted categories in the response.
-     *
-     * Default: `false`
-     */
-    includeDeleted?: boolean | null;
 }
-export interface ListCategoryResponse {
+interface ListCategoryResponse {
     /** Retrieved categories. */
     categories?: Category[];
 }
 /** An event sent every time a category entity is changed. */
-export interface CategoryNotification {
+interface CategoryNotification {
     category?: Category;
     event?: Event;
 }
-export declare enum Event {
+declare enum Event {
     /** Category was updated. */
     Updated = "Updated",
     /** Category was deleted. */
@@ -59,36 +44,36 @@ export declare enum Event {
     /** Category was created. */
     Created = "Created"
 }
-export interface CreateCategoryRequest {
+interface CreateCategoryRequest {
     /** Category to create. */
     category: Category;
 }
-export interface CreateCategoryResponse {
+interface CreateCategoryResponse {
     /** Created category. */
     category?: Category;
 }
-export interface BatchCreateCategoryRequest {
+interface BatchCreateCategoryRequest {
     /** Categories to create. */
     categories?: Category[];
 }
-export interface BatchCreateCategoryResponse {
+interface BatchCreateCategoryResponse {
     /** Created categories. */
     categories?: Category[];
 }
-export interface UpdateCategoryRequest {
+interface UpdateCategoryRequest {
     /** Category to update. */
     category: Category;
 }
-export interface UpdateCategoryResponse {
+interface UpdateCategoryResponse {
     /** Updated category. */
     category?: Category;
 }
-export interface DeleteCategoryRequest {
+interface DeleteCategoryRequest {
     /**
      * ID of the category to delete.
      * @format GUID
      */
-    id: string | null;
+    _id: string | null;
     /**
      * Whether to delete all the services associated with the category.
      *
@@ -96,31 +81,31 @@ export interface DeleteCategoryRequest {
      */
     deleteServices?: boolean | null;
 }
-export interface DeleteCategoryResponse {
+interface DeleteCategoryResponse {
     /**
      * ID of the deleted category.
      * @format GUID
      */
-    id?: string | null;
+    _id?: string | null;
 }
-export interface BatchDeleteCategoryRequest {
+interface BatchDeleteCategoryRequest {
     /**
      * IDs of the categories to delete.
      * @format GUID
      */
     ids?: string[] | null;
 }
-export interface BatchDeleteCategoryResponse {
+interface BatchDeleteCategoryResponse {
 }
-export interface BatchUpdateCategoryRequest {
+interface BatchUpdateCategoryRequest {
     /** List of categories to be updated. */
     categories?: Category[];
     /** Field mask of fields to update. */
     fieldMask?: string[];
 }
-export interface BatchUpdateCategoryResponse {
+interface BatchUpdateCategoryResponse {
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -136,7 +121,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -161,7 +146,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -183,10 +168,60 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface CategoryNotificationEnvelope {
+    data: CategoryNotification;
+    metadata: BaseEventMetadata;
+}
+interface ListCategoriesOptions {
+    /**
+     * IDs of the categories to retrieve.
+     *
+     * Default: All categories are retrieved.
+     * @format GUID
+     */
+    categoryIds?: string[];
+}
+interface UpdateCategory {
+    /**
+     * Category ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Category name.
+     * @maxLength 500
+     */
+    name?: string | null;
+}
+interface DeleteCategoryOptions {
+    /**
+     * Whether to delete all the services associated with the category.
+     *
+     * Default: `false`
+     */
+    deleteServices?: boolean | null;
+}
+
+export { type BatchCreateCategoryRequest as B, type Category as C, type DeleteCategoryOptions as D, Event as E, type IdentificationData as I, type ListCategoriesOptions as L, type MessageEnvelope as M, Status as S, type UpdateCategory as U, WebhookIdentityType as W, type ListCategoryResponse as a, type UpdateCategoryResponse as b, type DeleteCategoryResponse as c, type ListCategoryRequest as d, type CategoryNotification as e, type CreateCategoryRequest as f, type CreateCategoryResponse as g, type BatchCreateCategoryResponse as h, type UpdateCategoryRequest as i, type DeleteCategoryRequest as j, type BatchDeleteCategoryRequest as k, type BatchDeleteCategoryResponse as l, type BatchUpdateCategoryRequest as m, type BatchUpdateCategoryResponse as n, type IdentificationDataIdOneOf as o, type BaseEventMetadata as p, type CategoryNotificationEnvelope as q };

package/build/{internal/es/src/bookings-v1-category-categories.types.d.ts → bookings-v1-category-categories.universal-D73Eabxz.d.ts}

@@ -1,33 +1,24 @@
 /** Categories are used to group multiple services together. A service must be associated with a category in order to be exposed in the Wix Bookings UI. */
-export interface Category {
+interface Category {
     /**
      * Category ID.
      * @format GUID
      * @readonly
      */
-    id?: string | null;
+    _id?: string | null;
     /**
      * Category name.
      * @maxLength 500
      */
     name?: string | null;
-    /**
-     * Category status.
-     *
-     * Default: `CREATED`
-     * @readonly
-     */
-    status?: Status;
-    /** Sort order of the category in the live site and dashboard. */
-    sortOrder?: number | null;
 }
-export declare enum Status {
+declare enum Status {
     /** The category was created. */
     CREATED = "CREATED",
     /** The category was deleted. */
     DELETED = "DELETED"
 }
-export interface ListCategoryRequest {
+interface ListCategoryRequest {
     /**
      * IDs of the categories to retrieve.
      *
@@ -35,23 +26,17 @@ export interface ListCategoryRequest {
      * @format GUID
      */
     categoryIds?: string[];
-    /**
-     * Whether to include deleted categories in the response.
-     *
-     * Default: `false`
-     */
-    includeDeleted?: boolean | null;
 }
-export interface ListCategoryResponse {
+interface ListCategoryResponse {
     /** Retrieved categories. */
     categories?: Category[];
 }
 /** An event sent every time a category entity is changed. */
-export interface CategoryNotification {
+interface CategoryNotification {
     category?: Category;
     event?: Event;
 }
-export declare enum Event {
+declare enum Event {
     /** Category was updated. */
     Updated = "Updated",
     /** Category was deleted. */
@@ -59,36 +44,36 @@ export declare enum Event {
     /** Category was created. */
     Created = "Created"
 }
-export interface CreateCategoryRequest {
+interface CreateCategoryRequest {
     /** Category to create. */
     category: Category;
 }
-export interface CreateCategoryResponse {
+interface CreateCategoryResponse {
     /** Created category. */
     category?: Category;
 }
-export interface BatchCreateCategoryRequest {
+interface BatchCreateCategoryRequest {
     /** Categories to create. */
     categories?: Category[];
 }
-export interface BatchCreateCategoryResponse {
+interface BatchCreateCategoryResponse {
     /** Created categories. */
     categories?: Category[];
 }
-export interface UpdateCategoryRequest {
+interface UpdateCategoryRequest {
     /** Category to update. */
     category: Category;
 }
-export interface UpdateCategoryResponse {
+interface UpdateCategoryResponse {
     /** Updated category. */
     category?: Category;
 }
-export interface DeleteCategoryRequest {
+interface DeleteCategoryRequest {
     /**
      * ID of the category to delete.
      * @format GUID
      */
-    id: string | null;
+    _id: string | null;
     /**
      * Whether to delete all the services associated with the category.
      *
@@ -96,31 +81,31 @@ export interface DeleteCategoryRequest {
      */
     deleteServices?: boolean | null;
 }
-export interface DeleteCategoryResponse {
+interface DeleteCategoryResponse {
     /**
      * ID of the deleted category.
      * @format GUID
      */
-    id?: string | null;
+    _id?: string | null;
 }
-export interface BatchDeleteCategoryRequest {
+interface BatchDeleteCategoryRequest {
     /**
      * IDs of the categories to delete.
      * @format GUID
      */
     ids?: string[] | null;
 }
-export interface BatchDeleteCategoryResponse {
+interface BatchDeleteCategoryResponse {
 }
-export interface BatchUpdateCategoryRequest {
+interface BatchUpdateCategoryRequest {
     /** List of categories to be updated. */
     categories?: Category[];
     /** Field mask of fields to update. */
     fieldMask?: string[];
 }
-export interface BatchUpdateCategoryResponse {
+interface BatchUpdateCategoryResponse {
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -136,7 +121,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -161,7 +146,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -183,10 +168,60 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface CategoryNotificationEnvelope {
+    data: CategoryNotification;
+    metadata: BaseEventMetadata;
+}
+interface ListCategoriesOptions {
+    /**
+     * IDs of the categories to retrieve.
+     *
+     * Default: All categories are retrieved.
+     * @format GUID
+     */
+    categoryIds?: string[];
+}
+interface UpdateCategory {
+    /**
+     * Category ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Category name.
+     * @maxLength 500
+     */
+    name?: string | null;
+}
+interface DeleteCategoryOptions {
+    /**
+     * Whether to delete all the services associated with the category.
+     *
+     * Default: `false`
+     */
+    deleteServices?: boolean | null;
+}
+
+export { type BatchCreateCategoryRequest as B, type Category as C, type DeleteCategoryOptions as D, Event as E, type IdentificationData as I, type ListCategoriesOptions as L, type MessageEnvelope as M, Status as S, type UpdateCategory as U, WebhookIdentityType as W, type ListCategoryResponse as a, type UpdateCategoryResponse as b, type DeleteCategoryResponse as c, type ListCategoryRequest as d, type CategoryNotification as e, type CreateCategoryRequest as f, type CreateCategoryResponse as g, type BatchCreateCategoryResponse as h, type UpdateCategoryRequest as i, type DeleteCategoryRequest as j, type BatchDeleteCategoryRequest as k, type BatchDeleteCategoryResponse as l, type BatchUpdateCategoryRequest as m, type BatchUpdateCategoryResponse as n, type IdentificationDataIdOneOf as o, type BaseEventMetadata as p, type CategoryNotificationEnvelope as q };

package/build/index.d.mts

@@ -0,0 +1,58 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { L as ListCategoriesOptions, a as ListCategoryResponse, C as Category, U as UpdateCategory, b as UpdateCategoryResponse, D as DeleteCategoryOptions, c as DeleteCategoryResponse } from './bookings-v1-category-categories.universal-D73Eabxz.mjs';
+export { p as BaseEventMetadata, B as BatchCreateCategoryRequest, h as BatchCreateCategoryResponse, k as BatchDeleteCategoryRequest, l as BatchDeleteCategoryResponse, m as BatchUpdateCategoryRequest, n as BatchUpdateCategoryResponse, e as CategoryNotification, q as CategoryNotificationEnvelope, f as CreateCategoryRequest, g as CreateCategoryResponse, j as DeleteCategoryRequest, E as Event, I as IdentificationData, o as IdentificationDataIdOneOf, d as ListCategoryRequest, M as MessageEnvelope, S as Status, i as UpdateCategoryRequest, W as WebhookIdentityType } from './bookings-v1-category-categories.universal-D73Eabxz.mjs';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function listCategories$1(httpClient: HttpClient): ListCategoriesSignature;
+interface ListCategoriesSignature {
+    /**
+     * Retrieves all categories.
+     * @param - Options to use when listing categories.
+     */
+    (options?: ListCategoriesOptions | undefined): Promise<ListCategoryResponse>;
+}
+declare function createCategory$1(httpClient: HttpClient): CreateCategorySignature;
+interface CreateCategorySignature {
+    /**
+     * Creates a category.
+     * @param - Category to create.
+     * @returns Created category.
+     */
+    (category: Category): Promise<Category>;
+}
+declare function updateCategory$1(httpClient: HttpClient): UpdateCategorySignature;
+interface UpdateCategorySignature {
+    /**
+     * Updates a category.
+     *
+     *
+     * Each time the category is updated, revision increments by 1. You must include
+     * the number of the existing revision when updating the category. This ensures
+     * you're working with the latest service information and prevents unintended
+     * overwrites.
+     * @param - Category ID.
+     */
+    (_id: string, category: UpdateCategory): Promise<UpdateCategoryResponse>;
+}
+declare function deleteCategory$1(httpClient: HttpClient): DeleteCategorySignature;
+interface DeleteCategorySignature {
+    /**
+     * Deletes a category.
+     *
+     *
+     * You can specify `{"deleteServices": true}` to also delete all associated
+     * services. Learn more about *deleting a service*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/delete-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/delete-service)).
+     * @param - ID of the category to delete.
+     */
+    (_id: string, options?: DeleteCategoryOptions | undefined): Promise<DeleteCategoryResponse>;
+}
+
+declare const listCategories: MaybeContext<BuildRESTFunction<typeof listCategories$1> & typeof listCategories$1>;
+declare const createCategory: MaybeContext<BuildRESTFunction<typeof createCategory$1> & typeof createCategory$1>;
+declare const updateCategory: MaybeContext<BuildRESTFunction<typeof updateCategory$1> & typeof updateCategory$1>;
+declare const deleteCategory: MaybeContext<BuildRESTFunction<typeof deleteCategory$1> & typeof deleteCategory$1>;
+/** */
+declare const onCategoryNotification: ReturnType<typeof createEventModule<typeof publicOnCategoryNotification>>;
+
+export { Category, DeleteCategoryOptions, DeleteCategoryResponse, ListCategoriesOptions, ListCategoryResponse, UpdateCategory, UpdateCategoryResponse, createCategory, deleteCategory, listCategories, onCategoryNotification, updateCategory };

package/build/index.d.ts

@@ -0,0 +1,58 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { L as ListCategoriesOptions, a as ListCategoryResponse, C as Category, U as UpdateCategory, b as UpdateCategoryResponse, D as DeleteCategoryOptions, c as DeleteCategoryResponse } from './bookings-v1-category-categories.universal-D73Eabxz.js';
+export { p as BaseEventMetadata, B as BatchCreateCategoryRequest, h as BatchCreateCategoryResponse, k as BatchDeleteCategoryRequest, l as BatchDeleteCategoryResponse, m as BatchUpdateCategoryRequest, n as BatchUpdateCategoryResponse, e as CategoryNotification, q as CategoryNotificationEnvelope, f as CreateCategoryRequest, g as CreateCategoryResponse, j as DeleteCategoryRequest, E as Event, I as IdentificationData, o as IdentificationDataIdOneOf, d as ListCategoryRequest, M as MessageEnvelope, S as Status, i as UpdateCategoryRequest, W as WebhookIdentityType } from './bookings-v1-category-categories.universal-D73Eabxz.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function listCategories$1(httpClient: HttpClient): ListCategoriesSignature;
+interface ListCategoriesSignature {
+    /**
+     * Retrieves all categories.
+     * @param - Options to use when listing categories.
+     */
+    (options?: ListCategoriesOptions | undefined): Promise<ListCategoryResponse>;
+}
+declare function createCategory$1(httpClient: HttpClient): CreateCategorySignature;
+interface CreateCategorySignature {
+    /**
+     * Creates a category.
+     * @param - Category to create.
+     * @returns Created category.
+     */
+    (category: Category): Promise<Category>;
+}
+declare function updateCategory$1(httpClient: HttpClient): UpdateCategorySignature;
+interface UpdateCategorySignature {
+    /**
+     * Updates a category.
+     *
+     *
+     * Each time the category is updated, revision increments by 1. You must include
+     * the number of the existing revision when updating the category. This ensures
+     * you're working with the latest service information and prevents unintended
+     * overwrites.
+     * @param - Category ID.
+     */
+    (_id: string, category: UpdateCategory): Promise<UpdateCategoryResponse>;
+}
+declare function deleteCategory$1(httpClient: HttpClient): DeleteCategorySignature;
+interface DeleteCategorySignature {
+    /**
+     * Deletes a category.
+     *
+     *
+     * You can specify `{"deleteServices": true}` to also delete all associated
+     * services. Learn more about *deleting a service*
+     * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/delete-service) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/delete-service)).
+     * @param - ID of the category to delete.
+     */
+    (_id: string, options?: DeleteCategoryOptions | undefined): Promise<DeleteCategoryResponse>;
+}
+
+declare const listCategories: MaybeContext<BuildRESTFunction<typeof listCategories$1> & typeof listCategories$1>;
+declare const createCategory: MaybeContext<BuildRESTFunction<typeof createCategory$1> & typeof createCategory$1>;
+declare const updateCategory: MaybeContext<BuildRESTFunction<typeof updateCategory$1> & typeof updateCategory$1>;
+declare const deleteCategory: MaybeContext<BuildRESTFunction<typeof deleteCategory$1> & typeof deleteCategory$1>;
+/** */
+declare const onCategoryNotification: ReturnType<typeof createEventModule<typeof publicOnCategoryNotification>>;
+
+export { Category, DeleteCategoryOptions, DeleteCategoryResponse, ListCategoriesOptions, ListCategoryResponse, UpdateCategory, UpdateCategoryResponse, createCategory, deleteCategory, listCategories, onCategoryNotification, updateCategory };