npm - @wix/blog - Versions diffs - 1.0.113 - Mend

@wix/blog 1.0.113

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 (79) hide show

package/build/cjs/index.d.ts +3 -0
package/build/cjs/index.js +26 -0
package/build/cjs/index.js.map +1 -0
package/build/cjs/src/blog-v3-category.http.d.ts +50 -0
package/build/cjs/src/blog-v3-category.http.js +421 -0
package/build/cjs/src/blog-v3-category.http.js.map +1 -0
package/build/cjs/src/blog-v3-category.public.d.ts +11 -0
package/build/cjs/src/blog-v3-category.public.js +50 -0
package/build/cjs/src/blog-v3-category.public.js.map +1 -0
package/build/cjs/src/blog-v3-category.types.d.ts +391 -0
package/build/cjs/src/blog-v3-category.types.js +22 -0
package/build/cjs/src/blog-v3-category.types.js.map +1 -0
package/build/cjs/src/blog-v3-category.universal.d.ts +582 -0
package/build/cjs/src/blog-v3-category.universal.js +460 -0
package/build/cjs/src/blog-v3-category.universal.js.map +1 -0
package/build/cjs/src/blog-v3-post.http.d.ts +81 -0
package/build/cjs/src/blog-v3-post.http.js +844 -0
package/build/cjs/src/blog-v3-post.http.js.map +1 -0
package/build/cjs/src/blog-v3-post.public.d.ts +11 -0
package/build/cjs/src/blog-v3-post.public.js +86 -0
package/build/cjs/src/blog-v3-post.public.js.map +1 -0
package/build/cjs/src/blog-v3-post.types.d.ts +2227 -0
package/build/cjs/src/blog-v3-post.types.js +464 -0
package/build/cjs/src/blog-v3-post.types.js.map +1 -0
package/build/cjs/src/blog-v3-post.universal.d.ts +2488 -0
package/build/cjs/src/blog-v3-post.universal.js +935 -0
package/build/cjs/src/blog-v3-post.universal.js.map +1 -0
package/build/cjs/src/blog-v3-tag.http.d.ts +45 -0
package/build/cjs/src/blog-v3-tag.http.js +385 -0
package/build/cjs/src/blog-v3-tag.http.js.map +1 -0
package/build/cjs/src/blog-v3-tag.public.d.ts +10 -0
package/build/cjs/src/blog-v3-tag.public.js +44 -0
package/build/cjs/src/blog-v3-tag.public.js.map +1 -0
package/build/cjs/src/blog-v3-tag.types.d.ts +345 -0
package/build/cjs/src/blog-v3-tag.types.js +15 -0
package/build/cjs/src/blog-v3-tag.types.js.map +1 -0
package/build/cjs/src/blog-v3-tag.universal.d.ts +512 -0
package/build/cjs/src/blog-v3-tag.universal.js +390 -0
package/build/cjs/src/blog-v3-tag.universal.js.map +1 -0
package/build/es/index.d.ts +3 -0
package/build/es/index.js +4 -0
package/build/es/index.js.map +1 -0
package/build/es/src/blog-v3-category.http.d.ts +50 -0
package/build/es/src/blog-v3-category.http.js +411 -0
package/build/es/src/blog-v3-category.http.js.map +1 -0
package/build/es/src/blog-v3-category.public.d.ts +11 -0
package/build/es/src/blog-v3-category.public.js +38 -0
package/build/es/src/blog-v3-category.public.js.map +1 -0
package/build/es/src/blog-v3-category.types.d.ts +391 -0
package/build/es/src/blog-v3-category.types.js +19 -0
package/build/es/src/blog-v3-category.types.js.map +1 -0
package/build/es/src/blog-v3-category.universal.d.ts +582 -0
package/build/es/src/blog-v3-category.universal.js +431 -0
package/build/es/src/blog-v3-category.universal.js.map +1 -0
package/build/es/src/blog-v3-post.http.d.ts +81 -0
package/build/es/src/blog-v3-post.http.js +834 -0
package/build/es/src/blog-v3-post.http.js.map +1 -0
package/build/es/src/blog-v3-post.public.d.ts +11 -0
package/build/es/src/blog-v3-post.public.js +38 -0
package/build/es/src/blog-v3-post.public.js.map +1 -0
package/build/es/src/blog-v3-post.types.d.ts +2227 -0
package/build/es/src/blog-v3-post.types.js +461 -0
package/build/es/src/blog-v3-post.types.js.map +1 -0
package/build/es/src/blog-v3-post.universal.d.ts +2488 -0
package/build/es/src/blog-v3-post.universal.js +906 -0
package/build/es/src/blog-v3-post.universal.js.map +1 -0
package/build/es/src/blog-v3-tag.http.d.ts +45 -0
package/build/es/src/blog-v3-tag.http.js +376 -0
package/build/es/src/blog-v3-tag.http.js.map +1 -0
package/build/es/src/blog-v3-tag.public.d.ts +10 -0
package/build/es/src/blog-v3-tag.public.js +33 -0
package/build/es/src/blog-v3-tag.public.js.map +1 -0
package/build/es/src/blog-v3-tag.types.d.ts +345 -0
package/build/es/src/blog-v3-tag.types.js +12 -0
package/build/es/src/blog-v3-tag.types.js.map +1 -0
package/build/es/src/blog-v3-tag.universal.d.ts +512 -0
package/build/es/src/blog-v3-tag.universal.js +362 -0
package/build/es/src/blog-v3-tag.universal.js.map +1 -0
package/package.json +37 -0

