@wix/auto_sdk_events_categories 1.0.0

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

@@ -0,0 +1,430 @@
+export interface Category {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    id?: string;
+    /** Category name. */
+    name?: string;
+    /**
+     * Date and time when category was created.
+     * @readonly
+     */
+    createdDate?: Date | 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 scope is required to use states other than `MANUAL`.
+     */
+    states?: State[];
+}
+export interface CategoryCounts {
+    /** Total number of draft events assigned to the category. */
+    assignedEventsCount?: number | null;
+    /** Total number of published events assigned to the category. Deleted events are excluded. */
+    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"
+}
+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;
+    /** 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 to 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 {
+    /** Options to use when querying categories. 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 {
+    /** Bulk assign 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 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 DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface CategoryNonNullableFields {
+    id: string;
+    name: string;
+    states: State[];
+}
+export interface CreateCategoryResponseNonNullableFields {
+    category?: CategoryNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkCategoryResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    item?: CategoryNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkCreateCategoryResponseNonNullableFields {
+    results: BulkCategoryResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface UpdateCategoryResponseNonNullableFields {
+    category?: CategoryNonNullableFields;
+}
+export interface QueryCategoriesResponseNonNullableFields {
+    categories: CategoryNonNullableFields[];
+}
+export interface BulkAssignEventsResponseNonNullableFields {
+    results: BulkCategoryResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkUnassignEventsResponseNonNullableFields {
+    results: BulkCategoryResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface ListEventCategoriesResponseNonNullableFields {
+    categories: CategoryNonNullableFields[];
+}
+export {};

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

@@ -0,0 +1,30 @@
+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";
+})(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 = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+//# sourceMappingURL=events-v1-category-categories.types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events-v1-category-categories.types.js","sourceRoot":"","sources":["../../../src/events-v1-category-categories.types.ts"],"names":[],"mappings":"AAwCA,MAAM,CAAN,IAAY,KASX;AATD,WAAY,KAAK;IACf,oCAAoC;IACpC,0BAAiB,CAAA;IACjB,6BAA6B;IAC7B,sBAAa,CAAA;IACb,gDAAgD;IAChD,4CAAmC,CAAA;IACnC,0BAA0B;IAC1B,0BAAiB,CAAA;AACnB,CAAC,EATW,KAAK,KAAL,KAAK,QAShB;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;AAgPD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}