@wix/events 1.0.150 → 1.0.152

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

@@ -0,0 +1,364 @@
+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;
+    /**
+     * Assigned and assigned draft event counts.
+     * @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 to be created. */
+    category: Category;
+}
+export interface CreateCategoryResponse {
+    /** Created category. */
+    category?: Category;
+}
+export interface BulkCreateCategoryRequest {
+    /** Categories to be created. */
+    categories: Category[];
+}
+export interface BulkCreateCategoryResponse {
+    /** Bulk create results. */
+    results?: BulkCategoryResult[];
+    /** Bulk create metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkCategoryResult {
+    /** Metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Category. */
+    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 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. */
+    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 Category Event ID before this Event ID */
+    beforeEventId?: string;
+    /** Move the Category Event ID after this Event ID */
+    afterEventId?: string;
+    /** Category ID */
+    categoryId: string;
+    /** Event ID */
+    eventId?: 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 {
+}
+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[];
+    }[];
+}

package/build/es/src/events-v1-category.types.js

@@ -0,0 +1,24 @@
+export var State;
+(function (State) {
+    /** Created manually by the user. */
+    State["MANUAL"] = "MANUAL";
+    /** Created automatically. */
+    State["AUTO"] = "AUTO";
+    /** Created when publishing recurring events. */
+    State["RECURRING_EVENT"] = "RECURRING_EVENT";
+    /** Category is hidden. */
+    State["HIDDEN"] = "HIDDEN";
+    /** Category is used to store component events. */
+    State["COMPONENT"] = "COMPONENT";
+})(State || (State = {}));
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+export var CategoryFieldset;
+(function (CategoryFieldset) {
+    /** Include `assignedEventsCount` in the response. */
+    CategoryFieldset["COUNTS"] = "COUNTS";
+})(CategoryFieldset || (CategoryFieldset = {}));
+//# sourceMappingURL=events-v1-category.types.js.map

package/build/es/src/events-v1-category.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events-v1-category.types.js","sourceRoot":"","sources":["../../../src/events-v1-category.types.ts"],"names":[],"mappings":"AAsCA,MAAM,CAAN,IAAY,KAWX;AAXD,WAAY,KAAK;IACf,oCAAoC;IACpC,0BAAiB,CAAA;IACjB,6BAA6B;IAC7B,sBAAa,CAAA;IACb,gDAAgD;IAChD,4CAAmC,CAAA;IACnC,0BAA0B;IAC1B,0BAAiB,CAAA;IACjB,kDAAkD;IAClD,gCAAuB,CAAA;AACzB,CAAC,EAXW,KAAK,KAAL,KAAK,QAWhB;AAsHD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AASD,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,qDAAqD;IACrD,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B"}