npm - @wix/auto_sdk_blog_categories - Versions diffs - 1.0.6 → 1.0.8 - Mend

@wix/auto_sdk_blog_categories 1.0.6 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (130) hide show

package/build/{blog-v3-category-categories.universal-CF5HyUlx.d.mts → cjs/src/blog-v3-category-categories.universal.d.ts} RENAMED Viewed

@@ -1,4 +1,5 @@
-interface Category {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface Category {
     /**
      * Category ID.
      * @immutable
@@ -71,13 +72,13 @@ interface Category {
  * The search engines use this information for ranking purposes, or to display snippets in the search results.
  * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
  */
-interface SeoSchema {
+export interface SeoSchema {
     /** SEO tag information. */
     tags?: Tag[];
     /** SEO general settings. */
     settings?: Settings;
 }
-interface Keyword {
+export interface Keyword {
     /** Keyword value. */
     term?: string;
     /** Whether the keyword is the main focus keyword. */
@@ -88,7 +89,7 @@ interface Keyword {
      */
     origin?: string | null;
 }
-interface Tag {
+export interface Tag {
     /**
      * SEO tag type.
      *
@@ -110,7 +111,7 @@ interface Tag {
     /** Whether the tag is disabled. */
     disabled?: boolean;
 }
-interface Settings {
+export interface Settings {
     /**
      * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
      *
@@ -124,7 +125,7 @@ interface Settings {
      */
     keywords?: Keyword[];
 }
-interface FocalPoint {
+export interface FocalPoint {
     /** X-coordinate of the focal point. */
     x?: number;
     /** Y-coordinate of the focal point. */
@@ -134,7 +135,7 @@ interface FocalPoint {
     /** crop by width */
     width?: number | null;
 }
-interface CategoryTranslation {
+export interface CategoryTranslation {
     /**
      * Category ID.
      * @format GUID
@@ -153,11 +154,11 @@ interface CategoryTranslation {
     /** URL of this category page. */
     url?: string;
 }
-interface InitialCategoriesCopied {
+export interface InitialCategoriesCopied {
     /** Number of categories copied. */
     count?: number;
 }
-interface CreateCategoryRequest {
+export interface CreateCategoryRequest {
     /** Category info. */
     category: Category;
     /**
@@ -170,18 +171,18 @@ interface CreateCategoryRequest {
      */
     fieldsets?: Field[];
 }
-declare enum Field {
+export declare enum Field {
     UNKNOWN = "UNKNOWN",
-    /** Includes Category url. */
+    /** Includes category URL. */
     URL = "URL",
     /** Includes SEO data. */
     SEO = "SEO"
 }
-interface CreateCategoryResponse {
+export interface CreateCategoryResponse {
     /** Category info. */
     category?: Category;
 }
-interface BulkCreateCategoriesRequest {
+export interface BulkCreateCategoriesRequest {
     /**
      * Categories to create.
      * @minSize 1
@@ -200,19 +201,19 @@ interface BulkCreateCategoriesRequest {
      */
     fieldsets?: Field[];
 }
-interface BulkCreateCategoriesResponse {
+export interface BulkCreateCategoriesResponse {
     /** Categories created by bulk action. */
     results?: BulkCategoryResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface BulkCategoryResult {
+export interface BulkCategoryResult {
     /** Bulk actions metadata for category. */
     itemMetadata?: ItemMetadata;
     /** Optional created category. */
     item?: Category;
 }
-interface ItemMetadata {
+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. */
@@ -222,7 +223,7 @@ interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-interface ApplicationError {
+export interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -230,7 +231,7 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface BulkActionMetadata {
+export interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -238,7 +239,7 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-interface BulkUpdateCategoriesRequest {
+export interface BulkUpdateCategoriesRequest {
     /**
      * Categories to update.
      * @minSize 1
@@ -257,19 +258,19 @@ interface BulkUpdateCategoriesRequest {
      */
     fieldsets?: Field[];
 }
-interface MaskedCategory {
+export interface MaskedCategory {
     /** Category */
     category?: Category;
     /** Field mask of fields to update. */
     fieldMask?: string[];
 }
-interface BulkUpdateCategoriesResponse {
+export interface BulkUpdateCategoriesResponse {
     /** Categories updated by bulk action. */
     results?: BulkCategoryResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-interface UpdateCategoryRequest {
+export interface UpdateCategoryRequest {
     /** Category info. */
     category: Category;
     /**
@@ -282,17 +283,17 @@ interface UpdateCategoryRequest {
      */
     fieldsets?: Field[];
 }
-interface UpdateCategoryResponse {
+export interface UpdateCategoryResponse {
     /** Category info. */
     category?: Category;
 }
-interface GetCategoriesCountByLanguageRequest {
+export interface GetCategoriesCountByLanguageRequest {
 }
-interface GetCategoriesCountByLanguageResponse {
+export interface GetCategoriesCountByLanguageResponse {
     /** The language and it's count. */
     categoriesLanguageCount?: CategoryLanguageCount[];
 }
-interface CategoryLanguageCount {
+export interface CategoryLanguageCount {
     /**
      * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
      * @format LANGUAGE_TAG
@@ -301,7 +302,7 @@ interface CategoryLanguageCount {
     /** The count of Categories for the language. */
     categoryCount?: number | null;
 }
-interface GetCategoryRequest {
+export interface GetCategoryRequest {
     /**
      * Category ID.
      * @minLength 1
@@ -318,11 +319,11 @@ interface GetCategoryRequest {
      */
     fieldsets?: Field[];
 }
-interface GetCategoryResponse {
+export interface GetCategoryResponse {
     /** Category info. */
     category?: Category;
 }
-interface GetCategoryBySlugRequest {
+export interface GetCategoryBySlugRequest {
     /**
      * Slug of the category to retrieve.
      * @minLength 1
@@ -345,11 +346,11 @@ interface GetCategoryBySlugRequest {
      */
     language?: string | null;
 }
-interface GetCategoryBySlugResponse {
+export interface GetCategoryBySlugResponse {
     /** Category info. */
     category?: Category;
 }
-interface ListCategoriesRequest {
+export interface ListCategoriesRequest {
     /** Pagination options. */
     paging?: BlogPaging;
     /**
@@ -371,7 +372,7 @@ interface ListCategoriesRequest {
      */
     language?: string | null;
 }
-interface BlogPaging {
+export interface BlogPaging {
     /**
      * Number of items to skip in the current sort order.
      *
@@ -395,13 +396,13 @@ interface BlogPaging {
      */
     cursor?: string | null;
 }
-interface ListCategoriesResponse {
+export interface ListCategoriesResponse {
     /** List of categories. */
     categories?: Category[];
     /** Details on the paged set of results returned. */
     metaData?: MetaData;
 }
-interface MetaData {
+export interface MetaData {
     /** Number of items returned in this response. */
     count?: number;
     /** Requested offset. */
@@ -414,7 +415,7 @@ interface MetaData {
      */
     cursor?: string | null;
 }
-interface QueryCategoriesRequest {
+export interface QueryCategoriesRequest {
     /** Query options. */
     query?: PlatformQuery;
     /**
@@ -427,7 +428,7 @@ interface QueryCategoriesRequest {
      */
     fieldsets?: Field[];
 }
-interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
@@ -449,13 +450,13 @@ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-interface PlatformQueryPagingMethodOneOf {
+export interface PlatformQueryPagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -464,11 +465,11 @@ interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-interface Paging {
+export interface Paging {
     /**
      * Number of items to load.
      * @max 100
@@ -477,7 +478,7 @@ interface Paging {
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Number of items to load.
      * @max 100
@@ -493,13 +494,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface QueryCategoriesResponse {
+export interface QueryCategoriesResponse {
     /** List of categories. */
     categories?: Category[];
     /** Details on the paged set of results returned. */
     pagingMetadata?: PagingMetadataV2;
 }
-interface PagingMetadataV2 {
+export interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -511,7 +512,7 @@ interface PagingMetadataV2 {
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor pointing to next page in the list of results.
      * @maxLength 2000
@@ -523,7 +524,7 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface BulkDeleteCategoryRequest {
+export interface BulkDeleteCategoryRequest {
     /**
      * Category IDs.
      * @minSize 1
@@ -534,9 +535,9 @@ interface BulkDeleteCategoryRequest {
     /** Should delete bypassing the trash-bin. */
     permanent?: boolean;
 }
-interface BulkDeleteCategoryResponse {
+export interface BulkDeleteCategoryResponse {
 }
-interface DeleteCategoryRequest {
+export interface DeleteCategoryRequest {
     /**
      * Category ID.
      * @minLength 1
@@ -544,9 +545,9 @@ interface DeleteCategoryRequest {
      */
     categoryId: string;
 }
-interface DeleteCategoryResponse {
+export interface DeleteCategoryResponse {
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -589,19 +590,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+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.
@@ -609,14 +610,14 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -632,7 +633,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -657,7 +658,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -679,14 +680,14 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface BaseEventMetadata {
+export interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -700,7 +701,7 @@ interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-interface EventMetadata extends BaseEventMetadata {
+export interface EventMetadata extends BaseEventMetadata {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -738,18 +739,78 @@ interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-interface CategoryCreatedEnvelope {
+export interface CategoryCreatedEnvelope {
     entity: Category;
     metadata: EventMetadata;
 }
-interface CategoryDeletedEnvelope {
+/**
+ * Triggered when a category is created.
+ * @permissionScope Read Blog
+ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @permissionScope Read Draft Blog Posts
+ * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
+ * @permissionId BLOG.READ-CATEGORY
+ * @webhook
+ * @eventType wix.blog.v3.category_created
+ * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.CategoryService
+ * @slug created
+ */
+export declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) => void | Promise<void>): void;
+export interface CategoryDeletedEnvelope {
     metadata: EventMetadata;
 }
-interface CategoryUpdatedEnvelope {
+/**
+ * Triggered when a category is deleted.
+ * @permissionScope Read Blog
+ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @permissionScope Read Draft Blog Posts
+ * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
+ * @permissionId BLOG.READ-CATEGORY
+ * @webhook
+ * @eventType wix.blog.v3.category_deleted
+ * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.CategoryService
+ * @slug deleted
+ */
+export declare function onCategoryDeleted(handler: (event: CategoryDeletedEnvelope) => void | Promise<void>): void;
+export interface CategoryUpdatedEnvelope {
     entity: Category;
     metadata: EventMetadata;
 }
-interface CreateCategoryOptions {
+/**
+ * Triggered when a category is updated.
+ * @permissionScope Read Blog
+ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @permissionScope Read Draft Blog Posts
+ * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
+ * @permissionId BLOG.READ-CATEGORY
+ * @webhook
+ * @eventType wix.blog.v3.category_updated
+ * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.CategoryService
+ * @slug updated
+ */
+export declare function onCategoryUpdated(handler: (event: CategoryUpdatedEnvelope) => void | Promise<void>): void;
+type CategoryNonNullablePaths = `_id` | `label` | `postCount` | `title` | `slug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`;
+/**
+ * Creates a category.
+ * @param category - Category info.
+ * @public
+ * @requiredField category
+ * @requiredField category.label
+ * @permissionId BLOG.CREATE-CATEGORY
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @applicableIdentity APP
+ * @returns Category info.
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.CreateCategory
+ */
+export declare function createCategory(category: NonNullablePaths<Category, `label`>, options?: CreateCategoryOptions): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
+export interface CreateCategoryOptions {
     /**
      * List of additional category fields to include in the response. By default
      * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -760,7 +821,21 @@ interface CreateCategoryOptions {
      */
     fieldsets?: Field[];
 }
-interface UpdateCategory {
+/**
+ * Updates a category.
+ * @param _id - Category ID.
+ * @public
+ * @requiredField _id
+ * @requiredField category
+ * @permissionId BLOG.EDIT-CATEGORY
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @applicableIdentity APP
+ * @returns Category info.
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.UpdateCategory
+ */
+export declare function updateCategory(_id: string, category: UpdateCategory, options?: UpdateCategoryOptions): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
+export interface UpdateCategory {
     /**
      * Category ID.
      * @immutable
@@ -828,7 +903,7 @@ interface UpdateCategory {
      */
     _updatedDate?: Date | null;
 }
-interface UpdateCategoryOptions {
+export interface UpdateCategoryOptions {
     /**
      * List of additional category fields to include in the response. By default
      * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -839,7 +914,27 @@ interface UpdateCategoryOptions {
      */
     fieldsets?: Field[];
 }
-interface GetCategoryOptions {
+/**
+ * Gets a category with the specified ID.
+ * @param categoryId - Category ID.
+ * @public
+ * @requiredField categoryId
+ * @param options - Options specifying which fields to return.
+ * @permissionId BLOG.READ-CATEGORY
+ * @permissionScope Read Blog
+ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @permissionScope Read Draft Blog Posts
+ * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategory
+ */
+export declare function getCategory(categoryId: string, options?: GetCategoryOptions): Promise<NonNullablePaths<GetCategoryResponse, {
+    [P in CategoryNonNullablePaths]: `category.${P}`;
+}[CategoryNonNullablePaths]>>;
+export interface GetCategoryOptions {
     /**
      * List of additional category fields to include in the response. By default
      * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -850,7 +945,33 @@ interface GetCategoryOptions {
      */
     fieldsets?: Field[];
 }
-interface GetCategoryBySlugOptions {
+/**
+ * Gets a category with the specified slug.
+ *
+ * The slug is at the end of the URL of a specific category.
+ * For example, if a category's URL is `https://example.com/blog/categories/famous-cats`, the slug is `famous-cats`.
+ * The slug is a case-sensitive string that is derived from the category's label, unless specified otherwise.
+ * @public
+ * @requiredField slug
+ * @param slug - Slug of the category to retrieve.
+ *
+ * The end of a category's URL. For example, `'https:/example.com/blog/category/{my-category-slug}'`. Case sensitive and generally based on the category `label` if not specified.
+ * @param options - Options specifying which fields to return.
+ * @permissionId BLOG.READ-CATEGORY
+ * @permissionScope Read Blog
+ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @permissionScope Read Draft Blog Posts
+ * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategoryBySlug
+ */
+export declare function getCategoryBySlug(slug: string, options?: GetCategoryBySlugOptions): Promise<NonNullablePaths<GetCategoryBySlugResponse, {
+    [P in CategoryNonNullablePaths]: `category.${P}`;
+}[CategoryNonNullablePaths]>>;
+export interface GetCategoryBySlugOptions {
     /**
      * List of additional category fields to include in the response. By default
      * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -867,7 +988,36 @@ interface GetCategoryBySlugOptions {
      */
     language?: string | null;
 }
-interface ListCategoriesOptions {
+/**
+ * Retrieves a list of up to 100 categories per request.
+ *
+ * If you pass a language filter to the method, it returns a list of up to 100 categories in the requested language.
+ *
+ * The categoies are displayed in order of their `displayPosition`, starting with `0`. The `displayPosition` is the position in which the categories
+ * are displayed in the Category Menu page. By default, categories get added to the bottom of the Category Menu page with a `displayPosition` of `-1`.
+ *
+ * List Categories runs with these defaults, which you can override:
+ * - `paging.limit` is `50`.
+ * - `paging.offset` is `0`.
+ *
+ * List Categories is sorted by `displayPosition` in descending order. This cannot be overridden.
+ * @public
+ * @param options - Filter and paging options.
+ * @permissionId BLOG.READ-CATEGORY
+ * @permissionScope Read Blog
+ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @permissionScope Read Draft Blog Posts
+ * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.ListCategories
+ */
+export declare function listCategories(options?: ListCategoriesOptions): Promise<NonNullablePaths<ListCategoriesResponse, {
+    [P in CategoryNonNullablePaths]: `categories.${number}.${P}`;
+}[CategoryNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
+export interface ListCategoriesOptions {
     /** Pagination options. */
     paging?: BlogPaging;
     /**
@@ -889,7 +1039,36 @@ interface ListCategoriesOptions {
      */
     language?: string | null;
 }
-interface QueryCategoriesOptions {
+/**
+ * Creates a query to retrieve a list of categories.
+ *
+ *
+ * The Query Categories method builds a query to retrieve a list of up to 100 categories per language, and returns a [`CategoriesQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending) object.
+ *
+ * The response contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/find) method.
+ *
+ * You can refine the query by chaining `CategoriesQueryBuilder` methods to the query. `CategoriesQueryBuilder` methods enable you to sort, filter, and control the results that Query Categories returns. Any methods chained to the Query Categories method are applied in the order that they are called.
+ *
+ * Query Categories runs with these `CategoriesQueryBuilder` defaults, which you can override.
+ * - [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/limit)
+ * - [`ascending(displayPosition)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending)
+ *
+ * The following `CategoriesQueryBuilder` methods are supported for Query Categories. For a full description of the `Categories` object, see the response for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-result/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).
+ * @public
+ * @param options - Options specifying which fields to return.
+ * @permissionScope Read Blog
+ * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @permissionScope Read Draft Blog Posts
+ * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
+ * @permissionId BLOG.READ-CATEGORY
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.QueryCategories
+ */
+export declare function queryCategories(options?: QueryCategoriesOptions): CategoriesQueryBuilder;
+export interface QueryCategoriesOptions {
     /**
      * @maxSize 10
@@ -905,13 +1084,13 @@ interface QueryOffsetResult {
     length: number;
     pageSize: number;
 }
-interface CategoriesQueryResult extends QueryOffsetResult {
+export interface CategoriesQueryResult extends QueryOffsetResult {
     items: Category[];
     query: CategoriesQueryBuilder;
     next: () => Promise<CategoriesQueryResult>;
     prev: () => Promise<CategoriesQueryResult>;
 }
-interface CategoriesQueryBuilder {
+export interface CategoriesQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
@@ -952,5 +1131,16 @@ interface CategoriesQueryBuilder {
     skip: (skip: number) => CategoriesQueryBuilder;
     find: () => Promise<CategoriesQueryResult>;
 }
-export { type BulkDeleteCategoryResponse as $, type ApplicationError as A, type BulkCreateCategoriesRequest as B, type Category as C, type ListCategoriesRequest as D, type BlogPaging as E, Field as F, type GetCategoryOptions as G, type MetaData as H, type InitialCategoriesCopied as I, type QueryCategoriesRequest as J, type Keyword as K, type ListCategoriesOptions as L, type MaskedCategory as M, type PlatformQueryPagingMethodOneOf as N, type Sorting as O, type PlatformQuery as P, type QueryCategoriesOptions as Q, type Paging as R, SortOrder as S, type Tag as T, type UpdateCategory as U, type CursorPaging as V, WebhookIdentityType as W, type QueryCategoriesResponse as X, type PagingMetadataV2 as Y, type Cursors as Z, type BulkDeleteCategoryRequest as _, type CreateCategoryOptions as a, type DeleteCategoryRequest as a0, type DeleteCategoryResponse as a1, type DomainEvent as a2, type DomainEventBodyOneOf as a3, type EntityCreatedEvent as a4, type RestoreInfo as a5, type EntityUpdatedEvent as a6, type EntityDeletedEvent as a7, type ActionEvent as a8, type MessageEnvelope as a9, type IdentificationData as aa, type IdentificationDataIdOneOf as ab, type BaseEventMetadata as ac, type EventMetadata as ad, type CategoryCreatedEnvelope as ae, type CategoryDeletedEnvelope as af, type CategoryUpdatedEnvelope as ag, type CategoriesQueryResult as ah, type UpdateCategoryOptions as b, type GetCategoryResponse as c, type GetCategoryBySlugOptions as d, type GetCategoryBySlugResponse as e, type ListCategoriesResponse as f, type CategoriesQueryBuilder as g, type SeoSchema as h, type Settings as i, type FocalPoint as j, type CategoryTranslation as k, type CreateCategoryRequest as l, type CreateCategoryResponse as m, type BulkCreateCategoriesResponse as n, type BulkCategoryResult as o, type ItemMetadata as p, type BulkActionMetadata as q, type BulkUpdateCategoriesRequest as r, type BulkUpdateCategoriesResponse as s, type UpdateCategoryRequest as t, type UpdateCategoryResponse as u, type GetCategoriesCountByLanguageRequest as v, type GetCategoriesCountByLanguageResponse as w, type CategoryLanguageCount as x, type GetCategoryRequest as y, type GetCategoryBySlugRequest as z };
+/**
+ * Deletes a category.
+ * @param categoryId - Category ID.
+ * @public
+ * @requiredField categoryId
+ * @permissionId BLOG.DELETE-CATEGORY
+ * @permissionScope Manage Blog
+ * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
+ * @applicableIdentity APP
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.DeleteCategory
+ */
+export declare function deleteCategory(categoryId: string): Promise<void>;
+export {};