@wix/events 1.0.11 → 1.0.13

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

@@ -0,0 +1,399 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Category {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Category name. */
+    name?: string;
+    /**
+     * Category creation timestamp.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Assigned events count. Deleted events are excluded.
+     * @readonly
+     */
+    assignedEventsCount?: number | null;
+    /** @readonly */
+    counts?: CategoryCounts;
+    /**
+     * Category state. Default - MANUAL.
+     * WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.
+     * Field will be ignored on update requests.
+     */
+    states?: State[];
+}
+export interface CategoryCounts {
+    /** Assigned events count. Deleted events are excluded. */
+    assignedEventsCount?: number | null;
+    /** Assigned draft events count. */
+    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: Category;
+}
+export interface CreateCategoryResponse {
+    category?: Category;
+}
+export interface BulkCreateCategoryRequest {
+    categories: Category[];
+}
+export interface BulkCreateCategoryResponse {
+    results?: BulkCategoryResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkCategoryResult {
+    itemMetadata?: ItemMetadata;
+    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 because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface UpdateCategoryRequest {
+    category: Category;
+}
+export interface UpdateCategoryResponse {
+    category?: Category;
+}
+export interface DeleteCategoryRequest {
+    categoryId: string;
+}
+export interface DeleteCategoryResponse {
+}
+export interface QueryCategoriesRequest {
+    query: QueryV2;
+    fieldset?: CategoryFieldset[];
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** 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[];
+    /**
+     * Pointer to page of results using offset.
+     * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     */
+    paging?: Paging;
+}
+/** @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 {
+    categories?: Category[];
+    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 pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface AssignEventsRequest {
+    categoryId: string;
+    eventId: string[];
+}
+export interface AssignEventsResponse {
+}
+export interface BulkAssignEventsRequest {
+    categoryId: string[];
+    eventId: string[];
+}
+export interface BulkAssignEventsResponse {
+    results?: BulkCategoryResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkAssignEventsAsyncRequest {
+    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 {
+    categoryId: string;
+    eventId: string[];
+}
+export interface UnassignEventsResponse {
+}
+export interface BulkUnassignEventsRequest {
+    categoryId: string[];
+    eventId?: string[];
+}
+export interface BulkUnassignEventsResponse {
+    results?: BulkCategoryResult[];
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUnassignEventsAsyncRequest {
+    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 {
+    eventId: string;
+}
+export interface ListEventCategoriesResponse {
+    categories?: Category[];
+}
+export interface ReorderCategoryEventsRequest extends ReorderCategoryEventsRequestReferenceEventOneOf {
+    /** Category ID */
+    categoryId: string;
+    /** Event ID */
+    eventId?: string;
+    /** Move the Category Event ID before this Event ID */
+    beforeEventId?: string;
+    /** Move the Category Event ID after this Event ID */
+    afterEventId?: string;
+}
+/** @oneof */
+export interface ReorderCategoryEventsRequestReferenceEventOneOf {
+    /** Move the Category Event ID before this Event ID */
+    beforeEventId?: string;
+    /** Move the Category Event ID after this Event ID */
+    afterEventId?: string;
+}
+export interface ReorderCategoryEventsResponse {
+}
+/**
+ * Creates a new category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField category
+ */
+export declare function createCategory(category: Category): Promise<CreateCategoryResponse>;
+/**
+ * Creates new categories.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categories
+ */
+export declare function bulkCreateCategory(categories: Category[]): Promise<BulkCreateCategoryResponse>;
+/**
+ * Updates an existing category.
+ * @param _id - Category ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField category
+ */
+export declare function updateCategory(_id: string, category: UpdateCategory): Promise<UpdateCategoryResponse>;
+export interface UpdateCategory {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Category name. */
+    name?: string;
+    /**
+     * Category creation timestamp.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Assigned events count. Deleted events are excluded.
+     * @readonly
+     */
+    assignedEventsCount?: number | null;
+    /** @readonly */
+    counts?: CategoryCounts;
+    /**
+     * Category state. Default - MANUAL.
+     * WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.
+     * Field will be ignored on update requests.
+     */
+    states?: State[];
+}
+/**
+ * Deletes existing category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ */
+export declare function deleteCategory(categoryId: string): Promise<void>;
+/**
+ * - `filter` - supported for `name`, `id` and `states` fields.
+ * - `sort` - supported for `created` and `name` fields.
+ * - `paging` - supported, see [paging](https://dev.wix.com/api/rest/getting-started/pagination).
+ * - `fields` - not supported.
+ * - `fieldsets` - not supported.
+ * - `cursorPaging` - not supported, use offset pagination instead.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField query
+ */
+export declare function queryCategories(query: QueryV2, options?: QueryCategoriesOptions): Promise<QueryCategoriesResponse>;
+export interface QueryCategoriesOptions {
+    fieldset?: CategoryFieldset[];
+}
+/**
+ * Assigns events to a single category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField eventId
+ */
+export declare function assignEvents(categoryId: string, eventId: string[]): Promise<void>;
+/**
+ * Assigns events to multiple categories.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField options
+ * @requiredField options.eventId
+ */
+export declare function bulkAssignEvents(categoryId: string[], options: BulkAssignEventsOptions): Promise<BulkAssignEventsResponse>;
+export interface BulkAssignEventsOptions {
+    eventId: string[];
+}
+/**
+ * Assigns filtered events to multiple categories.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField options
+ * @requiredField options.filter
+ */
+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 single category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField eventId
+ */
+export declare function unassignEvents(categoryId: string, eventId: string[]): Promise<void>;
+/**
+ * Unassigns events from multiple categories.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ */
+export declare function bulkUnassignEvents(categoryId: string[], options?: BulkUnassignEventsOptions): Promise<BulkUnassignEventsResponse>;
+export interface BulkUnassignEventsOptions {
+    eventId?: string[];
+}
+/**
+ * Unassigns filtered events from multiple categories.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField options
+ * @requiredField options.filter
+ */
+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;
+}
+/**
+ * Lists visible event categories.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField eventId
+ */
+export declare function listEventCategories(eventId: string): Promise<ListEventCategoriesResponse>;
+/**
+ * Change the order of category events.
+ * @param categoryId - Category ID
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ */
+export declare function reorderCategoryEvents(categoryId: string, options?: ReorderCategoryEventsOptions): Promise<void>;
+export interface ReorderCategoryEventsOptions {
+    /** Event ID */
+    eventId?: string;
+    /** Move the Category Event ID before this Event ID */
+    beforeEventId?: string;
+    /** Move the Category Event ID after this Event ID */
+    afterEventId?: string;
+}