@wix/auto_sdk_faq_category 1.0.3 → 1.0.4

package/build/{internal/cjs/src/faq-category-v2-category-category.universal.d.ts → faq-category-v2-category-category.universal-CCCaclcc.d.mts}

@@ -2,7 +2,7 @@
  * Categories are themed groupings of FAQ question entries that a site owner can create to organize their
  * FAQ questions (e.g., Shipping, Returns, etc.).
  */
-export interface Category {
+interface Category {
     /**
      * Category ID.
      * @format GUID
@@ -39,7 +39,7 @@ export interface Category {
     /** Data Extensions */
     extendedFields?: ExtendedFields;
 }
-export interface ExtendedFields {
+interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
      * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -50,47 +50,47 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-export interface CreateCategoryRequest {
+interface CreateCategoryRequest {
     /** Category to be created. */
     category: Category;
 }
-export interface CreateCategoryResponse {
+interface CreateCategoryResponse {
     /** The created Category. */
     category?: Category;
 }
-export interface GetCategoryRequest {
+interface GetCategoryRequest {
     /**
      * ID of the Category to retrieve.
      * @format GUID
      */
     categoryId: string;
 }
-export interface GetCategoryResponse {
+interface GetCategoryResponse {
     /** The requested Category. */
     category?: Category;
 }
-export interface UpdateCategoryRequest {
+interface UpdateCategoryRequest {
     /** Category to be updated, may be partial. */
     category: Category;
 }
-export interface UpdateCategoryResponse {
+interface UpdateCategoryResponse {
     /** Updated Category. */
     category?: Category;
 }
-export interface DeleteCategoryRequest {
+interface DeleteCategoryRequest {
     /**
      * Id of the Category to delete.
      * @format GUID
      */
     categoryId: string;
 }
-export interface DeleteCategoryResponse {
+interface DeleteCategoryResponse {
 }
-export interface ListCategoriesRequest {
+interface ListCategoriesRequest {
     /** Request more categories using cursor paging. */
     paging?: CursorPaging;
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -105,13 +105,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface ListCategoriesResponse {
+interface ListCategoriesResponse {
     /** List of Categories. */
     categories?: Category[];
     /** Paging metadata */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface PagingMetadataV2 {
+interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -123,7 +123,7 @@ export interface PagingMetadataV2 {
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -135,11 +135,11 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface QueryCategoriesRequest {
+interface QueryCategoriesRequest {
     /** WQL expression. */
     query?: CursorQuery;
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
@@ -161,7 +161,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+interface CursorQueryPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
@@ -169,7 +169,7 @@ export interface CursorQueryPagingMethodOneOf {
      */
     cursorPaging?: CursorPaging;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -178,17 +178,17 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-export interface QueryCategoriesResponse {
+interface QueryCategoriesResponse {
     /** List of Categories. */
     categories?: Category[];
     /** Paging metadata */
     pagingMetadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -201,7 +201,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface UpdateExtendedFieldsRequest {
+interface UpdateExtendedFieldsRequest {
     /** ID of the entity to update. */
     _id: string;
     /** Identifier for the app whose extended fields are being updated. */
@@ -209,11 +209,11 @@ export interface UpdateExtendedFieldsRequest {
     /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
     namespaceData: Record<string, any> | null;
 }
-export interface UpdateExtendedFieldsResponse {
+interface UpdateExtendedFieldsResponse {
     /** Updated Category. */
     category?: Category;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -256,19 +256,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
@@ -276,14 +276,14 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -299,7 +299,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -324,7 +324,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -346,14 +346,14 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface BaseEventMetadata {
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -367,7 +367,7 @@ export interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-export interface EventMetadata extends BaseEventMetadata {
+interface EventMetadata extends BaseEventMetadata {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -405,100 +405,18 @@ export interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-export interface CategoryCreatedEnvelope {
+interface CategoryCreatedEnvelope {
     entity: Category;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @permissionScope Read FAQ
- * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
- * @permissionId FAQ.READ_CATEGORIES
- * @webhook
- * @eventType wix.faq.category.v2.category_created
- * @serviceIdentifier wix.faq.category.v2.CategoryService
- * @slug created
- */
-export declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) => void | Promise<void>): void;
-export interface CategoryDeletedEnvelope {
+interface CategoryDeletedEnvelope {
     metadata: EventMetadata;
 }
-/** @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @permissionScope Read FAQ
- * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
- * @permissionId FAQ.READ_CATEGORIES
- * @webhook
- * @eventType wix.faq.category.v2.category_deleted
- * @serviceIdentifier wix.faq.category.v2.CategoryService
- * @slug deleted
- */
-export declare function onCategoryDeleted(handler: (event: CategoryDeletedEnvelope) => void | Promise<void>): void;
-export interface CategoryUpdatedEnvelope {
+interface CategoryUpdatedEnvelope {
     entity: Category;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @permissionScope Read FAQ
- * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
- * @permissionId FAQ.READ_CATEGORIES
- * @webhook
- * @eventType wix.faq.category.v2.category_updated
- * @serviceIdentifier wix.faq.category.v2.CategoryService
- * @slug updated
- */
-export declare function onCategoryUpdated(handler: (event: CategoryUpdatedEnvelope) => void | Promise<void>): void;
-/**
- * Creates a new Category.
- * @param category - Category to be created.
- * @public
- * @requiredField category
- * @requiredField category.title
- * @permissionId FAQ.CREATE_CATEGORY
- * @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @applicableIdentity APP
- * @returns The created Category.
- * @fqn wix.faq.category.v2.CategoryService.CreateCategory
- */
-export declare function createCategory(category: Category): Promise<Category>;
-/**
- * Retrieves a single Category by id.
- * @param categoryId - ID of the Category to retrieve.
- * @public
- * @requiredField categoryId
- * @permissionId FAQ.READ_CATEGORIES
- * @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @permissionScope Read FAQ
- * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @returns The requested Category.
- * @fqn wix.faq.category.v2.CategoryService.GetCategory
- */
-export declare function getCategory(categoryId: string): Promise<Category>;
-/**
- * Updates a Category.
- *
- * Each time the Category is updated, `revision` increments by 1.
- * The current `revision` must be passed when updating the Category.
- * This ensures you're working with the latest Category and prevents unintended overwrites.
- * @param _id - Category ID.
- * @public
- * @requiredField _id
- * @requiredField category
- * @requiredField category.revision
- * @permissionId FAQ.UPDATE_CATEGORY
- * @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @applicableIdentity APP
- * @returns Updated Category.
- * @fqn wix.faq.category.v2.CategoryService.UpdateCategory
- */
-export declare function updateCategory(_id: string | null, category: UpdateCategory): Promise<Category>;
-export interface UpdateCategory {
+interface UpdateCategory {
     /**
      * Category ID.
      * @format GUID
@@ -535,49 +453,10 @@ export interface UpdateCategory {
     /** Data Extensions */
     extendedFields?: ExtendedFields;
 }
-/**
- * Deletes a Category.
- * Deleting a Category permanently removes them from the Category List.
- * @param categoryId - Id of the Category to delete.
- * @public
- * @requiredField categoryId
- * @permissionId FAQ.DELETE_CATEGORY
- * @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @applicableIdentity APP
- * @fqn wix.faq.category.v2.CategoryService.DeleteCategory
- */
-export declare function deleteCategory(categoryId: string): Promise<void>;
-/**
- * Retrieves categories.
- * @public
- * @permissionId FAQ.READ_CATEGORIES
- * @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @permissionScope Read FAQ
- * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @fqn wix.faq.category.v2.CategoryService.ListCategories
- */
-export declare function listCategories(options?: ListCategoriesOptions): Promise<ListCategoriesResponse>;
-export interface ListCategoriesOptions {
+interface ListCategoriesOptions {
     /** Request more categories using cursor paging. */
     paging?: CursorPaging;
 }
-/**
- * Retrieves a list of Categories, given the provided [paging, filtering, and sorting].
- * @public
- * @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @permissionScope Read FAQ
- * @permissionScopeId SCOPE.DC-LABS.READ-FAQ
- * @permissionId FAQ.READ_CATEGORIES
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @fqn wix.faq.category.v2.CategoryService.QueryCategories
- */
-export declare function queryCategories(): CategoriesQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -585,13 +464,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-export interface CategoriesQueryResult extends QueryCursorResult {
+interface CategoriesQueryResult extends QueryCursorResult {
     items: Category[];
     query: CategoriesQueryBuilder;
     next: () => Promise<CategoriesQueryResult>;
     prev: () => Promise<CategoriesQueryResult>;
 }
-export interface CategoriesQueryBuilder {
+interface CategoriesQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
@@ -636,24 +515,9 @@ export interface CategoriesQueryBuilder {
     skipTo: (cursor: string) => CategoriesQueryBuilder;
     find: () => Promise<CategoriesQueryResult>;
 }
-/**
- * Updates extended fields of a Category without incrementing revision
- * @param _id - ID of the entity to update.
- * @param namespace - Identifier for the app whose extended fields are being updated.
- * @public
- * @requiredField _id
- * @requiredField namespace
- * @requiredField options
- * @requiredField options.namespaceData
- * @permissionId FAQ.UPDATE_CATEGORY
- * @permissionScope Manage FAQ
- * @permissionScopeId SCOPE.DC-LABS.MANAGE-FAQ
- * @applicableIdentity APP
- * @fqn wix.faq.category.v2.CategoryService.UpdateExtendedFields
- */
-export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse>;
-export interface UpdateExtendedFieldsOptions {
+interface UpdateExtendedFieldsOptions {
     /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
     namespaceData: Record<string, any> | null;
 }
-export {};
+
+export { type ActionEvent as A, type BaseEventMetadata as B, type Category as C, type DeleteCategoryRequest as D, type ExtendedFields as E, type CategoryCreatedEnvelope as F, type GetCategoryRequest as G, type CategoryDeletedEnvelope as H, type IdentificationData as I, type CategoryUpdatedEnvelope as J, type CategoriesQueryResult as K, type ListCategoriesOptions as L, type MessageEnvelope as M, type PagingMetadataV2 as P, type QueryCategoriesRequest as Q, type RestoreInfo as R, SortOrder as S, type UpdateCategory as U, WebhookIdentityType as W, type ListCategoriesResponse as a, type CategoriesQueryBuilder as b, type UpdateExtendedFieldsOptions as c, type UpdateExtendedFieldsResponse as d, type CreateCategoryRequest as e, type CreateCategoryResponse as f, type GetCategoryResponse as g, type UpdateCategoryRequest as h, type UpdateCategoryResponse as i, type DeleteCategoryResponse as j, type ListCategoriesRequest as k, type CursorPaging as l, type Cursors as m, type CursorQuery as n, type CursorQueryPagingMethodOneOf as o, type Sorting as p, type QueryCategoriesResponse as q, type CursorPagingMetadata as r, type UpdateExtendedFieldsRequest as s, type DomainEvent as t, type DomainEventBodyOneOf as u, type EntityCreatedEvent as v, type EntityUpdatedEvent as w, type EntityDeletedEvent as x, type IdentificationDataIdOneOf as y, type EventMetadata as z };