@wix/events 1.0.174 → 1.0.176

package/build/es/src/events-v1-category.universal.d.ts

@@ -1,588 +0,0 @@
-export interface Category {
-    /**
-     * Category ID.
-     * @readonly
-     */
-    _id?: string;
-    /** Category name. */
-    name?: string;
-    /**
-     * Category creation timestamp.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Total number of published events assigned to the category. Deleted events are excluded.
-     * @readonly
-     */
-    assignedEventsCount?: number | null;
-    /**
-     * The total number of draft and published events assigned to the category.
-     * @readonly
-     */
-    counts?: CategoryCounts;
-    /**
-     * Category state. Possible values:
-     * - `MANUAL`: Category is created manually by the user.
-     * - `AUTO`: Category is created automatically.
-     * - `RECURRING_EVENT`: Category is created automatically when publishing recurring events.
-     * - `HIDDEN`: Category can't be seen.
-     *
-     * Default: `MANUAL`.
-     *
-     * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states than `MANUAL`.
-     */
-    states?: State[];
-}
-export interface CategoryCounts {
-    /** Total number of published events assigned to the category. Deleted events are excluded. */
-    assignedEventsCount?: number | null;
-    /** Total number of draft events assigned to the category. */
-    assignedDraftEventsCount?: number | null;
-}
-export declare enum State {
-    /** Created manually by the user. */
-    MANUAL = "MANUAL",
-    /** Created automatically. */
-    AUTO = "AUTO",
-    /** Created when publishing recurring events. */
-    RECURRING_EVENT = "RECURRING_EVENT",
-    /** Category is hidden. */
-    HIDDEN = "HIDDEN",
-    /** Category is used to store component events. */
-    COMPONENT = "COMPONENT"
-}
-export interface CreateCategoryRequest {
-    /** Category to create. */
-    category: Category;
-}
-export interface CreateCategoryResponse {
-    /** Created category. */
-    category?: Category;
-}
-export interface BulkCreateCategoryRequest {
-    /** Categories to create. */
-    categories: Category[];
-}
-export interface BulkCreateCategoryResponse {
-    /** Bulk create results. */
-    results?: BulkCategoryResult[];
-    /** Metadata of results. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkCategoryResult {
-    /** Metadata. */
-    itemMetadata?: ItemMetadata;
-    /** Created categories. */
-    item?: Category;
-}
-export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    _id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
-}
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details due to exceeding the threshold for detailed failures. */
-    undetailedFailures?: number;
-}
-export interface UpdateCategoryRequest {
-    /** Category update. */
-    category: Category;
-}
-export interface UpdateCategoryResponse {
-    /** Updated category. */
-    category?: Category;
-}
-export interface DeleteCategoryRequest {
-    /** ID of category to be deleted. */
-    categoryId: string;
-}
-export interface DeleteCategoryResponse {
-}
-export interface QueryCategoriesRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
-    query: QueryV2;
-    /**
-     * Predefined sets of fields to return.
-     * - `COUNTS`: Returns `assignedEventsCount`.
-     */
-    fieldset?: CategoryFieldset[];
-}
-export interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /**
-     * Pointer to page of results using offset.
-     * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
-     */
-    paging?: Paging;
-    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
-     * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-export interface QueryV2PagingMethodOneOf {
-    /**
-     * Pointer to page of results using offset.
-     * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
-     */
-    paging?: Paging;
-}
-export interface Sorting {
-    /** Name of the field to sort by */
-    fieldName?: string;
-    /** Sort order (ASC/DESC). Defaults to ASC */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Paging {
-    /** Number of items to load per page. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export declare enum CategoryFieldset {
-    /** Include `assignedEventsCount` in the response. */
-    COUNTS = "COUNTS"
-}
-export interface QueryCategoriesResponse {
-    /** List of categories. */
-    categories?: Category[];
-    /** Metadata for the paginated results. */
-    metaData?: PagingMetadataV2;
-}
-export interface PagingMetadataV2 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
-}
-export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
-    prev?: string | null;
-}
-export interface AssignEventsRequest {
-    /** ID of category to which events should be assigned. */
-    categoryId: string;
-    /** A list of events IDs. */
-    eventId: string[];
-}
-export interface AssignEventsResponse {
-}
-export interface BulkAssignEventsRequest {
-    /** A list of category IDs to which events should be assigned. */
-    categoryId: string[];
-    /** A list of events IDs. */
-    eventId: string[];
-}
-export interface BulkAssignEventsResponse {
-    /** Results. */
-    results?: BulkCategoryResult[];
-    /** Metadata of results. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkAssignEventsAsyncRequest {
-    /** Category IDs. */
-    categoryId: string[];
-    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
-    filter: Record<string, any> | null;
-}
-export interface BulkAssignEventsAsyncResponse {
-}
-export interface UnassignEventsRequest {
-    /** Category ID. */
-    categoryId: string;
-    /** A list of events IDs. */
-    eventId: string[];
-}
-export interface UnassignEventsResponse {
-}
-export interface BulkUnassignEventsRequest {
-    /** A list of category IDs. */
-    categoryId: string[];
-    /** A list of events IDs. */
-    eventId?: string[];
-}
-export interface BulkUnassignEventsResponse {
-    /** Results. */
-    results?: BulkCategoryResult[];
-    /** Metadata of results. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkUnassignEventsAsyncRequest {
-    /** Category ID. */
-    categoryId: string[];
-    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
-    filter: Record<string, any> | null;
-}
-export interface BulkUnassignEventsAsyncResponse {
-}
-export interface ListEventCategoriesRequest {
-    /** Event ID. */
-    eventId: string;
-}
-export interface ListEventCategoriesResponse {
-    /** A list of categories. */
-    categories?: Category[];
-}
-export interface ReorderCategoryEventsRequest extends ReorderCategoryEventsRequestReferenceEventOneOf {
-    /** Move the event before defined `eventId`. */
-    beforeEventId?: string;
-    /** Move the event after defined `eventId`. */
-    afterEventId?: string;
-    /** Category ID */
-    categoryId: string;
-    /** Event ID */
-    eventId?: string;
-}
-/** @oneof */
-export interface ReorderCategoryEventsRequestReferenceEventOneOf {
-    /** Move the event before defined `eventId`. */
-    beforeEventId?: string;
-    /** Move the event after defined `eventId`. */
-    afterEventId?: string;
-}
-export interface ReorderCategoryEventsResponse {
-}
-export interface CreateCategoryResponseNonNullableFields {
-    category?: {
-        _id: string;
-        name: string;
-        states: State[];
-    };
-}
-export interface BulkCreateCategoryResponseNonNullableFields {
-    results: {
-        itemMetadata?: {
-            originalIndex: number;
-            success: boolean;
-            error?: {
-                code: string;
-                description: string;
-            };
-        };
-        item?: {
-            _id: string;
-            name: string;
-            states: State[];
-        };
-    }[];
-    bulkActionMetadata?: {
-        totalSuccesses: number;
-        totalFailures: number;
-        undetailedFailures: number;
-    };
-}
-export interface UpdateCategoryResponseNonNullableFields {
-    category?: {
-        _id: string;
-        name: string;
-        states: State[];
-    };
-}
-export interface QueryCategoriesResponseNonNullableFields {
-    categories: {
-        _id: string;
-        name: string;
-        states: State[];
-    }[];
-}
-export interface BulkAssignEventsResponseNonNullableFields {
-    results: {
-        itemMetadata?: {
-            originalIndex: number;
-            success: boolean;
-            error?: {
-                code: string;
-                description: string;
-            };
-        };
-        item?: {
-            _id: string;
-            name: string;
-            states: State[];
-        };
-    }[];
-    bulkActionMetadata?: {
-        totalSuccesses: number;
-        totalFailures: number;
-        undetailedFailures: number;
-    };
-}
-export interface BulkUnassignEventsResponseNonNullableFields {
-    results: {
-        itemMetadata?: {
-            originalIndex: number;
-            success: boolean;
-            error?: {
-                code: string;
-                description: string;
-            };
-        };
-        item?: {
-            _id: string;
-            name: string;
-            states: State[];
-        };
-    }[];
-    bulkActionMetadata?: {
-        totalSuccesses: number;
-        totalFailures: number;
-        undetailedFailures: number;
-    };
-}
-export interface ListEventCategoriesResponseNonNullableFields {
-    categories: {
-        _id: string;
-        name: string;
-        states: State[];
-    }[];
-}
-/**
- * Creates a category.
- * @public
- * @requiredField category
- * @param category - Category to create.
- * @returns Created category.
- */
-export declare function createCategory(category: Category): Promise<Category & NonNullable<CreateCategoryResponseNonNullableFields>['category']>;
-/**
- * Creates new categories.
- * @param categories - Categories to create.
- * @public
- * @requiredField categories
- */
-export declare function bulkCreateCategory(categories: Category[]): Promise<BulkCreateCategoryResponse & BulkCreateCategoryResponseNonNullableFields>;
-/**
- * Updates an existing category.
- * @param _id - Category ID.
- * @public
- * @requiredField _id
- * @requiredField category
- * @returns Updated category.
- */
-export declare function updateCategory(_id: string, category: UpdateCategory): Promise<Category & NonNullable<UpdateCategoryResponseNonNullableFields>['category']>;
-export interface UpdateCategory {
-    /**
-     * Category ID.
-     * @readonly
-     */
-    _id?: string;
-    /** Category name. */
-    name?: string;
-    /**
-     * Category creation timestamp.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Total number of published events assigned to the category. Deleted events are excluded.
-     * @readonly
-     */
-    assignedEventsCount?: number | null;
-    /**
-     * The total number of draft and published events assigned to the category.
-     * @readonly
-     */
-    counts?: CategoryCounts;
-    /**
-     * Category state. Possible values:
-     * - `MANUAL`: Category is created manually by the user.
-     * - `AUTO`: Category is created automatically.
-     * - `RECURRING_EVENT`: Category is created automatically when publishing recurring events.
-     * - `HIDDEN`: Category can't be seen.
-     *
-     * Default: `MANUAL`.
-     *
-     * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states than `MANUAL`.
-     */
-    states?: State[];
-}
-/**
- * Deletes a category.
- * @param categoryId - ID of category to be deleted.
- * @public
- * @requiredField categoryId
- */
-export declare function deleteCategory(categoryId: string): Promise<void>;
-/**
- * Creates a query to retrieve a list of categories.
- *
- *
- * The `queryCategories()` function builds a query to retrieve a list of categories and returns a [`CategoriesQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder) object.
- *
- * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/find) function.
- *
- * You can refine the query by chaining `CategoriesQueryBuilder` functions onto the query. `CategoriesQueryBuilder` functions enable you to sort, filter, and control the results `queryCategories()` returns.
- *
- * `queryCategories()` runs with these `CategoriesQueryBuilder` defaults, which you can override:
- *
- *  - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/limit)
- * @public
- * @param options - Optional fields.
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function queryCategories(options?: QueryCategoriesOptions): CategoriesQueryBuilder;
-export interface QueryCategoriesOptions {
-    /**
-     * Predefined sets of fields to return.
-     * - `COUNTS`: Returns `assignedEventsCount`.
-     */
-    fieldset?: CategoryFieldset[] | undefined;
-}
-interface QueryCursorResult {
-    cursors: Cursors;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface CategoriesQueryResult extends QueryCursorResult {
-    items: Category[];
-    query: CategoriesQueryBuilder;
-    next: () => Promise<CategoriesQueryResult>;
-    prev: () => Promise<CategoriesQueryResult>;
-}
-export interface CategoriesQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    eq: (propertyName: '_id' | 'name', value: any) => CategoriesQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
-    limit: (limit: number) => CategoriesQueryBuilder;
-    /** @param cursor - A pointer to specific record */
-    skipTo: (cursor: string) => CategoriesQueryBuilder;
-    find: () => Promise<CategoriesQueryResult>;
-}
-/**
- * Assigns events to a single category.
- * @param categoryId - ID of category to which events should be assigned.
- * @param eventId - A list of events IDs.
- * @public
- * @requiredField categoryId
- * @requiredField eventId
- */
-export declare function assignEvents(categoryId: string, eventId: string[]): Promise<void>;
-/**
- * Assigns events to multiple categories.
- * @param categoryId - A list of category IDs to which events should be assigned.
- * @public
- * @requiredField categoryId
- * @requiredField options
- * @requiredField options.eventId
- * @param options - Optional fields.
- */
-export declare function bulkAssignEvents(categoryId: string[], options: BulkAssignEventsOptions): Promise<BulkAssignEventsResponse & BulkAssignEventsResponseNonNullableFields>;
-export interface BulkAssignEventsOptions {
-    /** A list of events IDs. */
-    eventId: string[];
-}
-/**
- * Assigns filtered events to multiple categories.
- * @param categoryId - Category IDs.
- * @public
- * @requiredField categoryId
- * @requiredField options
- * @requiredField options.filter
- * @param options - Optional fields.
- */
-export declare function bulkAssignEventsAsync(categoryId: string[], options: BulkAssignEventsAsyncOptions): Promise<void>;
-export interface BulkAssignEventsAsyncOptions {
-    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
-    filter: Record<string, any> | null;
-}
-/**
- * Unassigns events from a category.
- * @param categoryId - Category ID.
- * @param eventId - A list of events IDs.
- * @public
- * @requiredField categoryId
- * @requiredField eventId
- */
-export declare function unassignEvents(categoryId: string, eventId: string[]): Promise<void>;
-/**
- * Unassigns events from multiple categories.
- * @param categoryId - A list of category IDs.
- * @public
- * @requiredField categoryId
- * @param options - Optional fields.
- */
-export declare function bulkUnassignEvents(categoryId: string[], options?: BulkUnassignEventsOptions): Promise<BulkUnassignEventsResponse & BulkUnassignEventsResponseNonNullableFields>;
-export interface BulkUnassignEventsOptions {
-    /** A list of events IDs. */
-    eventId?: string[];
-}
-/**
- * Unassigns filtered events from multiple categories.
- * @param categoryId - Category ID.
- * @public
- * @requiredField categoryId
- * @requiredField options
- * @requiredField options.filter
- * @param options - Optional fields.
- */
-export declare function bulkUnassignEventsAsync(categoryId: string[], options: BulkUnassignEventsAsyncOptions): Promise<void>;
-export interface BulkUnassignEventsAsyncOptions {
-    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
-    filter: Record<string, any> | null;
-}
-/**
- * Retrieves a list of categories that are not in the `HIDDEN` state.
- * @param eventId - Event ID.
- * @public
- * @requiredField eventId
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function listEventCategories(eventId: string): Promise<ListEventCategoriesResponse & ListEventCategoriesResponseNonNullableFields>;
-/**
- * Change the order of events that are assigned to the same category on the Events Widget.
- *
- *
- * For more information see [this aricle](https://support.wix.com/en/article/creating-and-displaying-event-categories)
- * @param categoryId - Category ID
- * @public
- * @requiredField categoryId
- * @param options - Optional fields.
- */
-export declare function reorderCategoryEvents(categoryId: string, options?: ReorderCategoryEventsOptions): Promise<void>;
-export interface ReorderCategoryEventsOptions extends ReorderCategoryEventsRequestReferenceEventOneOf {
-    /** Event ID */
-    eventId?: string;
-    /** Move the event before defined `eventId`. */
-    beforeEventId?: string;
-    /** Move the event after defined `eventId`. */
-    afterEventId?: string;
-}
-export {};