package/build/cjs/src/blog-v3-category.universal.d.ts ADDED Viewed

@@ -0,0 +1,582 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Category {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Category label. Displayed in the Category Menu. */
+    label?: string;
+    /**
+     * Number of posts in the category.
+     * @readonly
+     */
+    postCount?: number;
+    /**
+     * Category URL.
+     *
+     *
+     * The `url` directs you to a page that lists every post with the specified category.
+     *
+     * @readonly
+     */
+    url?: string;
+    /** Category description. */
+    description?: string | null;
+    /** Category title. */
+    title?: string;
+    /** Reserved for internal use.  */
+    rank?: number | null;
+    /** Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu). Categories with lower display position are displayed first. */
+    displayPosition?: number | null;
+    /** ID of the category's translations when [Wix Multilingual](https://wix.wixanswers.com/app/kb/article/36837a9d-5d22-4fa1-9a80-1b99b7f82b5e/en) is installed on a site. All translations of a single category will share the same `translationId`.  */
+    translationId?: string | null;
+    /**
+     * Category Language.</br>
+     * 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
+     */
+    language?: string;
+    /**
+     * Part of a category's URL that refers to a specific category.
+     *
+     *
+     * For example, `'https:/example.com/blog/category/{my-category-slug}'`.
+     */
+    slug?: string;
+    /** SEO data. */
+    seoData?: SeoSchema;
+    /** Category cover image. */
+    coverImage?: string;
+}
+export interface CoverMedia extends CoverMediaMediaOneOf {
+    /** Whether cover media is displayed. */
+    displayed?: boolean;
+    /** If `false`, the cover image is the first media item appearing in the content. */
+    custom?: boolean;
+    /** Image url. */
+    image?: string;
+    /** Video url. */
+    video?: string;
+}
+/** @oneof */
+export interface CoverMediaMediaOneOf {
+    /** Image url. */
+    image?: string;
+    /** Video url. */
+    video?: string;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * 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.
+ */
+export interface SeoSchema {
+    /** SEO tag information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Tag {
+    /** SEO tag type. Supported values: `title`, `meta`, `script`, `link`. */
+    type?: string;
+    /** SEO tag attributes/properties (name, content, rel, href). */
+    props?: Record<string, any> | null;
+    /** Tag meta data, e.g. {height: 300, width: 240}. */
+    meta?: Record<string, any> | null;
+    /** Tag inner content e.g. `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /** disable auto creation of 301 redirects on slug changes (enabled by default). */
+    preventAutoRedirect?: boolean;
+}
+export interface CreateCategoryRequest {
+    /** Category info. */
+    category: Category;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export declare enum Field {
+    UNKNOWN = "UNKNOWN",
+    /** Includes Category url. */
+    URL = "URL",
+    /**
+     * Includes internal id field.
+     * Reserved for internal use
+     */
+    INTERNAL_ID = "INTERNAL_ID",
+    /** Includes SEO data. */
+    SEO = "SEO"
+}
+export interface CreateCategoryResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface BulkCreateCategoriesRequest {
+    /** Categories to create. */
+    categories?: Category[];
+    /** Whether to return the full created category entities in the response. */
+    returnFullEntity?: boolean;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface BulkCreateCategoriesResponse {
+    /** Categories created by bulk action. */
+    results?: BulkCategoryResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkCategoryResult {
+    /** Bulk actions metadata for category. */
+    itemMetadata?: ItemMetadata;
+    /** Optional created 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 {
+    code?: string;
+    description?: string;
+    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 info. */
+    category: Category;
+    /** Field mask of fields to update. */
+    fieldMask?: string[];
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface UpdateCategoryResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface GetCategoryRequest {
+    /** Category ID. */
+    categoryId: string;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface GetCategoryResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface GetCategoryBySlugRequest {
+    /** Slug of the category to retrieve. */
+    slug: string;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface GetCategoryBySlugResponse {
+    /** Category info. */
+    category?: Category;
+}
+export interface ListCategoriesRequest {
+    /** Pagination options. */
+    paging?: BlogPaging;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface BlogPaging {
+    /** Number of categories to skip in the list. */
+    offset?: number;
+    /**
+     * Number of items to return.
+     *
+     * Default: `50`
+     *
+     * Max: `100`
+     */
+    limit?: number;
+    /** Pointer to the next or previous page in the list of results. */
+    cursor?: string | null;
+}
+export interface ListCategoriesResponse {
+    /** List of categories. */
+    categories?: Category[];
+    /** Details on the paged set of results returned. */
+    metaData?: MetaData;
+}
+export interface MetaData {
+    /** Number of items returned in this response. */
+    count?: number;
+    /** Number of items skipped. */
+    offset?: number;
+    /** Total number of items that match the query. */
+    total?: number;
+    /** Pointer to the next or previous page in the list of results. */
+    cursor?: string | null;
+}
+export interface QueryCategoriesRequest {
+    /** Query options. */
+    query?: PlatformQuery;
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+    /** 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;
+}
+/** @oneof */
+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;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QueryCategoriesResponse {
+    /** List of categories. */
+    categories?: Category[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: 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 DeleteCategoryRequest {
+    /** Category ID. */
+    categoryId: string;
+}
+export interface DeleteCategoryResponse {
+}
+/**
+ * Creates a category.
+ * @param category - Category info.
+ * @public
+ * @requiredField category
+ * @requiredField category.label
+ */
+export declare function createCategory(category: Category, options?: CreateCategoryOptions): Promise<CreateCategoryResponse>;
+export interface CreateCategoryOptions {
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+/**
+ * Updates a category.
+ * @param _id - Category ID.
+ * @public
+ * @requiredField _id
+ * @requiredField category
+ */
+export declare function updateCategory(_id: string, category: UpdateCategory, options?: UpdateCategoryOptions): Promise<UpdateCategoryResponse>;
+export interface UpdateCategory {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Category label. Displayed in the Category Menu. */
+    label?: string;
+    /**
+     * Number of posts in the category.
+     * @readonly
+     */
+    postCount?: number;
+    /**
+     * Category URL.
+     *
+     *
+     * The `url` directs you to a page that lists every post with the specified category.
+     *
+     * @readonly
+     */
+    url?: string;
+    /** Category description. */
+    description?: string | null;
+    /** Category title. */
+    title?: string;
+    /** Reserved for internal use. */
+    rank?: number | null;
+    /** Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu). Categories with lower display position are displayed first. */
+    displayPosition?: number | null;
+    /** ID of the category's translations when [Wix Multilingual](https://wix.wixanswers.com/app/kb/article/36837a9d-5d22-4fa1-9a80-1b99b7f82b5e/en) is installed on a site. All translations of a single category will share the same `translationId`. */
+    translationId?: string | null;
+    /**
+     * Category Language.</br>
+     * 2-letter language code in [ISO 639-1 format](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
+     */
+    language?: string;
+    /**
+     * Part of a category's URL that refers to a specific category.
+     *
+     *
+     * For example, `'https:/example.com/blog/category/{my-category-slug}'`.
+     */
+    slug?: string;
+    /** SEO data. */
+    seoData?: SeoSchema;
+    /** Category cover image. */
+    coverImage?: string;
+}
+export interface UpdateCategoryOptions {
+    /** Field mask of fields to update. */
+    fieldMask?: string[];
+    /**
+     * List of category fields to be included if entities are present in the response.
+     * Base fieldset, which is default, will return all core category properties.
+     * Example: When URL fieldset is selected, returned category will have a set of base properties and category url.
+     */
+    fieldsets?: Field[];
+}
+/**
+ * Gets a category by the specified ID.
+ *
+ *
+ * The `getCategory()` function returns a Promise that resolves to a category whose ID matches the specified ID.
+ *
+ * @param categoryId - Category ID.
+ * @public
+ * @requiredField categoryId
+ * @param options - Options specifying which fields to return.
+ */
+export declare function getCategory(categoryId: string, options?: GetCategoryOptions): Promise<GetCategoryResponse>;
+export interface GetCategoryOptions {
+    /**
+     * List of category fields to be included in the response. By default, any fields not passed are not returned.
+     *
+     * Supported Values:
+     * `"SEO"` and `"URL"`.
+     */
+    fieldsets?: Field[];
+}
+/**
+ * Gets a category by the specified slug.
+ *
+ *
+ * The `getCategoryBySlug()` function returns a Promise that resolves to a category whose slug matches the specified slug.
+ *
+ * The `slug` is the end of a category's URL that refers to a specific category. For example, if a category's URL is `https://example.com/blog/category/{my-category-slug}`, the slug is `my-post-slug`. The slug is case-sensitive string that is generally derived from the category's `label`, unless specified otherwise.
+ *
+ * @public
+ * @requiredField GetCategoryBySlugRequest
+ * @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.
+ */
+export declare function getCategoryBySlug(slug: string, options?: GetCategoryBySlugOptions): Promise<GetCategoryBySlugResponse>;
+export interface GetCategoryBySlugOptions {
+    /**
+     * List of category fields to be included in the response. By default, any fields not passed are not returned.
+     *
+     * Supported Values:
+     * `"SEO"` and `"URL"`.
+     */
+    fieldsets?: Field[];
+}
+/**
+ * Retrieves a list of categories.
+ *
+ *
+ * The `listCategories()` function returns a Promise that resolves to a list of up to 100 categories per language 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 with a `displayPosition` of `-1`.
+ * @public
+ * @param options - Filter and paging options.
+ */
+export declare function listCategories(options?: ListCategoriesOptions): Promise<ListCategoriesResponse>;
+export interface ListCategoriesOptions {
+    /** Pagination options. */
+    paging?: BlogPaging;
+    /**
+     * List of category fields to be included in the response. By default, any fields not passed are not returned.
+     *
+     * Supported Values:
+     * `"SEO"` and `"URL"`.
+     */
+    fieldsets?: Field[];
+}
+/**
+ * Creates a query to retrieve a list of categories.
+ *
+ *
+ * The `queryCategories()` function builds a query to retrieve a list of up to 100 categories per language, and returns a [`CategoriesQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/category/categoriesquerybuilder) object.
+ *
+ * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-blog-backend/category/categoriesquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `CategoriesQueryBuilder` functions to the query. `CategoriesQueryBuilder` functions enable you to sort, filter, and control the results that `queryCategories` returns. Any functions chained to the `queryCategories()` function are applied in the order that they are called.
+ *
+ * `queryCategories()` runs with these `CategoriesQueryBuilder` defaults, which you can override.
+ * - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/category/categoriesquerybuilder/limit)
+ * - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/category/categoriesquerybuilder/ascending)
+ *
+ * The following `CategoriesQueryBuilder` functions are supported for `queryCategories()`. For a full description of the `Categories` object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/category/categoriesqueryresult/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/category/categoriesqueryresult).
+ * @public */
+export declare function queryCategories(): CategoriesQueryBuilder;
+interface QueryOffsetResult {
+    currentPage: number;
+    totalPages: number;
+    totalCount: number;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface CategoriesQueryResult extends QueryOffsetResult {
+    items: Category[];
+    query: CategoriesQueryBuilder;
+    next: () => Promise<CategoriesQueryResult>;
+    prev: () => Promise<CategoriesQueryResult>;
+}
+export interface CategoriesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    eq: (propertyName: string, value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ne: (propertyName: string, value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ge: (propertyName: string, value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    gt: (propertyName: string, value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    le: (propertyName: string, value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    lt: (propertyName: string, value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     */
+    startsWith: (propertyName: string, value: string) => CategoriesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    ascending: (...propertyNames: string[]) => CategoriesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    descending: (...propertyNames: string[]) => CategoriesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
+    limit: (limit: number) => CategoriesQueryBuilder;
+    /** @param skip - Number of items to skip in the query results before returning the results. */
+    skip: (skip: number) => CategoriesQueryBuilder;
+    find: () => Promise<CategoriesQueryResult>;
+}
+/**
+ * Deletes a category.
+ * @param categoryId - Category ID.
+ * @public
+ * @requiredField categoryId
+ */
+export declare function deleteCategory(categoryId: string): Promise<void>;
+export {};