@wix/auto_sdk_blog_categories 1.0.15 → 1.0.17

package/build/cjs/{blog-v3-category-categories.universal-CZqdXr9y.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Category {
     /**
      * Category ID.
@@ -732,13 +734,77 @@ interface CategoryCreatedEnvelope {
     entity: Category;
     metadata: EventMetadata;
 }
+/**
+ * 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 Manage Blog
+ * @permissionScopeId SCOPE.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
+ */
+declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) => void | Promise<void>): void;
 interface CategoryDeletedEnvelope {
     metadata: EventMetadata;
 }
+/**
+ * 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 Manage Blog
+ * @permissionScopeId SCOPE.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
+ */
+declare function onCategoryDeleted(handler: (event: CategoryDeletedEnvelope) => void | Promise<void>): void;
 interface CategoryUpdatedEnvelope {
     entity: Category;
     metadata: EventMetadata;
 }
+/**
+ * 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 Manage Blog
+ * @permissionScopeId SCOPE.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
+ */
+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
+ * @applicableIdentity APP
+ * @returns Category info.
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.CreateCategory
+ */
+declare function createCategory(category: NonNullablePaths<Category, `label`>, options?: CreateCategoryOptions): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
 interface CreateCategoryOptions {
     /**
      * List of additional category fields to include in the response. By default
@@ -750,6 +816,18 @@ interface CreateCategoryOptions {
      */
     fieldsets?: FieldWithLiterals[];
 }
+/**
+ * Updates a category.
+ * @param _id - Category ID.
+ * @public
+ * @requiredField _id
+ * @requiredField category
+ * @permissionId BLOG.EDIT-CATEGORY
+ * @applicableIdentity APP
+ * @returns Category info.
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.UpdateCategory
+ */
+declare function updateCategory(_id: string, category: UpdateCategory, options?: UpdateCategoryOptions): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
 interface UpdateCategory {
     /**
      * Category ID.
@@ -829,6 +907,20 @@ interface UpdateCategoryOptions {
      */
     fieldsets?: FieldWithLiterals[];
 }
+/**
+ * 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
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategory
+ */
+declare function getCategory(categoryId: string, options?: GetCategoryOptions): Promise<NonNullablePaths<GetCategoryResponse, {
+    [P in CategoryNonNullablePaths]: `category.${P}`;
+}[CategoryNonNullablePaths]>>;
 interface GetCategoryOptions {
     /**
      * List of additional category fields to include in the response. By default
@@ -840,6 +932,26 @@ interface GetCategoryOptions {
      */
     fieldsets?: FieldWithLiterals[];
 }
+/**
+ * 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
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategoryBySlug
+ */
+declare function getCategoryBySlug(slug: string, options?: GetCategoryBySlugOptions): Promise<NonNullablePaths<GetCategoryBySlugResponse, {
+    [P in CategoryNonNullablePaths]: `category.${P}`;
+}[CategoryNonNullablePaths]>>;
 interface GetCategoryBySlugOptions {
     /**
      * List of additional category fields to include in the response. By default
@@ -857,6 +969,29 @@ interface GetCategoryBySlugOptions {
      */
     language?: string | null;
 }
