@wix/events 1.0.11 → 1.0.13

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

@@ -0,0 +1,68 @@
+import { createCategory as universalCreateCategory, bulkCreateCategory as universalBulkCreateCategory, updateCategory as universalUpdateCategory, deleteCategory as universalDeleteCategory, queryCategories as universalQueryCategories, assignEvents as universalAssignEvents, bulkAssignEvents as universalBulkAssignEvents, bulkAssignEventsAsync as universalBulkAssignEventsAsync, unassignEvents as universalUnassignEvents, bulkUnassignEvents as universalBulkUnassignEvents, bulkUnassignEventsAsync as universalBulkUnassignEventsAsync, listEventCategories as universalListEventCategories, reorderCategoryEvents as universalReorderCategoryEvents, } from './events-v1-category.universal';
+export function createCategory(httpClient) {
+    return (category) => universalCreateCategory(category, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkCreateCategory(httpClient) {
+    return (categories) => universalBulkCreateCategory(categories, 
+    // @ts-ignore
+    { httpClient });
+}
+export function updateCategory(httpClient) {
+    return (_id, category) => universalUpdateCategory(_id, category, 
+    // @ts-ignore
+    { httpClient });
+}
+export function deleteCategory(httpClient) {
+    return (categoryId) => universalDeleteCategory(categoryId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function queryCategories(httpClient) {
+    return (query, options) => universalQueryCategories(query, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function assignEvents(httpClient) {
+    return (categoryId, eventId) => universalAssignEvents(categoryId, eventId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkAssignEvents(httpClient) {
+    return (categoryId, options) => universalBulkAssignEvents(categoryId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkAssignEventsAsync(httpClient) {
+    return (categoryId, options) => universalBulkAssignEventsAsync(categoryId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function unassignEvents(httpClient) {
+    return (categoryId, eventId) => universalUnassignEvents(categoryId, eventId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkUnassignEvents(httpClient) {
+    return (categoryId, options) => universalBulkUnassignEvents(categoryId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkUnassignEventsAsync(httpClient) {
+    return (categoryId, options) => universalBulkUnassignEventsAsync(categoryId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function listEventCategories(httpClient) {
+    return (eventId) => universalListEventCategories(eventId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function reorderCategoryEvents(httpClient) {
+    return (categoryId, options) => universalReorderCategoryEvents(categoryId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export { State, SortOrder, CategoryFieldset, } from './events-v1-category.universal';
+//# sourceMappingURL=events-v1-category.public.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events-v1-category.public.js","sourceRoot":"","sources":["../../../src/events-v1-category.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,IAAI,uBAAuB,EACzC,kBAAkB,IAAI,2BAA2B,EACjD,cAAc,IAAI,uBAAuB,EACzC,cAAc,IAAI,uBAAuB,EACzC,eAAe,IAAI,wBAAwB,EAC3C,YAAY,IAAI,qBAAqB,EACrC,gBAAgB,IAAI,yBAAyB,EAC7C,qBAAqB,IAAI,8BAA8B,EACvD,cAAc,IAAI,uBAAuB,EACzC,kBAAkB,IAAI,2BAA2B,EACjD,uBAAuB,IAAI,gCAAgC,EAC3D,mBAAmB,IAAI,4BAA4B,EACnD,qBAAqB,IAAI,8BAA8B,GAUxD,MAAM,gCAAgC,CAAC;AAExC,MAAM,UAAU,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,QAAkB,EAAE,EAAE,CAC5B,uBAAuB,CACrB,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAAsB;IACvD,OAAO,CAAC,UAAsB,EAAE,EAAE,CAChC,2BAA2B,CACzB,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,GAAW,EAAE,QAAwB,EAAE,EAAE,CAC/C,uBAAuB,CACrB,GAAG,EACH,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,UAAkB,EAAE,EAAE,CAC5B,uBAAuB,CACrB,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAAsB;IACpD,OAAO,CAAC,KAAc,EAAE,OAAgC,EAAE,EAAE,CAC1D,wBAAwB,CACtB,KAAK,EACL,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,UAAkB,EAAE,OAAiB,EAAE,EAAE,CAC/C,qBAAqB,CACnB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,UAAoB,EAAE,OAAgC,EAAE,EAAE,CAChE,yBAAyB,CACvB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,CAAC,UAAoB,EAAE,OAAqC,EAAE,EAAE,CACrE,8BAA8B,CAC5B,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,UAAkB,EAAE,OAAiB,EAAE,EAAE,CAC/C,uBAAuB,CACrB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAAsB;IACvD,OAAO,CAAC,UAAoB,EAAE,OAAmC,EAAE,EAAE,CACnE,2BAA2B,CACzB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,UAAsB;IAC5D,OAAO,CAAC,UAAoB,EAAE,OAAuC,EAAE,EAAE,CACvE,gCAAgC,CAC9B,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,UAAsB;IACxD,OAAO,CAAC,OAAe,EAAE,EAAE,CACzB,4BAA4B,CAC1B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,CAAC,UAAkB,EAAE,OAAsC,EAAE,EAAE,CACpE,8BAA8B,CAC5B,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,KAAK,EACL,SAAS,EACT,gBAAgB,GACjB,MAAM,gCAAgC,CAAC"}

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

@@ -0,0 +1,234 @@
+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 {
+}

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":"AAmCA,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;AAuGD,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"}