+/**
+ * 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
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.ListCategories
+ */
+declare function listCategories(options?: ListCategoriesOptions): Promise<NonNullablePaths<ListCategoriesResponse, {
+    [P in CategoryNonNullablePaths]: `categories.${number}.${P}`;
+}[CategoryNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
 interface ListCategoriesOptions {
     /** Pagination options. */
     paging?: BlogPaging;
@@ -879,6 +1014,29 @@ interface ListCategoriesOptions {
      */
     language?: string | null;
 }
+/**
+ * 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.
+ * @permissionId BLOG.READ-CATEGORY
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.QueryCategories
+ */
+declare function queryCategories(options?: QueryCategoriesOptions): CategoriesQueryBuilder;
 interface QueryCategoriesOptions {
     /**
   
@@ -942,5 +1100,15 @@ interface CategoriesQueryBuilder {
     skip: (skip: number) => CategoriesQueryBuilder;
     find: () => Promise<CategoriesQueryResult>;
 }
+/**
+ * Deletes a category.
+ * @param categoryId - Category ID.
+ * @public
+ * @requiredField categoryId
+ * @permissionId BLOG.DELETE-CATEGORY
+ * @applicableIdentity APP
+ * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.DeleteCategory
+ */
+declare function deleteCategory(categoryId: string): Promise<void>;
 
-export { type PagingMetadataV2 as $, type ApplicationError as A, type BulkCreateCategoriesRequest as B, type Category as C, type CategoryLanguageCount as D, type GetCategoryRequest as E, Field as F, type GetCategoryOptions as G, type GetCategoryBySlugRequest as H, type InitialCategoriesCopied as I, type ListCategoriesRequest as J, type Keyword as K, type ListCategoriesOptions as L, type MaskedCategory as M, type BlogPaging as N, type MetaData as O, type QueryCategoriesRequest as P, type QueryCategoriesOptions as Q, type PlatformQuery as R, SortOrder as S, type Tag as T, type UpdateCategory as U, type PlatformQueryPagingMethodOneOf as V, WebhookIdentityType as W, type Sorting as X, type Paging as Y, type CursorPaging as Z, type QueryCategoriesResponse as _, type CreateCategoryOptions as a, type Cursors as a0, type BulkDeleteCategoryRequest as a1, type BulkDeleteCategoryResponse as a2, type DeleteCategoryRequest as a3, type DeleteCategoryResponse as a4, type DomainEvent as a5, type DomainEventBodyOneOf as a6, type EntityCreatedEvent as a7, type RestoreInfo as a8, type EntityUpdatedEvent as a9, type EntityDeletedEvent as aa, type ActionEvent as ab, type MessageEnvelope as ac, type IdentificationData as ad, type IdentificationDataIdOneOf as ae, type BaseEventMetadata as af, type EventMetadata 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 CategoryCreatedEnvelope as h, type CategoryDeletedEnvelope as i, type CategoryUpdatedEnvelope as j, type SeoSchema as k, type Settings as l, type FocalPoint as m, type CategoryTranslation as n, type CreateCategoryRequest as o, type CreateCategoryResponse as p, type BulkCreateCategoriesResponse as q, type BulkCategoryResult as r, type ItemMetadata as s, type BulkActionMetadata as t, type BulkUpdateCategoriesRequest as u, type BulkUpdateCategoriesResponse as v, type UpdateCategoryRequest as w, type UpdateCategoryResponse as x, type GetCategoriesCountByLanguageRequest as y, type GetCategoriesCountByLanguageResponse as z };
+export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type BlogPaging, type BulkActionMetadata, type BulkCategoryResult, type BulkCreateCategoriesRequest, type BulkCreateCategoriesResponse, type BulkDeleteCategoryRequest, type BulkDeleteCategoryResponse, type BulkUpdateCategoriesRequest, type BulkUpdateCategoriesResponse, type CategoriesQueryBuilder, type CategoriesQueryResult, type Category, type CategoryCreatedEnvelope, type CategoryDeletedEnvelope, type CategoryLanguageCount, type CategoryTranslation, type CategoryUpdatedEnvelope, type CreateCategoryOptions, type CreateCategoryRequest, type CreateCategoryResponse, type CursorPaging, type Cursors, type DeleteCategoryRequest, type DeleteCategoryResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, Field, type FieldWithLiterals, type FocalPoint, type GetCategoriesCountByLanguageRequest, type GetCategoriesCountByLanguageResponse, type GetCategoryBySlugOptions, type GetCategoryBySlugRequest, type GetCategoryBySlugResponse, type GetCategoryOptions, type GetCategoryRequest, type GetCategoryResponse, type IdentificationData, type IdentificationDataIdOneOf, type InitialCategoriesCopied, type ItemMetadata, type Keyword, type ListCategoriesOptions, type ListCategoriesRequest, type ListCategoriesResponse, type MaskedCategory, type MessageEnvelope, type MetaData, type Paging, type PagingMetadataV2, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type QueryCategoriesOptions, type QueryCategoriesRequest, type QueryCategoriesResponse, type RestoreInfo, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, type Tag, type UpdateCategory, type UpdateCategoryOptions, type UpdateCategoryRequest, type UpdateCategoryResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createCategory, deleteCategory, getCategory, getCategoryBySlug, listCategories, onCategoryCreated, onCategoryDeleted, onCategoryUpdated, queryCategories, updateCategory };