Socket
Socket
Sign inDemoInstall

@wix/blog_categories

Package Overview
Dependencies
Maintainers
0
Versions
31
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@wix/blog_categories - npm Package Compare versions

Comparing version 1.0.36 to 1.0.37

2

build/cjs/index.d.ts

@@ -1,1 +0,1 @@

export * from './src/blog-v3-category-categories.public';
export * from './src/blog-v3-category-categories.context';

@@ -17,3 +17,3 @@ "use strict";

Object.defineProperty(exports, "__esModule", { value: true });
__exportStar(require("./src/blog-v3-category-categories.public"), exports);
__exportStar(require("./src/blog-v3-category-categories.context"), exports);
//# sourceMappingURL=index.js.map
import { getCategory as publicGetCategory, getCategoryBySlug as publicGetCategoryBySlug, listCategories as publicListCategories, queryCategories as publicQueryCategories } from './blog-v3-category-categories.public';
import { BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
import { BuildRESTFunction } from '@wix/sdk-types';
import { onCategoryCreated as publicOnCategoryCreated } from './blog-v3-category-categories.public';
import { onCategoryUpdated as publicOnCategoryUpdated } from './blog-v3-category-categories.public';
import { onCategoryDeleted as publicOnCategoryDeleted } from './blog-v3-category-categories.public';
export declare const getCategory: BuildRESTFunction<typeof publicGetCategory>;
export declare const getCategoryBySlug: BuildRESTFunction<typeof publicGetCategoryBySlug>;
export declare const listCategories: BuildRESTFunction<typeof publicListCategories>;
export declare const queryCategories: BuildRESTFunction<typeof publicQueryCategories>;
export declare const onCategoryCreated: BuildEventDefinition<typeof publicOnCategoryCreated>;
export declare const onCategoryUpdated: BuildEventDefinition<typeof publicOnCategoryUpdated>;
export declare const onCategoryDeleted: BuildEventDefinition<typeof publicOnCategoryDeleted>;
export declare const getCategory: BuildRESTFunction<typeof publicGetCategory> & typeof publicGetCategory;
export declare const getCategoryBySlug: BuildRESTFunction<typeof publicGetCategoryBySlug> & typeof publicGetCategoryBySlug;
export declare const listCategories: BuildRESTFunction<typeof publicListCategories> & typeof publicListCategories;
export declare const queryCategories: BuildRESTFunction<typeof publicQueryCategories> & typeof publicQueryCategories;
export { publicOnCategoryCreated };
export type _publicOnCategoryCreatedType = typeof publicOnCategoryCreated;
/**
* Triggered when a category is created.
*/
export declare const onCategoryCreated: ReturnType<typeof createEventModule<_publicOnCategoryCreatedType>>;
export { publicOnCategoryUpdated };
export type _publicOnCategoryUpdatedType = typeof publicOnCategoryUpdated;
/**
* Triggered when a category is updated.
*/
export declare const onCategoryUpdated: ReturnType<typeof createEventModule<_publicOnCategoryUpdatedType>>;
export { publicOnCategoryDeleted };
export type _publicOnCategoryDeletedType = typeof publicOnCategoryDeleted;
/**
* Triggered when a category is deleted.
*/
export declare const onCategoryDeleted: ReturnType<typeof createEventModule<_publicOnCategoryDeletedType>>;
export { Field, SortOrder, WebhookIdentityType, } from './blog-v3-category-categories.universal';
export { Category, SeoSchema, Keyword, Tag, Settings, CategoryTranslation, InitialCategoriesCopied, CreateCategoryRequest, CreateCategoryResponse, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkCategoryResult, ItemMetadata, ApplicationError, BulkActionMetadata, BulkUpdateCategoriesRequest, MaskedCategory, BulkUpdateCategoriesResponse, UpdateCategoryRequest, UpdateCategoryResponse, GetCategoriesCountByLanguageRequest, GetCategoriesCountByLanguageResponse, CategoryLanguageCount, GetCategoryRequest, GetCategoryResponse, GetCategoryBySlugRequest, GetCategoryBySlugResponse, ListCategoriesRequest, BlogPaging, ListCategoriesResponse, MetaData, QueryCategoriesRequest, PlatformQuery, PlatformQueryPagingMethodOneOf, Sorting, Paging, CursorPaging, QueryCategoriesResponse, PagingMetadataV2, Cursors, BulkDeleteCategoryRequest, BulkDeleteCategoryResponse, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, GetCategoryResponseNonNullableFields, GetCategoryBySlugResponseNonNullableFields, ListCategoriesResponseNonNullableFields, QueryCategoriesResponseNonNullableFields, BaseEventMetadata, EventMetadata, CategoryCreatedEnvelope, CategoryUpdatedEnvelope, CategoryDeletedEnvelope, GetCategoryOptions, GetCategoryBySlugOptions, ListCategoriesOptions, QueryCategoriesOptions, CategoriesQueryResult, CategoriesQueryBuilder, } from './blog-v3-category-categories.universal';
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.onCategoryDeleted = exports.onCategoryUpdated = exports.onCategoryCreated = exports.queryCategories = exports.listCategories = exports.getCategoryBySlug = exports.getCategory = void 0;
exports.WebhookIdentityType = exports.SortOrder = exports.Field = exports.onCategoryDeleted = exports.publicOnCategoryDeleted = exports.onCategoryUpdated = exports.publicOnCategoryUpdated = exports.onCategoryCreated = exports.publicOnCategoryCreated = exports.queryCategories = exports.listCategories = exports.getCategoryBySlug = exports.getCategory = void 0;
const blog_v3_category_categories_public_1 = require("./blog-v3-category-categories.public");
const context_1 = require("@wix/sdk-runtime/context");
const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
const event_definition_modules_1 = require("@wix/sdk-runtime/event-definition-modules");
const blog_v3_category_categories_public_2 = require("./blog-v3-category-categories.public");
Object.defineProperty(exports, "publicOnCategoryCreated", { enumerable: true, get: function () { return blog_v3_category_categories_public_2.onCategoryCreated; } });
const blog_v3_category_categories_public_3 = require("./blog-v3-category-categories.public");
Object.defineProperty(exports, "publicOnCategoryUpdated", { enumerable: true, get: function () { return blog_v3_category_categories_public_3.onCategoryUpdated; } });
const blog_v3_category_categories_public_4 = require("./blog-v3-category-categories.public");
exports.getCategory = (0, context_1.contextualizeRESTModule)(blog_v3_category_categories_public_1.getCategory, 1);
exports.getCategoryBySlug = (0, context_1.contextualizeRESTModule)(blog_v3_category_categories_public_1.getCategoryBySlug, 1);
exports.listCategories = (0, context_1.contextualizeRESTModule)(blog_v3_category_categories_public_1.listCategories, 1);
exports.queryCategories = (0, context_1.contextualizeRESTModule)(blog_v3_category_categories_public_1.queryCategories, 1);
exports.onCategoryCreated = (0, context_1.contextualizeEventDefinitionModule)(blog_v3_category_categories_public_2.onCategoryCreated);
exports.onCategoryUpdated = (0, context_1.contextualizeEventDefinitionModule)(blog_v3_category_categories_public_3.onCategoryUpdated);
exports.onCategoryDeleted = (0, context_1.contextualizeEventDefinitionModule)(blog_v3_category_categories_public_4.onCategoryDeleted);
Object.defineProperty(exports, "publicOnCategoryDeleted", { enumerable: true, get: function () { return blog_v3_category_categories_public_4.onCategoryDeleted; } });
exports.getCategory = (0, rest_modules_1.createRESTModule)(blog_v3_category_categories_public_1.getCategory);
exports.getCategoryBySlug = (0, rest_modules_1.createRESTModule)(blog_v3_category_categories_public_1.getCategoryBySlug);
exports.listCategories = (0, rest_modules_1.createRESTModule)(blog_v3_category_categories_public_1.listCategories);
exports.queryCategories = (0, rest_modules_1.createRESTModule)(blog_v3_category_categories_public_1.queryCategories);
/**
* Triggered when a category is created.
*/
exports.onCategoryCreated = (0, event_definition_modules_1.createEventModule)(blog_v3_category_categories_public_2.onCategoryCreated);
/**
* Triggered when a category is updated.
*/
exports.onCategoryUpdated = (0, event_definition_modules_1.createEventModule)(blog_v3_category_categories_public_3.onCategoryUpdated);
/**
* Triggered when a category is deleted.
*/
exports.onCategoryDeleted = (0, event_definition_modules_1.createEventModule)(blog_v3_category_categories_public_4.onCategoryDeleted);
var blog_v3_category_categories_universal_1 = require("./blog-v3-category-categories.universal");
Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return blog_v3_category_categories_universal_1.Field; } });
Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return blog_v3_category_categories_universal_1.SortOrder; } });
Object.defineProperty(exports, "WebhookIdentityType", { enumerable: true, get: function () { return blog_v3_category_categories_universal_1.WebhookIdentityType; } });
//# sourceMappingURL=blog-v3-category-categories.context.js.map

@@ -42,2 +42,8 @@ "use strict";

],
'wix-bo.com': [
{
srcPath: '/_api/communities-blog-node-api/v3/categories',
destPath: '/v3/categories',
},
],
'editor.wixapps.net': [

@@ -107,2 +113,8 @@ {

],
'api._api_base_domain_': [
{
srcPath: '/category-service-api-proxy',
destPath: '',
},
],
};

@@ -131,4 +143,2 @@ return (0, metro_runtime_2.resolveUrl)(Object.assign(opts, { domainToMappings }));

{ path: 'category.updatedDate' },
{ path: 'category.coverMedia.image.urlExpirationDate' },
{ path: 'category.coverMedia.video.thumbnail.urlExpirationDate' },
{ path: 'category.coverImage.urlExpirationDate' },

@@ -166,4 +176,2 @@ ],

{ path: 'category.updatedDate' },
{ path: 'category.coverMedia.image.urlExpirationDate' },
{ path: 'category.coverMedia.video.thumbnail.urlExpirationDate' },
{ path: 'category.coverImage.urlExpirationDate' },

@@ -198,6 +206,2 @@ ],

{ path: 'categories.updatedDate' },
{ path: 'categories.coverMedia.image.urlExpirationDate' },
{
path: 'categories.coverMedia.video.thumbnail.urlExpirationDate',
},
{ path: 'categories.coverImage.urlExpirationDate' },

@@ -242,6 +246,2 @@ ],

{ path: 'categories.updatedDate' },
{ path: 'categories.coverMedia.image.urlExpirationDate' },
{
path: 'categories.coverMedia.video.thumbnail.urlExpirationDate',
},
{ path: 'categories.coverImage.urlExpirationDate' },

@@ -248,0 +248,0 @@ ],

import { EventDefinition, HttpClient } from '@wix/sdk-types';
import { CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryUpdatedEnvelope, GetCategoryBySlugOptions, GetCategoryOptions, ListCategoriesOptions, QueryCategoriesOptions } from './blog-v3-category-categories.universal';
import { CategoriesQueryBuilder, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryUpdatedEnvelope, GetCategoryBySlugOptions, GetCategoryBySlugResponse, GetCategoryBySlugResponseNonNullableFields, GetCategoryOptions, GetCategoryResponse, GetCategoryResponseNonNullableFields, ListCategoriesOptions, ListCategoriesResponse, ListCategoriesResponseNonNullableFields, QueryCategoriesOptions } from './blog-v3-category-categories.universal';
export declare const __metadata: {
PACKAGE_NAME: string;
};
export declare function getCategory(httpClient: HttpClient): (categoryId: string, options?: GetCategoryOptions) => Promise<import("./blog-v3-category-categories.universal").GetCategoryResponse & import("./blog-v3-category-categories.universal").GetCategoryResponseNonNullableFields>;
export declare function getCategoryBySlug(httpClient: HttpClient): (slug: string, options?: GetCategoryBySlugOptions) => Promise<import("./blog-v3-category-categories.universal").GetCategoryBySlugResponse & import("./blog-v3-category-categories.universal").GetCategoryBySlugResponseNonNullableFields>;
export declare function listCategories(httpClient: HttpClient): (options?: ListCategoriesOptions) => Promise<import("./blog-v3-category-categories.universal").ListCategoriesResponse & import("./blog-v3-category-categories.universal").ListCategoriesResponseNonNullableFields>;
export declare function queryCategories(httpClient: HttpClient): (options?: QueryCategoriesOptions) => import("./blog-v3-category-categories.universal").CategoriesQueryBuilder;
export declare function getCategory(httpClient: HttpClient): GetCategorySignature;
interface GetCategorySignature {
/**
* 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 - Category ID.
* @param - Options specifying which fields to return.
*/
(categoryId: string, options?: GetCategoryOptions | undefined): Promise<GetCategoryResponse & GetCategoryResponseNonNullableFields>;
}
export declare function getCategoryBySlug(httpClient: HttpClient): GetCategoryBySlugSignature;
interface GetCategoryBySlugSignature {
/**
* 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.
*
* @param - 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 specifying which fields to return.
*/
(slug: string, options?: GetCategoryBySlugOptions | undefined): Promise<GetCategoryBySlugResponse & GetCategoryBySlugResponseNonNullableFields>;
}
export declare function listCategories(httpClient: HttpClient): ListCategoriesSignature;
interface ListCategoriesSignature {
/**
* 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`.
* @param - Filter and paging options.
*/
(options?: ListCategoriesOptions | undefined): Promise<ListCategoriesResponse & ListCategoriesResponseNonNullableFields>;
}
export declare function queryCategories(httpClient: HttpClient): QueryCategoriesSignature;
interface QueryCategoriesSignature {
/**
* 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/categories/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/categories/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/categories/categoriesquerybuilder/limit)
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/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/categories/categoriesqueryresult/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).
* @param - Options specifying which fields to return.
*/
(options?: QueryCategoriesOptions | undefined): CategoriesQueryBuilder;
}
export declare const onCategoryCreated: EventDefinition<CategoryCreatedEnvelope, "wix.blog.v3.category_created">;
export declare const onCategoryUpdated: EventDefinition<CategoryUpdatedEnvelope, "wix.blog.v3.category_updated">;
export declare const onCategoryDeleted: EventDefinition<CategoryDeletedEnvelope, "wix.blog.v3.category_deleted">;
export { ActionEvent, ApplicationError, BaseEventMetadata, BlogPaging, BulkActionMetadata, BulkCategoryResult, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkDeleteCategoryRequest, BulkDeleteCategoryResponse, BulkUpdateCategoriesRequest, BulkUpdateCategoriesResponse, CategoriesQueryBuilder, CategoriesQueryResult, Category, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryLanguageCount, CategoryTranslation, CategoryUpdatedEnvelope, CoverMedia, CoverMediaMediaOneOf, CreateCategoryRequest, CreateCategoryResponse, CursorPaging, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Field, GetCategoriesCountByLanguageRequest, GetCategoriesCountByLanguageResponse, GetCategoryBySlugOptions, GetCategoryBySlugRequest, GetCategoryBySlugResponse, GetCategoryBySlugResponseNonNullableFields, GetCategoryOptions, GetCategoryRequest, GetCategoryResponse, GetCategoryResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, InitialCategoriesCopied, ItemMetadata, Keyword, ListCategoriesOptions, ListCategoriesRequest, ListCategoriesResponse, ListCategoriesResponseNonNullableFields, MaskedCategory, MessageEnvelope, MetaData, Paging, PagingMetadataV2, PlatformQuery, PlatformQueryPagingMethodOneOf, QueryCategoriesOptions, QueryCategoriesRequest, QueryCategoriesResponse, QueryCategoriesResponseNonNullableFields, SeoSchema, Settings, SortOrder, Sorting, Tag, UpdateCategoryRequest, UpdateCategoryResponse, WebhookIdentityType, } from './blog-v3-category-categories.universal';
export { ActionEvent, ApplicationError, BaseEventMetadata, BlogPaging, BulkActionMetadata, BulkCategoryResult, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkDeleteCategoryRequest, BulkDeleteCategoryResponse, BulkUpdateCategoriesRequest, BulkUpdateCategoriesResponse, CategoriesQueryBuilder, CategoriesQueryResult, Category, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryLanguageCount, CategoryTranslation, CategoryUpdatedEnvelope, CreateCategoryRequest, CreateCategoryResponse, CursorPaging, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Field, GetCategoriesCountByLanguageRequest, GetCategoriesCountByLanguageResponse, GetCategoryBySlugOptions, GetCategoryBySlugRequest, GetCategoryBySlugResponse, GetCategoryBySlugResponseNonNullableFields, GetCategoryOptions, GetCategoryRequest, GetCategoryResponse, GetCategoryResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, InitialCategoriesCopied, ItemMetadata, Keyword, ListCategoriesOptions, ListCategoriesRequest, ListCategoriesResponse, ListCategoriesResponseNonNullableFields, MaskedCategory, MessageEnvelope, MetaData, Paging, PagingMetadataV2, PlatformQuery, PlatformQueryPagingMethodOneOf, QueryCategoriesOptions, QueryCategoriesRequest, QueryCategoriesResponse, QueryCategoriesResponseNonNullableFields, RestoreInfo, SeoSchema, Settings, SortOrder, Sorting, Tag, UpdateCategoryRequest, UpdateCategoryResponse, WebhookIdentityType, } from './blog-v3-category-categories.universal';

@@ -9,3 +9,2 @@ "use strict";

const transform_paths_1 = require("@wix/sdk-runtime/transformations/transform-paths");
const video_1 = require("@wix/sdk-runtime/transformations/video");
const sdk_types_1 = require("@wix/sdk-types");

@@ -45,6 +44,3 @@ const blog_v3_category_categories_universal_1 = require("./blog-v3-category-categories.universal");

transformFn: image_1.transformRESTImageToSDKImage,
paths: [
{ path: 'entity.coverImage' },
{ path: 'entity.coverMedia.image' },
],
paths: [{ path: 'entity.coverImage' }],
},

@@ -58,6 +54,2 @@ {

},
{
transformFn: video_1.transformRESTVideoToSDKVideo,
paths: [{ path: 'entity.coverMedia.video' }],
},
])))();

@@ -71,6 +63,3 @@ exports.onCategoryUpdated = (0, sdk_types_1.EventDefinition)('wix.blog.v3.category_updated', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [

transformFn: image_1.transformRESTImageToSDKImage,
paths: [
{ path: 'entity.coverImage' },
{ path: 'entity.coverMedia.image' },
],
paths: [{ path: 'entity.coverImage' }],
},

@@ -84,6 +73,2 @@ {

},
{
transformFn: video_1.transformRESTVideoToSDKVideo,
paths: [{ path: 'entity.coverMedia.video' }],
},
])))();

@@ -100,6 +85,3 @@ exports.onCategoryDeleted = (0, sdk_types_1.EventDefinition)('wix.blog.v3.category_deleted', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [

transformFn: image_1.transformRESTImageToSDKImage,
paths: [
{ path: 'undefined.coverImage' },
{ path: 'undefined.coverMedia.image' },
],
paths: [{ path: 'undefined.coverImage' }],
},

@@ -113,6 +95,2 @@ {

},
{
transformFn: video_1.transformRESTVideoToSDKVideo,
paths: [{ path: 'undefined.coverMedia.video' }],
},
])))();

@@ -119,0 +97,0 @@ var blog_v3_category_categories_universal_2 = require("./blog-v3-category-categories.universal");

export interface Category {
/**
* Category ID.
* @readonly
*/
/** Category ID. */
id?: string;

@@ -24,27 +21,6 @@ /** Category label. Displayed in the Category Menu. */

/**
* __Deprecated.__ Use `coverImage` instead.
* This property will be removed on June 30, 2023.
*
* Category cover image or video.
* @deprecated
* @replacedBy cover_image
* @removalDate 2024-06-30
*/
coverMedia?: CoverMedia;
/**
* Reserved for internal use.
* @readonly
*/
oldRank?: number;
/**
* __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated Category position in sequence.
* @replacedBy display_position
* @removalDate 2024-06-30
* @targetRemovalDate 2024-06-30
*/

@@ -63,3 +39,3 @@ rank?: number | null;

*
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
*/

@@ -90,70 +66,2 @@ language?: string | null;

}
export interface CoverMedia extends CoverMediaMediaOneOf {
/** Image url. */
image?: Image;
/** Video url. */
video?: Video;
/**
* Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @deprecated Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @replacedBy displayed
* @removalDate 2024-06-30
*/
enabled?: boolean;
/** Whether cover media is displayed. */
displayed?: boolean;
/** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
custom?: boolean;
}
/** @oneof */
export interface CoverMediaMediaOneOf {
/** Image url. */
image?: Image;
/** Video url. */
video?: Video;
}
export interface Image {
/** WixMedia image ID. */
id?: string;
/** Image URL. */
url?: string;
/**
* Original image height.
* @readonly
*/
height?: number;
/**
* Original image width.
* @readonly
*/
width?: number;
/** Image alt text. */
altText?: string | null;
/**
* Image filename.
* @readonly
*/
filename?: string | null;
}
/** Deprecated - use VideoV2 */
export interface Video {
/** WixMedia ID */
id?: string;
/** URL of video */
url?: string;
/**
* Original image height
* @readonly
*/
height?: number;
/**
* Original image width
* @readonly
*/
width?: number;
/** Video poster */
thumbnail?: Image;
}
/**

@@ -175,2 +83,4 @@ * 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.

isMain?: boolean;
/** Who added the keyword to the settings */
origin?: string | null;
}

@@ -210,2 +120,25 @@ export interface Tag {

}
export interface Image {
/** WixMedia image ID. */
id?: string;
/** Image URL. */
url?: string;
/**
* Original image height.
* @readonly
*/
height?: number;
/**
* Original image width.
* @readonly
*/
width?: number;
/** Image alt text. */
altText?: string | null;
/**
* Image filename.
* @readonly
*/
filename?: string | null;
}
export interface CategoryTranslation {

@@ -346,3 +279,3 @@ /** Category ID */

export interface CategoryLanguageCount {
/** 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
/** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */
languageCode?: string | null;

@@ -356,15 +289,2 @@ /** The count of Categories for the language. */

/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -384,15 +304,2 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -404,3 +311,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -418,17 +325,2 @@ */

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -442,3 +334,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -484,54 +376,2 @@ * If omitted, categories in all languages are returned.

export interface QueryCategoriesRequest {
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[];
/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** Query options. */

@@ -546,12 +386,2 @@ query?: PlatformQuery;

}
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 {

@@ -584,2 +414,12 @@ /** Paging options to limit and skip the number of items. */

}
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 Paging {

@@ -606,15 +446,2 @@ /** Number of items to load. */

categories?: Category[];
/**
* __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @deprecated __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @replacedBy pagingMetadata
* @removalDate 2024-06-30
*/
metaData?: MetaData;
/** Details on the paged set of results returned. */

@@ -678,3 +505,3 @@ pagingMetadata?: PagingMetadataV2;

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -707,3 +534,8 @@ /**

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;
}
export interface EntityUpdatedEvent {

@@ -764,271 +596,63 @@ /**

}
interface PageUrlNonNullableFields {
base: string;
path: string;
}
interface TagNonNullableFields {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}
interface KeywordNonNullableFields {
term: string;
isMain: boolean;
}
interface SettingsNonNullableFields {
preventAutoRedirect: boolean;
keywords: KeywordNonNullableFields[];
}
interface SeoSchemaNonNullableFields {
tags: TagNonNullableFields[];
settings?: SettingsNonNullableFields;
}
interface ImageNonNullableFields {
id: string;
url: string;
height: number;
width: number;
}
interface CategoryTranslationNonNullableFields {
id: string;
url?: PageUrlNonNullableFields;
}
interface CategoryNonNullableFields {
id: string;
label: string;
postCount: number;
url?: PageUrlNonNullableFields;
title: string;
slug: string;
seoData?: SeoSchemaNonNullableFields;
coverImage?: ImageNonNullableFields;
translations: CategoryTranslationNonNullableFields[];
}
export interface GetCategoryResponseNonNullableFields {
category?: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
};
category?: CategoryNonNullableFields;
}
export interface GetCategoryBySlugResponseNonNullableFields {
category?: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
};
category?: CategoryNonNullableFields;
}
interface MetaDataNonNullableFields {
count: number;
offset: number;
total: number;
}
export interface ListCategoriesResponseNonNullableFields {
categories: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
metaData?: MetaDataNonNullableFields;
}
export interface QueryCategoriesResponseNonNullableFields {
categories: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
}
export {};
export interface Category {
/**
* Category ID.
* @readonly
*/
/** Category ID. */
_id?: string;

@@ -29,20 +26,5 @@ /** Category label. Displayed in the Category Menu. */

* Reserved for internal use.
* @deprecated
* @replacedBy cover_image
* @removalDate 2024-06-30
*/
coverMedia?: CoverMedia;
/**
* Reserved for internal use.
* @readonly
*/
oldRank?: number;
/**
* Reserved for internal use.
* @deprecated __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated Category position in sequence.
* @replacedBy display_position
* @removalDate 2024-06-30
* @targetRemovalDate 2024-06-30
*/

@@ -82,28 +64,2 @@ rank?: number | null;

}
export interface CoverMedia extends CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
/**
* Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @deprecated Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @replacedBy displayed
* @removalDate 2024-06-30
*/
enabled?: boolean;
/** Whether cover media is displayed. */
displayed?: boolean;
/** If `false`, the cover image is the first media item appearing in the content. */
custom?: boolean;
}
/** @oneof */
export interface CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
}
/**

@@ -125,2 +81,4 @@ * 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.

isMain?: boolean;
/** Who added the keyword to the settings */
origin?: string | null;
}

@@ -295,3 +253,3 @@ export interface Tag {

export interface CategoryLanguageCount {
/** 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
/** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */
languageCode?: string | null;

@@ -305,15 +263,2 @@ /** The count of Categories for the language. */

/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -333,15 +278,2 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -353,3 +285,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -367,17 +299,2 @@ */

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -391,3 +308,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -429,54 +346,2 @@ * If omitted, categories in all languages are returned.

export interface QueryCategoriesRequest {
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[];
/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** Query options. */

@@ -491,12 +356,2 @@ query?: PlatformQuery;

}
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 {

@@ -529,2 +384,12 @@ /** Paging options to limit and skip the number of items. */

}
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 Paging {

@@ -551,15 +416,2 @@ /** Number of items to load. */

categories?: Category[];
/**
* __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @deprecated __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @replacedBy pagingMetadata
* @removalDate 2024-06-30
*/
metaData?: MetaData;
/** Details on the paged set of results returned. */

@@ -623,3 +475,3 @@ pagingMetadata?: PagingMetadataV2;

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -653,2 +505,5 @@ /**

}
export interface RestoreInfo {
deletedDate?: Date;
}
export interface EntityUpdatedEvent {

@@ -709,147 +564,52 @@ /**

}
interface TagNonNullableFields {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}
interface KeywordNonNullableFields {
term: string;
isMain: boolean;
}
interface SettingsNonNullableFields {
preventAutoRedirect: boolean;
keywords: KeywordNonNullableFields[];
}
interface SeoSchemaNonNullableFields {
tags: TagNonNullableFields[];
settings?: SettingsNonNullableFields;
}
interface CategoryTranslationNonNullableFields {
_id: string;
url: string;
}
interface CategoryNonNullableFields {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
slug: string;
seoData?: SeoSchemaNonNullableFields;
coverImage: string;
translations: CategoryTranslationNonNullableFields[];
}
export interface GetCategoryResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
export interface GetCategoryBySlugResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface MetaDataNonNullableFields {
count: number;
offset: number;
total: number;
}
export interface ListCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
metaData?: MetaDataNonNullableFields;
}
export interface QueryCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
}

@@ -883,3 +643,3 @@ export interface BaseEventMetadata {

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -915,2 +675,3 @@ /**

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @webhook

@@ -932,2 +693,3 @@ * @eventType wix.blog.v3.category_created

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @webhook

@@ -948,2 +710,3 @@ * @eventType wix.blog.v3.category_updated

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @webhook

@@ -974,12 +737,2 @@ * @eventType wix.blog.v3.category_deleted

export interface GetCategoryOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1013,16 +766,6 @@ fieldsets?: Field[];

export interface GetCategoryBySlugOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */
fieldsets?: Field[];
/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -1052,13 +795,2 @@ */

paging?: BlogPaging;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1069,3 +801,3 @@ fieldsets?: Field[];

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -1099,2 +831,3 @@ * If omitted, categories in all languages are returned.

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @applicableIdentity APP

@@ -1105,42 +838,2 @@ * @applicableIdentity VISITOR

export interface QueryCategoriesOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[] | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[] | undefined;
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1147,0 +840,0 @@ fieldsets?: Field[] | undefined;

@@ -33,3 +33,2 @@ "use strict";

const image_1 = require("@wix/sdk-runtime/transformations/image");
const video_1 = require("@wix/sdk-runtime/transformations/video");
const page_url_1 = require("@wix/sdk-runtime/transformations/page-url");

@@ -89,3 +88,2 @@ const transform_paths_1 = require("@wix/sdk-runtime/transformations/transform-paths");

categoryId: categoryId,
fieldsToInclude: options?.fieldsToInclude,
fieldsets: options?.fieldsets,

@@ -108,11 +106,4 @@ });

transformFn: image_1.transformRESTImageToSDKImage,
paths: [
{ path: 'category.coverImage' },
{ path: 'category.coverMedia.image' },
],
paths: [{ path: 'category.coverImage' }],
},
{
transformFn: video_1.transformRESTVideoToSDKVideo,
paths: [{ path: 'category.coverMedia.video' }],
},
]));

@@ -125,3 +116,2 @@ }

categoryId: '$[0]',
fieldsToInclude: '$[1].fieldsToInclude',
fieldsets: '$[1].fieldsets',

@@ -164,3 +154,2 @@ },

slug: slug,
fieldsToInclude: options?.fieldsToInclude,
fieldsets: options?.fieldsets,

@@ -184,11 +173,4 @@ language: options?.language,

transformFn: image_1.transformRESTImageToSDKImage,
paths: [
{ path: 'category.coverImage' },
{ path: 'category.coverMedia.image' },
],
paths: [{ path: 'category.coverImage' }],
},
{
transformFn: video_1.transformRESTVideoToSDKVideo,
paths: [{ path: 'category.coverMedia.video' }],
},
]));

@@ -201,3 +183,2 @@ }

slug: '$[0]',
fieldsToInclude: '$[1].fieldsToInclude',
fieldsets: '$[1].fieldsets',

@@ -234,3 +215,2 @@ language: '$[1].language',

paging: options?.paging,
fieldsToInclude: options?.fieldsToInclude,
fieldsets: options?.fieldsets,

@@ -254,11 +234,4 @@ language: options?.language,

transformFn: image_1.transformRESTImageToSDKImage,
paths: [
{ path: 'categories.coverImage' },
{ path: 'categories.coverMedia.image' },
],
paths: [{ path: 'categories.coverImage' }],
},
{
transformFn: video_1.transformRESTVideoToSDKVideo,
paths: [{ path: 'categories.coverMedia.video' }],
},
]));

@@ -271,3 +244,2 @@ }

paging: '$[0].paging',
fieldsToInclude: '$[0].fieldsToInclude',
fieldsets: '$[0].fieldsets',

@@ -306,2 +278,3 @@ language: '$[0].language',

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @applicableIdentity APP

@@ -348,11 +321,4 @@ * @applicableIdentity VISITOR

transformFn: image_1.transformRESTImageToSDKImage,
paths: [
{ path: 'categories.coverImage' },
{ path: 'categories.coverMedia.image' },
],
paths: [{ path: 'categories.coverImage' }],
},
{
transformFn: video_1.transformRESTVideoToSDKVideo,
paths: [{ path: 'categories.coverMedia.video' }],
},
]));

@@ -359,0 +325,0 @@ return {

@@ -1,1 +0,1 @@

export * from './src/blog-v3-category-categories.public';
export * from './src/blog-v3-category-categories.context';

@@ -1,2 +0,2 @@

export * from './src/blog-v3-category-categories.public';
export * from './src/blog-v3-category-categories.context';
//# sourceMappingURL=index.js.map
import { getCategory as publicGetCategory, getCategoryBySlug as publicGetCategoryBySlug, listCategories as publicListCategories, queryCategories as publicQueryCategories } from './blog-v3-category-categories.public';
import { BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
import { BuildRESTFunction } from '@wix/sdk-types';
import { onCategoryCreated as publicOnCategoryCreated } from './blog-v3-category-categories.public';
import { onCategoryUpdated as publicOnCategoryUpdated } from './blog-v3-category-categories.public';
import { onCategoryDeleted as publicOnCategoryDeleted } from './blog-v3-category-categories.public';
export declare const getCategory: BuildRESTFunction<typeof publicGetCategory>;
export declare const getCategoryBySlug: BuildRESTFunction<typeof publicGetCategoryBySlug>;
export declare const listCategories: BuildRESTFunction<typeof publicListCategories>;
export declare const queryCategories: BuildRESTFunction<typeof publicQueryCategories>;
export declare const onCategoryCreated: BuildEventDefinition<typeof publicOnCategoryCreated>;
export declare const onCategoryUpdated: BuildEventDefinition<typeof publicOnCategoryUpdated>;
export declare const onCategoryDeleted: BuildEventDefinition<typeof publicOnCategoryDeleted>;
export declare const getCategory: BuildRESTFunction<typeof publicGetCategory> & typeof publicGetCategory;
export declare const getCategoryBySlug: BuildRESTFunction<typeof publicGetCategoryBySlug> & typeof publicGetCategoryBySlug;
export declare const listCategories: BuildRESTFunction<typeof publicListCategories> & typeof publicListCategories;
export declare const queryCategories: BuildRESTFunction<typeof publicQueryCategories> & typeof publicQueryCategories;
export { publicOnCategoryCreated };
export type _publicOnCategoryCreatedType = typeof publicOnCategoryCreated;
/**
* Triggered when a category is created.
*/
export declare const onCategoryCreated: ReturnType<typeof createEventModule<_publicOnCategoryCreatedType>>;
export { publicOnCategoryUpdated };
export type _publicOnCategoryUpdatedType = typeof publicOnCategoryUpdated;
/**
* Triggered when a category is updated.
*/
export declare const onCategoryUpdated: ReturnType<typeof createEventModule<_publicOnCategoryUpdatedType>>;
export { publicOnCategoryDeleted };
export type _publicOnCategoryDeletedType = typeof publicOnCategoryDeleted;
/**
* Triggered when a category is deleted.
*/
export declare const onCategoryDeleted: ReturnType<typeof createEventModule<_publicOnCategoryDeletedType>>;
export { Field, SortOrder, WebhookIdentityType, } from './blog-v3-category-categories.universal';
export { Category, SeoSchema, Keyword, Tag, Settings, CategoryTranslation, InitialCategoriesCopied, CreateCategoryRequest, CreateCategoryResponse, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkCategoryResult, ItemMetadata, ApplicationError, BulkActionMetadata, BulkUpdateCategoriesRequest, MaskedCategory, BulkUpdateCategoriesResponse, UpdateCategoryRequest, UpdateCategoryResponse, GetCategoriesCountByLanguageRequest, GetCategoriesCountByLanguageResponse, CategoryLanguageCount, GetCategoryRequest, GetCategoryResponse, GetCategoryBySlugRequest, GetCategoryBySlugResponse, ListCategoriesRequest, BlogPaging, ListCategoriesResponse, MetaData, QueryCategoriesRequest, PlatformQuery, PlatformQueryPagingMethodOneOf, Sorting, Paging, CursorPaging, QueryCategoriesResponse, PagingMetadataV2, Cursors, BulkDeleteCategoryRequest, BulkDeleteCategoryResponse, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, GetCategoryResponseNonNullableFields, GetCategoryBySlugResponseNonNullableFields, ListCategoriesResponseNonNullableFields, QueryCategoriesResponseNonNullableFields, BaseEventMetadata, EventMetadata, CategoryCreatedEnvelope, CategoryUpdatedEnvelope, CategoryDeletedEnvelope, GetCategoryOptions, GetCategoryBySlugOptions, ListCategoriesOptions, QueryCategoriesOptions, CategoriesQueryResult, CategoriesQueryBuilder, } from './blog-v3-category-categories.universal';
import { getCategory as publicGetCategory, getCategoryBySlug as publicGetCategoryBySlug, listCategories as publicListCategories, queryCategories as publicQueryCategories, } from './blog-v3-category-categories.public';
import { contextualizeRESTModule, contextualizeEventDefinitionModule, } from '@wix/sdk-runtime/context';
import { createRESTModule } from '@wix/sdk-runtime/rest-modules';
import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
import { onCategoryCreated as publicOnCategoryCreated } from './blog-v3-category-categories.public';
import { onCategoryUpdated as publicOnCategoryUpdated } from './blog-v3-category-categories.public';
import { onCategoryDeleted as publicOnCategoryDeleted } from './blog-v3-category-categories.public';
export const getCategory = contextualizeRESTModule(publicGetCategory, 1);
export const getCategoryBySlug = contextualizeRESTModule(publicGetCategoryBySlug, 1);
export const listCategories = contextualizeRESTModule(publicListCategories, 1);
export const queryCategories = contextualizeRESTModule(publicQueryCategories, 1);
export const onCategoryCreated = contextualizeEventDefinitionModule(publicOnCategoryCreated);
export const onCategoryUpdated = contextualizeEventDefinitionModule(publicOnCategoryUpdated);
export const onCategoryDeleted = contextualizeEventDefinitionModule(publicOnCategoryDeleted);
export const getCategory = createRESTModule(publicGetCategory);
export const getCategoryBySlug = createRESTModule(publicGetCategoryBySlug);
export const listCategories = createRESTModule(publicListCategories);
export const queryCategories = createRESTModule(publicQueryCategories);
export { publicOnCategoryCreated };
/**
* Triggered when a category is created.
*/
export const onCategoryCreated = createEventModule(publicOnCategoryCreated);
export { publicOnCategoryUpdated };
/**
* Triggered when a category is updated.
*/
export const onCategoryUpdated = createEventModule(publicOnCategoryUpdated);
export { publicOnCategoryDeleted };
/**
* Triggered when a category is deleted.
*/
export const onCategoryDeleted = createEventModule(publicOnCategoryDeleted);
export { Field, SortOrder, WebhookIdentityType, } from './blog-v3-category-categories.universal';
//# sourceMappingURL=blog-v3-category-categories.context.js.map

@@ -39,2 +39,8 @@ import { toURLSearchParams } from '@wix/metro-runtime';

],
'wix-bo.com': [
{
srcPath: '/_api/communities-blog-node-api/v3/categories',
destPath: '/v3/categories',
},
],
'editor.wixapps.net': [

@@ -104,2 +110,8 @@ {

],
'api._api_base_domain_': [
{
srcPath: '/category-service-api-proxy',
destPath: '',
},
],
};

@@ -128,4 +140,2 @@ return resolveUrl(Object.assign(opts, { domainToMappings }));

{ path: 'category.updatedDate' },
{ path: 'category.coverMedia.image.urlExpirationDate' },
{ path: 'category.coverMedia.video.thumbnail.urlExpirationDate' },
{ path: 'category.coverImage.urlExpirationDate' },

@@ -162,4 +172,2 @@ ],

{ path: 'category.updatedDate' },
{ path: 'category.coverMedia.image.urlExpirationDate' },
{ path: 'category.coverMedia.video.thumbnail.urlExpirationDate' },
{ path: 'category.coverImage.urlExpirationDate' },

@@ -193,6 +201,2 @@ ],

{ path: 'categories.updatedDate' },
{ path: 'categories.coverMedia.image.urlExpirationDate' },
{
path: 'categories.coverMedia.video.thumbnail.urlExpirationDate',
},
{ path: 'categories.coverImage.urlExpirationDate' },

@@ -236,6 +240,2 @@ ],

{ path: 'categories.updatedDate' },
{ path: 'categories.coverMedia.image.urlExpirationDate' },
{
path: 'categories.coverMedia.video.thumbnail.urlExpirationDate',
},
{ path: 'categories.coverImage.urlExpirationDate' },

@@ -242,0 +242,0 @@ ],

import { EventDefinition, HttpClient } from '@wix/sdk-types';
import { CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryUpdatedEnvelope, GetCategoryBySlugOptions, GetCategoryOptions, ListCategoriesOptions, QueryCategoriesOptions } from './blog-v3-category-categories.universal';
import { CategoriesQueryBuilder, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryUpdatedEnvelope, GetCategoryBySlugOptions, GetCategoryBySlugResponse, GetCategoryBySlugResponseNonNullableFields, GetCategoryOptions, GetCategoryResponse, GetCategoryResponseNonNullableFields, ListCategoriesOptions, ListCategoriesResponse, ListCategoriesResponseNonNullableFields, QueryCategoriesOptions } from './blog-v3-category-categories.universal';
export declare const __metadata: {
PACKAGE_NAME: string;
};
export declare function getCategory(httpClient: HttpClient): (categoryId: string, options?: GetCategoryOptions) => Promise<import("./blog-v3-category-categories.universal").GetCategoryResponse & import("./blog-v3-category-categories.universal").GetCategoryResponseNonNullableFields>;
export declare function getCategoryBySlug(httpClient: HttpClient): (slug: string, options?: GetCategoryBySlugOptions) => Promise<import("./blog-v3-category-categories.universal").GetCategoryBySlugResponse & import("./blog-v3-category-categories.universal").GetCategoryBySlugResponseNonNullableFields>;
export declare function listCategories(httpClient: HttpClient): (options?: ListCategoriesOptions) => Promise<import("./blog-v3-category-categories.universal").ListCategoriesResponse & import("./blog-v3-category-categories.universal").ListCategoriesResponseNonNullableFields>;
export declare function queryCategories(httpClient: HttpClient): (options?: QueryCategoriesOptions) => import("./blog-v3-category-categories.universal").CategoriesQueryBuilder;
export declare function getCategory(httpClient: HttpClient): GetCategorySignature;
interface GetCategorySignature {
/**
* 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 - Category ID.
* @param - Options specifying which fields to return.
*/
(categoryId: string, options?: GetCategoryOptions | undefined): Promise<GetCategoryResponse & GetCategoryResponseNonNullableFields>;
}
export declare function getCategoryBySlug(httpClient: HttpClient): GetCategoryBySlugSignature;
interface GetCategoryBySlugSignature {
/**
* 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.
*
* @param - 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 specifying which fields to return.
*/
(slug: string, options?: GetCategoryBySlugOptions | undefined): Promise<GetCategoryBySlugResponse & GetCategoryBySlugResponseNonNullableFields>;
}
export declare function listCategories(httpClient: HttpClient): ListCategoriesSignature;
interface ListCategoriesSignature {
/**
* 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`.
* @param - Filter and paging options.
*/
(options?: ListCategoriesOptions | undefined): Promise<ListCategoriesResponse & ListCategoriesResponseNonNullableFields>;
}
export declare function queryCategories(httpClient: HttpClient): QueryCategoriesSignature;
interface QueryCategoriesSignature {
/**
* 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/categories/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/categories/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/categories/categoriesquerybuilder/limit)
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/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/categories/categoriesqueryresult/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).
* @param - Options specifying which fields to return.
*/
(options?: QueryCategoriesOptions | undefined): CategoriesQueryBuilder;
}
export declare const onCategoryCreated: EventDefinition<CategoryCreatedEnvelope, "wix.blog.v3.category_created">;
export declare const onCategoryUpdated: EventDefinition<CategoryUpdatedEnvelope, "wix.blog.v3.category_updated">;
export declare const onCategoryDeleted: EventDefinition<CategoryDeletedEnvelope, "wix.blog.v3.category_deleted">;
export { ActionEvent, ApplicationError, BaseEventMetadata, BlogPaging, BulkActionMetadata, BulkCategoryResult, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkDeleteCategoryRequest, BulkDeleteCategoryResponse, BulkUpdateCategoriesRequest, BulkUpdateCategoriesResponse, CategoriesQueryBuilder, CategoriesQueryResult, Category, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryLanguageCount, CategoryTranslation, CategoryUpdatedEnvelope, CoverMedia, CoverMediaMediaOneOf, CreateCategoryRequest, CreateCategoryResponse, CursorPaging, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Field, GetCategoriesCountByLanguageRequest, GetCategoriesCountByLanguageResponse, GetCategoryBySlugOptions, GetCategoryBySlugRequest, GetCategoryBySlugResponse, GetCategoryBySlugResponseNonNullableFields, GetCategoryOptions, GetCategoryRequest, GetCategoryResponse, GetCategoryResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, InitialCategoriesCopied, ItemMetadata, Keyword, ListCategoriesOptions, ListCategoriesRequest, ListCategoriesResponse, ListCategoriesResponseNonNullableFields, MaskedCategory, MessageEnvelope, MetaData, Paging, PagingMetadataV2, PlatformQuery, PlatformQueryPagingMethodOneOf, QueryCategoriesOptions, QueryCategoriesRequest, QueryCategoriesResponse, QueryCategoriesResponseNonNullableFields, SeoSchema, Settings, SortOrder, Sorting, Tag, UpdateCategoryRequest, UpdateCategoryResponse, WebhookIdentityType, } from './blog-v3-category-categories.universal';
export { ActionEvent, ApplicationError, BaseEventMetadata, BlogPaging, BulkActionMetadata, BulkCategoryResult, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkDeleteCategoryRequest, BulkDeleteCategoryResponse, BulkUpdateCategoriesRequest, BulkUpdateCategoriesResponse, CategoriesQueryBuilder, CategoriesQueryResult, Category, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryLanguageCount, CategoryTranslation, CategoryUpdatedEnvelope, CreateCategoryRequest, CreateCategoryResponse, CursorPaging, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Field, GetCategoriesCountByLanguageRequest, GetCategoriesCountByLanguageResponse, GetCategoryBySlugOptions, GetCategoryBySlugRequest, GetCategoryBySlugResponse, GetCategoryBySlugResponseNonNullableFields, GetCategoryOptions, GetCategoryRequest, GetCategoryResponse, GetCategoryResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, InitialCategoriesCopied, ItemMetadata, Keyword, ListCategoriesOptions, ListCategoriesRequest, ListCategoriesResponse, ListCategoriesResponseNonNullableFields, MaskedCategory, MessageEnvelope, MetaData, Paging, PagingMetadataV2, PlatformQuery, PlatformQueryPagingMethodOneOf, QueryCategoriesOptions, QueryCategoriesRequest, QueryCategoriesResponse, QueryCategoriesResponseNonNullableFields, RestoreInfo, SeoSchema, Settings, SortOrder, Sorting, Tag, UpdateCategoryRequest, UpdateCategoryResponse, WebhookIdentityType, } from './blog-v3-category-categories.universal';

@@ -6,3 +6,2 @@ import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';

import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
import { transformRESTVideoToSDKVideo } from '@wix/sdk-runtime/transformations/video';
import { EventDefinition } from '@wix/sdk-types';

@@ -38,6 +37,3 @@ import { getCategory as universalGetCategory, getCategoryBySlug as universalGetCategoryBySlug, listCategories as universalListCategories, queryCategories as universalQueryCategories, } from './blog-v3-category-categories.universal';

transformFn: transformRESTImageToSDKImage,
paths: [
{ path: 'entity.coverImage' },
{ path: 'entity.coverMedia.image' },
],
paths: [{ path: 'entity.coverImage' }],
},

@@ -51,6 +47,2 @@ {

},
{
transformFn: transformRESTVideoToSDKVideo,
paths: [{ path: 'entity.coverMedia.video' }],
},
])))();

@@ -64,6 +56,3 @@ export const onCategoryUpdated = EventDefinition('wix.blog.v3.category_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [

transformFn: transformRESTImageToSDKImage,
paths: [
{ path: 'entity.coverImage' },
{ path: 'entity.coverMedia.image' },
],
paths: [{ path: 'entity.coverImage' }],
},

@@ -77,6 +66,2 @@ {

},
{
transformFn: transformRESTVideoToSDKVideo,
paths: [{ path: 'entity.coverMedia.video' }],
},
])))();

@@ -93,6 +78,3 @@ export const onCategoryDeleted = EventDefinition('wix.blog.v3.category_deleted', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [

transformFn: transformRESTImageToSDKImage,
paths: [
{ path: 'undefined.coverImage' },
{ path: 'undefined.coverMedia.image' },
],
paths: [{ path: 'undefined.coverImage' }],
},

@@ -106,8 +88,4 @@ {

},
{
transformFn: transformRESTVideoToSDKVideo,
paths: [{ path: 'undefined.coverMedia.video' }],
},
])))();
export { Field, SortOrder, WebhookIdentityType, } from './blog-v3-category-categories.universal';
//# sourceMappingURL=blog-v3-category-categories.public.js.map
export interface Category {
/**
* Category ID.
* @readonly
*/
/** Category ID. */
id?: string;

@@ -24,27 +21,6 @@ /** Category label. Displayed in the Category Menu. */

/**
* __Deprecated.__ Use `coverImage` instead.
* This property will be removed on June 30, 2023.
*
* Category cover image or video.
* @deprecated
* @replacedBy cover_image
* @removalDate 2024-06-30
*/
coverMedia?: CoverMedia;
/**
* Reserved for internal use.
* @readonly
*/
oldRank?: number;
/**
* __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated Category position in sequence.
* @replacedBy display_position
* @removalDate 2024-06-30
* @targetRemovalDate 2024-06-30
*/

@@ -63,3 +39,3 @@ rank?: number | null;

*
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
*/

@@ -90,70 +66,2 @@ language?: string | null;

}
export interface CoverMedia extends CoverMediaMediaOneOf {
/** Image url. */
image?: Image;
/** Video url. */
video?: Video;
/**
* Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @deprecated Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @replacedBy displayed
* @removalDate 2024-06-30
*/
enabled?: boolean;
/** Whether cover media is displayed. */
displayed?: boolean;
/** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
custom?: boolean;
}
/** @oneof */
export interface CoverMediaMediaOneOf {
/** Image url. */
image?: Image;
/** Video url. */
video?: Video;
}
export interface Image {
/** WixMedia image ID. */
id?: string;
/** Image URL. */
url?: string;
/**
* Original image height.
* @readonly
*/
height?: number;
/**
* Original image width.
* @readonly
*/
width?: number;
/** Image alt text. */
altText?: string | null;
/**
* Image filename.
* @readonly
*/
filename?: string | null;
}
/** Deprecated - use VideoV2 */
export interface Video {
/** WixMedia ID */
id?: string;
/** URL of video */
url?: string;
/**
* Original image height
* @readonly
*/
height?: number;
/**
* Original image width
* @readonly
*/
width?: number;
/** Video poster */
thumbnail?: Image;
}
/**

@@ -175,2 +83,4 @@ * 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.

isMain?: boolean;
/** Who added the keyword to the settings */
origin?: string | null;
}

@@ -210,2 +120,25 @@ export interface Tag {

}
export interface Image {
/** WixMedia image ID. */
id?: string;
/** Image URL. */
url?: string;
/**
* Original image height.
* @readonly
*/
height?: number;
/**
* Original image width.
* @readonly
*/
width?: number;
/** Image alt text. */
altText?: string | null;
/**
* Image filename.
* @readonly
*/
filename?: string | null;
}
export interface CategoryTranslation {

@@ -346,3 +279,3 @@ /** Category ID */

export interface CategoryLanguageCount {
/** 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
/** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */
languageCode?: string | null;

@@ -356,15 +289,2 @@ /** The count of Categories for the language. */

/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -384,15 +304,2 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -404,3 +311,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -418,17 +325,2 @@ */

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -442,3 +334,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -484,54 +376,2 @@ * If omitted, categories in all languages are returned.

export interface QueryCategoriesRequest {
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[];
/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** Query options. */

@@ -546,12 +386,2 @@ query?: PlatformQuery;

}
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 {

@@ -584,2 +414,12 @@ /** Paging options to limit and skip the number of items. */

}
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 Paging {

@@ -606,15 +446,2 @@ /** Number of items to load. */

categories?: Category[];
/**
* __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @deprecated __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @replacedBy pagingMetadata
* @removalDate 2024-06-30
*/
metaData?: MetaData;
/** Details on the paged set of results returned. */

@@ -678,3 +505,3 @@ pagingMetadata?: PagingMetadataV2;

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -707,3 +534,8 @@ /**

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;
}
export interface EntityUpdatedEvent {

@@ -764,271 +596,63 @@ /**

}
interface PageUrlNonNullableFields {
base: string;
path: string;
}
interface TagNonNullableFields {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}
interface KeywordNonNullableFields {
term: string;
isMain: boolean;
}
interface SettingsNonNullableFields {
preventAutoRedirect: boolean;
keywords: KeywordNonNullableFields[];
}
interface SeoSchemaNonNullableFields {
tags: TagNonNullableFields[];
settings?: SettingsNonNullableFields;
}
interface ImageNonNullableFields {
id: string;
url: string;
height: number;
width: number;
}
interface CategoryTranslationNonNullableFields {
id: string;
url?: PageUrlNonNullableFields;
}
interface CategoryNonNullableFields {
id: string;
label: string;
postCount: number;
url?: PageUrlNonNullableFields;
title: string;
slug: string;
seoData?: SeoSchemaNonNullableFields;
coverImage?: ImageNonNullableFields;
translations: CategoryTranslationNonNullableFields[];
}
export interface GetCategoryResponseNonNullableFields {
category?: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
};
category?: CategoryNonNullableFields;
}
export interface GetCategoryBySlugResponseNonNullableFields {
category?: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
};
category?: CategoryNonNullableFields;
}
interface MetaDataNonNullableFields {
count: number;
offset: number;
total: number;
}
export interface ListCategoriesResponseNonNullableFields {
categories: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
metaData?: MetaDataNonNullableFields;
}
export interface QueryCategoriesResponseNonNullableFields {
categories: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
}
export {};
export interface Category {
/**
* Category ID.
* @readonly
*/
/** Category ID. */
_id?: string;

@@ -29,20 +26,5 @@ /** Category label. Displayed in the Category Menu. */

* Reserved for internal use.
* @deprecated
* @replacedBy cover_image
* @removalDate 2024-06-30
*/
coverMedia?: CoverMedia;
/**
* Reserved for internal use.
* @readonly
*/
oldRank?: number;
/**
* Reserved for internal use.
* @deprecated __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated Category position in sequence.
* @replacedBy display_position
* @removalDate 2024-06-30
* @targetRemovalDate 2024-06-30
*/

@@ -82,28 +64,2 @@ rank?: number | null;

}
export interface CoverMedia extends CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
/**
* Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @deprecated Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @replacedBy displayed
* @removalDate 2024-06-30
*/
enabled?: boolean;
/** Whether cover media is displayed. */
displayed?: boolean;
/** If `false`, the cover image is the first media item appearing in the content. */
custom?: boolean;
}
/** @oneof */
export interface CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
}
/**

@@ -125,2 +81,4 @@ * 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.

isMain?: boolean;
/** Who added the keyword to the settings */
origin?: string | null;
}

@@ -295,3 +253,3 @@ export interface Tag {

export interface CategoryLanguageCount {
/** 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
/** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */
languageCode?: string | null;

@@ -305,15 +263,2 @@ /** The count of Categories for the language. */

/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -333,15 +278,2 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -353,3 +285,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -367,17 +299,2 @@ */

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -391,3 +308,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -429,54 +346,2 @@ * If omitted, categories in all languages are returned.

export interface QueryCategoriesRequest {
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[];
/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** Query options. */

@@ -491,12 +356,2 @@ query?: PlatformQuery;

}
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 {

@@ -529,2 +384,12 @@ /** Paging options to limit and skip the number of items. */

}
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 Paging {

@@ -551,15 +416,2 @@ /** Number of items to load. */

categories?: Category[];
/**
* __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @deprecated __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @replacedBy pagingMetadata
* @removalDate 2024-06-30
*/
metaData?: MetaData;
/** Details on the paged set of results returned. */

@@ -623,3 +475,3 @@ pagingMetadata?: PagingMetadataV2;

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -653,2 +505,5 @@ /**

}
export interface RestoreInfo {
deletedDate?: Date;
}
export interface EntityUpdatedEvent {

@@ -709,147 +564,52 @@ /**

}
interface TagNonNullableFields {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}
interface KeywordNonNullableFields {
term: string;
isMain: boolean;
}
interface SettingsNonNullableFields {
preventAutoRedirect: boolean;
keywords: KeywordNonNullableFields[];
}
interface SeoSchemaNonNullableFields {
tags: TagNonNullableFields[];
settings?: SettingsNonNullableFields;
}
interface CategoryTranslationNonNullableFields {
_id: string;
url: string;
}
interface CategoryNonNullableFields {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
slug: string;
seoData?: SeoSchemaNonNullableFields;
coverImage: string;
translations: CategoryTranslationNonNullableFields[];
}
export interface GetCategoryResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
export interface GetCategoryBySlugResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface MetaDataNonNullableFields {
count: number;
offset: number;
total: number;
}
export interface ListCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
metaData?: MetaDataNonNullableFields;
}
export interface QueryCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
}

@@ -883,3 +643,3 @@ export interface BaseEventMetadata {

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -915,2 +675,3 @@ /**

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @webhook

@@ -932,2 +693,3 @@ * @eventType wix.blog.v3.category_created

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @webhook

@@ -948,2 +710,3 @@ * @eventType wix.blog.v3.category_updated

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @webhook

@@ -974,12 +737,2 @@ * @eventType wix.blog.v3.category_deleted

export interface GetCategoryOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1013,16 +766,6 @@ fieldsets?: Field[];

export interface GetCategoryBySlugOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */
fieldsets?: Field[];
/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -1052,13 +795,2 @@ */

paging?: BlogPaging;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1069,3 +801,3 @@ fieldsets?: Field[];

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -1099,2 +831,3 @@ * If omitted, categories in all languages are returned.

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @applicableIdentity APP

@@ -1105,42 +838,2 @@ * @applicableIdentity VISITOR

export interface QueryCategoriesOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[] | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[] | undefined;
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1147,0 +840,0 @@ fieldsets?: Field[] | undefined;

@@ -7,3 +7,2 @@ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';

import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
import { transformRESTVideoToSDKVideo } from '@wix/sdk-runtime/transformations/video';
import { transformRESTPageURLToSDKPageURL } from '@wix/sdk-runtime/transformations/page-url';

@@ -63,3 +62,2 @@ import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';

categoryId: categoryId,
fieldsToInclude: options?.fieldsToInclude,
fieldsets: options?.fieldsets,

@@ -82,11 +80,4 @@ });

transformFn: transformRESTImageToSDKImage,
paths: [
{ path: 'category.coverImage' },
{ path: 'category.coverMedia.image' },
],
paths: [{ path: 'category.coverImage' }],
},
{
transformFn: transformRESTVideoToSDKVideo,
paths: [{ path: 'category.coverMedia.video' }],
},
]));

@@ -99,3 +90,2 @@ }

categoryId: '$[0]',
fieldsToInclude: '$[1].fieldsToInclude',
fieldsets: '$[1].fieldsets',

@@ -137,3 +127,2 @@ },

slug: slug,
fieldsToInclude: options?.fieldsToInclude,
fieldsets: options?.fieldsets,

@@ -157,11 +146,4 @@ language: options?.language,

transformFn: transformRESTImageToSDKImage,
paths: [
{ path: 'category.coverImage' },
{ path: 'category.coverMedia.image' },
],
paths: [{ path: 'category.coverImage' }],
},
{
transformFn: transformRESTVideoToSDKVideo,
paths: [{ path: 'category.coverMedia.video' }],
},
]));

@@ -174,3 +156,2 @@ }

slug: '$[0]',
fieldsToInclude: '$[1].fieldsToInclude',
fieldsets: '$[1].fieldsets',

@@ -206,3 +187,2 @@ language: '$[1].language',

paging: options?.paging,
fieldsToInclude: options?.fieldsToInclude,
fieldsets: options?.fieldsets,

@@ -226,11 +206,4 @@ language: options?.language,

transformFn: transformRESTImageToSDKImage,
paths: [
{ path: 'categories.coverImage' },
{ path: 'categories.coverMedia.image' },
],
paths: [{ path: 'categories.coverImage' }],
},
{
transformFn: transformRESTVideoToSDKVideo,
paths: [{ path: 'categories.coverMedia.video' }],
},
]));

@@ -243,3 +216,2 @@ }

paging: '$[0].paging',
fieldsToInclude: '$[0].fieldsToInclude',
fieldsets: '$[0].fieldsets',

@@ -277,2 +249,3 @@ language: '$[0].language',

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @applicableIdentity APP

@@ -319,11 +292,4 @@ * @applicableIdentity VISITOR

transformFn: transformRESTImageToSDKImage,
paths: [
{ path: 'categories.coverImage' },
{ path: 'categories.coverMedia.image' },
],
paths: [{ path: 'categories.coverImage' }],
},
{
transformFn: transformRESTVideoToSDKVideo,
paths: [{ path: 'categories.coverMedia.video' }],
},
]));

@@ -330,0 +296,0 @@ return {

{
"name": "@wix/blog_categories",
"version": "1.0.36",
"version": "1.0.37",
"publishConfig": {

@@ -23,4 +23,4 @@ "registry": "https://registry.npmjs.org/",

"@wix/motion-edm-autogen-query-wrapper": "^1.0.37",
"@wix/sdk-runtime": "^0.3.2",
"@wix/sdk-types": "^1.9.0"
"@wix/sdk-runtime": "^0.3.14",
"@wix/sdk-types": "^1.9.2"
},

@@ -34,4 +34,5 @@ "devDependencies": {

"scripts": {
"build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
"build:dts-bundles": "test -f config/rollup-config.js && rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
"build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles && npm run build:validate-dts",
"build:dts-bundles": "test -f config/rollup-config.js && NODE_OPTIONS=--max-old-space-size=8192 rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
"build:validate-dts": "tsc type-bundles/*.d.ts --noEmit",
"test": ":"

@@ -49,3 +50,3 @@ },

},
"falconPackageHash": "c632dd79c9cfee5bcddb235158a7cedd321057d9b410afb55f8390b0"
"falconPackageHash": "eb579e187b939d2fc117d07625472fd6d11b6fa70714d91ebde52058"
}

@@ -0,6 +1,47 @@

type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
interface HttpClient {
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
fetchWithAuth: typeof fetch;
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
}
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
type HttpResponse<T = any> = {
data: T;
status: number;
statusText: string;
headers: any;
request?: any;
};
type RequestOptions<_TResponse = any, Data = any> = {
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
url: string;
data?: Data;
params?: URLSearchParams;
} & APIMetadata;
type APIMetadata = {
methodFqn?: string;
entityFqdn?: string;
packageName?: string;
};
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
type EventDefinition<Payload = unknown, Type extends string = string> = {
__type: 'event-definition';
type: Type;
isDomainEvent?: boolean;
transformations?: (envelope: unknown) => Payload;
__payload: Payload;
};
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
declare global {
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
interface SymbolConstructor {
readonly observable: symbol;
}
}
interface Category {
/**
* Category ID.
* @readonly
*/
/** Category ID. */
_id?: string;

@@ -29,20 +70,5 @@ /** Category label. Displayed in the Category Menu. */

* Reserved for internal use.
* @deprecated
* @replacedBy cover_image
* @removalDate 2024-06-30
*/
coverMedia?: CoverMedia;
/**
* Reserved for internal use.
* @readonly
*/
oldRank?: number;
/**
* Reserved for internal use.
* @deprecated __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated Category position in sequence.
* @replacedBy display_position
* @removalDate 2024-06-30
* @targetRemovalDate 2024-06-30
*/

@@ -82,28 +108,2 @@ rank?: number | null;

}
interface CoverMedia extends CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
/**
* Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @deprecated Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @replacedBy displayed
* @removalDate 2024-06-30
*/
enabled?: boolean;
/** Whether cover media is displayed. */
displayed?: boolean;
/** If `false`, the cover image is the first media item appearing in the content. */
custom?: boolean;
}
/** @oneof */
interface CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
}
/**

@@ -125,2 +125,4 @@ * 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.

isMain?: boolean;
/** Who added the keyword to the settings */
origin?: string | null;
}

@@ -160,2 +162,26 @@ interface Tag {

}
interface CategoryTranslation {
/** Category ID */
_id?: string;
/** Label which is presented in the categories menu on site */
label?: string | null;
/** Language of the category */
language?: string | null;
/** Url of this category page */
url?: string;
}
interface InitialCategoriesCopied {
/** Number of categories copied. */
count?: number;
}
interface CreateCategoryRequest {
/** Category info. */
category?: Category;
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the category’s base fields are returned.
*/
fieldsets?: Field[];
}
declare enum Field {

@@ -175,2 +201,114 @@ UNKNOWN = "UNKNOWN",

}
interface CreateCategoryResponse {
/** Category info. */
category?: Category;
}
interface BulkCreateCategoriesRequest {
/** Categories to create. */
categories?: Category[];
/** Whether to return the full created category entities in the response. */
returnFullEntity?: boolean;
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the category’s base fields are returned.
*/
fieldsets?: Field[];
}
interface BulkCreateCategoriesResponse {
/** Categories created by bulk action. */
results?: BulkCategoryResult[];
/** Bulk action metadata. */
bulkActionMetadata?: BulkActionMetadata;
}
interface BulkCategoryResult {
/** Bulk actions metadata for category. */
itemMetadata?: ItemMetadata;
/** Optional created category. */
item?: Category;
}
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;
}
interface ApplicationError {
/** Error code. */
code?: string;
/** Description of the error. */
description?: string;
/** Data related to the error. */
data?: Record<string, any> | null;
}
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;
}
interface BulkUpdateCategoriesRequest {
/** Categories to update. */
categories?: MaskedCategory[];
/** Whether to return the full created category entities in the response. */
returnFullEntity?: boolean;
/**
* List of category fields to be included in the response if the entities are present.
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
*/
fieldsets?: Field[];
}
interface MaskedCategory {
/** Category */
category?: Category;
}
interface BulkUpdateCategoriesResponse {
/** Categories updated by bulk action. */
results?: BulkCategoryResult[];
/** Bulk action metadata. */
bulkActionMetadata?: BulkActionMetadata;
}
interface UpdateCategoryRequest {
/** Category info. */
category?: Category;
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the category’s base fields are returned.
*/
fieldsets?: Field[];
}
interface UpdateCategoryResponse {
/** Category info. */
category?: Category;
}
interface GetCategoriesCountByLanguageRequest {
}
interface GetCategoriesCountByLanguageResponse {
/** The language and it's count. */
categoriesLanguageCount?: CategoryLanguageCount[];
}
interface CategoryLanguageCount {
/** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */
languageCode?: string | null;
/** The count of Categories for the language. */
categoryCount?: number | null;
}
interface GetCategoryRequest {
/** Category ID. */
categoryId: string;
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the category’s base fields are returned.
*/
fieldsets?: Field[];
}
interface GetCategoryResponse {

@@ -180,2 +318,17 @@ /** Category info. */

}
interface GetCategoryBySlugRequest {
/** Slug of the category to retrieve. */
slug: string;
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the category’s base fields are returned.
*/
fieldsets?: Field[];
/**
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.
*/
language?: string | null;
}
interface GetCategoryBySlugResponse {

@@ -185,2 +338,20 @@ /** Category info. */

}
interface ListCategoriesRequest {
/** Pagination options. */
paging?: BlogPaging;
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the category’s base fields are returned.
*/
fieldsets?: Field[];
/**
* Language filter.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.
* If omitted, categories in all languages are returned.
*/
language?: string | null;
}
interface BlogPaging {

@@ -216,2 +387,39 @@ /** Number of categories to skip in the list. */

}
interface QueryCategoriesRequest {
/** Query options. */
query?: PlatformQuery;
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the category’s base fields are returned.
*/
fieldsets?: Field[];
}
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`. */
cursorPaging?: CursorPaging;
/**
* 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[];
}
/** @oneof */
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 {

@@ -227,2 +435,138 @@ /** Name of the field to sort by. */

}
interface Paging {
/** Number of items to load. */
limit?: number | null;
/** Number of items to skip in the current sort order. */
offset?: number | null;
}
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;
}
interface QueryCategoriesResponse {
/** List of categories. */
categories?: Category[];
/** Details on the paged set of results returned. */
pagingMetadata?: PagingMetadataV2;
}
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;
}
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;
}
interface BulkDeleteCategoryRequest {
/** Category IDs. */
categoryIds?: string[];
/** Should delete bypassing the trash-bin. */
permanent?: boolean;
}
interface BulkDeleteCategoryResponse {
}
interface DeleteCategoryRequest {
/** Category ID. */
categoryId?: string;
}
interface DeleteCategoryResponse {
}
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;
/**
* 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 */
interface DomainEventBodyOneOf {
createdEvent?: EntityCreatedEvent;
updatedEvent?: EntityUpdatedEvent;
deletedEvent?: EntityDeletedEvent;
actionEvent?: ActionEvent;
}
interface EntityCreatedEvent {
entity?: string;
}
interface RestoreInfo {
deletedDate?: Date;
}
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.
*/
currentEntity?: string;
}
interface EntityDeletedEvent {
/** Entity that was deleted */
deletedEntity?: string | null;
}
interface ActionEvent {
body?: string;
}
interface MessageEnvelope {
/** App instance ID. */
instanceId?: string | null;
/** Event type. */
eventType?: string;
/** The identification type and identity data. */
identity?: IdentificationData;
/** Stringify payload. */
data?: string;
}
interface IdentificationData extends IdentificationDataIdOneOf {

@@ -258,109 +602,53 @@ /** ID of a site visitor that has not logged in to the site. */

}
interface TagNonNullableFields {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}
interface KeywordNonNullableFields {
term: string;
isMain: boolean;
}
interface SettingsNonNullableFields {
preventAutoRedirect: boolean;
keywords: KeywordNonNullableFields[];
}
interface SeoSchemaNonNullableFields {
tags: TagNonNullableFields[];
settings?: SettingsNonNullableFields;
}
interface CategoryTranslationNonNullableFields {
_id: string;
url: string;
}
interface CategoryNonNullableFields {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
slug: string;
seoData?: SeoSchemaNonNullableFields;
coverImage: string;
translations: CategoryTranslationNonNullableFields[];
}
interface GetCategoryResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface GetCategoryBySlugResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface MetaDataNonNullableFields {
count: number;
offset: number;
total: number;
}
interface ListCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
metaData?: MetaDataNonNullableFields;
}
interface QueryCategoriesResponseNonNullableFields {
categories: CategoryNonNullableFields[];
}
interface BaseEventMetadata {

@@ -393,3 +681,3 @@ /** App instance ID. */

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -425,12 +713,2 @@ /**

interface GetCategoryOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -440,16 +718,6 @@ fieldsets?: Field[];

interface GetCategoryBySlugOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */
fieldsets?: Field[];
/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -462,13 +730,2 @@ */

paging?: BlogPaging;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -479,3 +736,3 @@ fieldsets?: Field[];

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -487,42 +744,2 @@ * If omitted, categories in all languages are returned.

interface QueryCategoriesOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[] | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[] | undefined;
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -592,49 +809,64 @@ fieldsets?: Field[] | undefined;

type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
interface HttpClient {
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
declare function getCategory$1(httpClient: HttpClient): GetCategorySignature;
interface GetCategorySignature {
/**
* 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 - Category ID.
* @param - Options specifying which fields to return.
*/
(categoryId: string, options?: GetCategoryOptions | undefined): Promise<GetCategoryResponse & GetCategoryResponseNonNullableFields>;
}
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
type HttpResponse<T = any> = {
data: T;
status: number;
statusText: string;
headers: any;
request?: any;
};
type RequestOptions<_TResponse = any, Data = any> = {
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
url: string;
data?: Data;
params?: URLSearchParams;
} & APIMetadata;
type APIMetadata = {
methodFqn?: string;
entityFqdn?: string;
packageName?: string;
};
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
type EventDefinition<Payload = unknown, Type extends string = string> = {
__type: 'event-definition';
type: Type;
isDomainEvent?: boolean;
transformations?: (envelope: unknown) => Payload;
__payload: Payload;
};
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
declare global {
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
interface SymbolConstructor {
readonly observable: symbol;
}
declare function getCategoryBySlug$1(httpClient: HttpClient): GetCategoryBySlugSignature;
interface GetCategoryBySlugSignature {
/**
* 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.
*
* @param - 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 specifying which fields to return.
*/
(slug: string, options?: GetCategoryBySlugOptions | undefined): Promise<GetCategoryBySlugResponse & GetCategoryBySlugResponseNonNullableFields>;
}
declare function getCategory$1(httpClient: HttpClient): (categoryId: string, options?: GetCategoryOptions) => Promise<GetCategoryResponse & GetCategoryResponseNonNullableFields>;
declare function getCategoryBySlug$1(httpClient: HttpClient): (slug: string, options?: GetCategoryBySlugOptions) => Promise<GetCategoryBySlugResponse & GetCategoryBySlugResponseNonNullableFields>;
declare function listCategories$1(httpClient: HttpClient): (options?: ListCategoriesOptions) => Promise<ListCategoriesResponse & ListCategoriesResponseNonNullableFields>;
declare function queryCategories$1(httpClient: HttpClient): (options?: QueryCategoriesOptions) => CategoriesQueryBuilder;
declare function listCategories$1(httpClient: HttpClient): ListCategoriesSignature;
interface ListCategoriesSignature {
/**
* 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`.
* @param - Filter and paging options.
*/
(options?: ListCategoriesOptions | undefined): Promise<ListCategoriesResponse & ListCategoriesResponseNonNullableFields>;
}
declare function queryCategories$1(httpClient: HttpClient): QueryCategoriesSignature;
interface QueryCategoriesSignature {
/**
* 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/categories/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/categories/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/categories/categoriesquerybuilder/limit)
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/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/categories/categoriesqueryresult/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).
* @param - Options specifying which fields to return.
*/
(options?: QueryCategoriesOptions | undefined): CategoriesQueryBuilder;
}
declare const onCategoryCreated$1: EventDefinition<CategoryCreatedEnvelope, "wix.blog.v3.category_created">;

@@ -644,10 +876,27 @@ declare const onCategoryUpdated$1: EventDefinition<CategoryUpdatedEnvelope, "wix.blog.v3.category_updated">;

declare const getCategory: BuildRESTFunction<typeof getCategory$1>;
declare const getCategoryBySlug: BuildRESTFunction<typeof getCategoryBySlug$1>;
declare const listCategories: BuildRESTFunction<typeof listCategories$1>;
declare const queryCategories: BuildRESTFunction<typeof queryCategories$1>;
declare const onCategoryCreated: BuildEventDefinition<typeof onCategoryCreated$1>;
declare const onCategoryUpdated: BuildEventDefinition<typeof onCategoryUpdated$1>;
declare const onCategoryDeleted: BuildEventDefinition<typeof onCategoryDeleted$1>;
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
export { getCategory, getCategoryBySlug, listCategories, onCategoryCreated, onCategoryDeleted, onCategoryUpdated, queryCategories };
declare const getCategory: BuildRESTFunction<typeof getCategory$1> & typeof getCategory$1;
declare const getCategoryBySlug: BuildRESTFunction<typeof getCategoryBySlug$1> & typeof getCategoryBySlug$1;
declare const listCategories: BuildRESTFunction<typeof listCategories$1> & typeof listCategories$1;
declare const queryCategories: BuildRESTFunction<typeof queryCategories$1> & typeof queryCategories$1;
type _publicOnCategoryCreatedType = typeof onCategoryCreated$1;
/**
* Triggered when a category is created.
*/
declare const onCategoryCreated: ReturnType<typeof createEventModule<_publicOnCategoryCreatedType>>;
type _publicOnCategoryUpdatedType = typeof onCategoryUpdated$1;
/**
* Triggered when a category is updated.
*/
declare const onCategoryUpdated: ReturnType<typeof createEventModule<_publicOnCategoryUpdatedType>>;
type _publicOnCategoryDeletedType = typeof onCategoryDeleted$1;
/**
* Triggered when a category is deleted.
*/
declare const onCategoryDeleted: ReturnType<typeof createEventModule<_publicOnCategoryDeletedType>>;
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 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 GetCategoriesCountByLanguageRequest, type GetCategoriesCountByLanguageResponse, type GetCategoryBySlugOptions, type GetCategoryBySlugRequest, type GetCategoryBySlugResponse, type GetCategoryBySlugResponseNonNullableFields, type GetCategoryOptions, type GetCategoryRequest, type GetCategoryResponse, type GetCategoryResponseNonNullableFields, type IdentificationData, type IdentificationDataIdOneOf, type InitialCategoriesCopied, type ItemMetadata, type Keyword, type ListCategoriesOptions, type ListCategoriesRequest, type ListCategoriesResponse, type ListCategoriesResponseNonNullableFields, type MaskedCategory, type MessageEnvelope, type MetaData, type Paging, type PagingMetadataV2, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type QueryCategoriesOptions, type QueryCategoriesRequest, type QueryCategoriesResponse, type QueryCategoriesResponseNonNullableFields, type RestoreInfo, type SeoSchema, type Settings, SortOrder, type Sorting, type Tag, type UpdateCategoryRequest, type UpdateCategoryResponse, WebhookIdentityType, type _publicOnCategoryCreatedType, type _publicOnCategoryDeletedType, type _publicOnCategoryUpdatedType, getCategory, getCategoryBySlug, listCategories, onCategoryCreated, onCategoryDeleted, onCategoryUpdated, onCategoryCreated$1 as publicOnCategoryCreated, onCategoryDeleted$1 as publicOnCategoryDeleted, onCategoryUpdated$1 as publicOnCategoryUpdated, queryCategories };

@@ -0,6 +1,47 @@

type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
interface HttpClient {
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
fetchWithAuth: typeof fetch;
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
}
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
type HttpResponse<T = any> = {
data: T;
status: number;
statusText: string;
headers: any;
request?: any;
};
type RequestOptions<_TResponse = any, Data = any> = {
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
url: string;
data?: Data;
params?: URLSearchParams;
} & APIMetadata;
type APIMetadata = {
methodFqn?: string;
entityFqdn?: string;
packageName?: string;
};
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
type EventDefinition<Payload = unknown, Type extends string = string> = {
__type: 'event-definition';
type: Type;
isDomainEvent?: boolean;
transformations?: (envelope: unknown) => Payload;
__payload: Payload;
};
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
declare global {
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
interface SymbolConstructor {
readonly observable: symbol;
}
}
interface Category {
/**
* Category ID.
* @readonly
*/
/** Category ID. */
_id?: string;

@@ -29,20 +70,5 @@ /** Category label. Displayed in the Category Menu. */

* Reserved for internal use.
* @deprecated
* @replacedBy cover_image
* @removalDate 2024-06-30
*/
coverMedia?: CoverMedia;
/**
* Reserved for internal use.
* @readonly
*/
oldRank?: number;
/**
* Reserved for internal use.
* @deprecated __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated Category position in sequence.
* @replacedBy display_position
* @removalDate 2024-06-30
* @targetRemovalDate 2024-06-30
*/

@@ -82,28 +108,2 @@ rank?: number | null;

}
interface CoverMedia extends CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
/**
* Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @deprecated Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @replacedBy displayed
* @removalDate 2024-06-30
*/
enabled?: boolean;
/** Whether cover media is displayed. */
displayed?: boolean;
/** If `false`, the cover image is the first media item appearing in the content. */
custom?: boolean;
}
/** @oneof */
interface CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
}
/**

@@ -125,2 +125,4 @@ * 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.

isMain?: boolean;
/** Who added the keyword to the settings */
origin?: string | null;
}

@@ -295,3 +297,3 @@ interface Tag {

interface CategoryLanguageCount {
/** 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
/** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */
languageCode?: string | null;

@@ -305,15 +307,2 @@ /** The count of Categories for the language. */

/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -333,15 +322,2 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -353,3 +329,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -367,17 +343,2 @@ */

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -391,3 +352,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -429,54 +390,2 @@ * If omitted, categories in all languages are returned.

interface QueryCategoriesRequest {
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[];
/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** Query options. */

@@ -491,12 +400,2 @@ query?: PlatformQuery;

}
interface Sorting {
/** Name of the field to sort by. */
fieldName?: string;
/** Sort order. */
order?: SortOrder;
}
declare enum SortOrder {
ASC = "ASC",
DESC = "DESC"
}
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {

@@ -529,2 +428,12 @@ /** Paging options to limit and skip the number of items. */

}
interface Sorting {
/** Name of the field to sort by. */
fieldName?: string;
/** Sort order. */
order?: SortOrder;
}
declare enum SortOrder {
ASC = "ASC",
DESC = "DESC"
}
interface Paging {

@@ -551,15 +460,2 @@ /** Number of items to load. */

categories?: Category[];
/**
* __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @deprecated __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @replacedBy pagingMetadata
* @removalDate 2024-06-30
*/
metaData?: MetaData;
/** Details on the paged set of results returned. */

@@ -623,3 +519,3 @@ pagingMetadata?: PagingMetadataV2;

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -653,2 +549,5 @@ /**

}
interface RestoreInfo {
deletedDate?: Date;
}
interface EntityUpdatedEvent {

@@ -709,147 +608,52 @@ /**

}
interface TagNonNullableFields {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}
interface KeywordNonNullableFields {
term: string;
isMain: boolean;
}
interface SettingsNonNullableFields {
preventAutoRedirect: boolean;
keywords: KeywordNonNullableFields[];
}
interface SeoSchemaNonNullableFields {
tags: TagNonNullableFields[];
settings?: SettingsNonNullableFields;
}
interface CategoryTranslationNonNullableFields {
_id: string;
url: string;
}
interface CategoryNonNullableFields {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
slug: string;
seoData?: SeoSchemaNonNullableFields;
coverImage: string;
translations: CategoryTranslationNonNullableFields[];
}
interface GetCategoryResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface GetCategoryBySlugResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface MetaDataNonNullableFields {
count: number;
offset: number;
total: number;
}
interface ListCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
metaData?: MetaDataNonNullableFields;
}
interface QueryCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
}

@@ -883,3 +687,3 @@ interface BaseEventMetadata {

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -915,12 +719,2 @@ /**

interface GetCategoryOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -930,16 +724,6 @@ fieldsets?: Field[];

interface GetCategoryBySlugOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */
fieldsets?: Field[];
/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -952,13 +736,2 @@ */

paging?: BlogPaging;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -969,3 +742,3 @@ fieldsets?: Field[];

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -977,42 +750,2 @@ * If omitted, categories in all languages are returned.

interface QueryCategoriesOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[] | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[] | undefined;
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1082,52 +815,93 @@ fieldsets?: Field[] | undefined;

interface HttpClient {
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
declare function getCategory$1(httpClient: HttpClient): GetCategorySignature;
interface GetCategorySignature {
/**
* 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 - Category ID.
* @param - Options specifying which fields to return.
*/
(categoryId: string, options?: GetCategoryOptions | undefined): Promise<GetCategoryResponse & GetCategoryResponseNonNullableFields>;
}
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
type HttpResponse<T = any> = {
data: T;
status: number;
statusText: string;
headers: any;
request?: any;
};
type RequestOptions<_TResponse = any, Data = any> = {
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
url: string;
data?: Data;
params?: URLSearchParams;
} & APIMetadata;
type APIMetadata = {
methodFqn?: string;
entityFqdn?: string;
packageName?: string;
};
type EventDefinition<Payload = unknown, Type extends string = string> = {
__type: 'event-definition';
type: Type;
isDomainEvent?: boolean;
transformations?: (envelope: unknown) => Payload;
__payload: Payload;
};
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
declare global {
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
interface SymbolConstructor {
readonly observable: symbol;
}
declare function getCategoryBySlug$1(httpClient: HttpClient): GetCategoryBySlugSignature;
interface GetCategoryBySlugSignature {
/**
* 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.
*
* @param - 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 specifying which fields to return.
*/
(slug: string, options?: GetCategoryBySlugOptions | undefined): Promise<GetCategoryBySlugResponse & GetCategoryBySlugResponseNonNullableFields>;
}
declare function listCategories$1(httpClient: HttpClient): ListCategoriesSignature;
interface ListCategoriesSignature {
/**
* 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`.
* @param - Filter and paging options.
*/
(options?: ListCategoriesOptions | undefined): Promise<ListCategoriesResponse & ListCategoriesResponseNonNullableFields>;
}
declare function queryCategories$1(httpClient: HttpClient): QueryCategoriesSignature;
interface QueryCategoriesSignature {
/**
* 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/categories/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/categories/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/categories/categoriesquerybuilder/limit)
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/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/categories/categoriesqueryresult/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).
* @param - Options specifying which fields to return.
*/
(options?: QueryCategoriesOptions | undefined): CategoriesQueryBuilder;
}
declare const onCategoryCreated$1: EventDefinition<CategoryCreatedEnvelope, "wix.blog.v3.category_created">;
declare const onCategoryUpdated$1: EventDefinition<CategoryUpdatedEnvelope, "wix.blog.v3.category_updated">;
declare const onCategoryDeleted$1: EventDefinition<CategoryDeletedEnvelope, "wix.blog.v3.category_deleted">;
declare const __metadata: {
PACKAGE_NAME: string;
};
declare function getCategory(httpClient: HttpClient): (categoryId: string, options?: GetCategoryOptions) => Promise<GetCategoryResponse & GetCategoryResponseNonNullableFields>;
declare function getCategoryBySlug(httpClient: HttpClient): (slug: string, options?: GetCategoryBySlugOptions) => Promise<GetCategoryBySlugResponse & GetCategoryBySlugResponseNonNullableFields>;
declare function listCategories(httpClient: HttpClient): (options?: ListCategoriesOptions) => Promise<ListCategoriesResponse & ListCategoriesResponseNonNullableFields>;
declare function queryCategories(httpClient: HttpClient): (options?: QueryCategoriesOptions) => CategoriesQueryBuilder;
declare const onCategoryCreated: EventDefinition<CategoryCreatedEnvelope, "wix.blog.v3.category_created">;
declare const onCategoryUpdated: EventDefinition<CategoryUpdatedEnvelope, "wix.blog.v3.category_updated">;
declare const onCategoryDeleted: EventDefinition<CategoryDeletedEnvelope, "wix.blog.v3.category_deleted">;
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
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 CoverMedia, type CoverMediaMediaOneOf, 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 GetCategoriesCountByLanguageRequest, type GetCategoriesCountByLanguageResponse, type GetCategoryBySlugOptions, type GetCategoryBySlugRequest, type GetCategoryBySlugResponse, type GetCategoryBySlugResponseNonNullableFields, type GetCategoryOptions, type GetCategoryRequest, type GetCategoryResponse, type GetCategoryResponseNonNullableFields, type IdentificationData, type IdentificationDataIdOneOf, type InitialCategoriesCopied, type ItemMetadata, type Keyword, type ListCategoriesOptions, type ListCategoriesRequest, type ListCategoriesResponse, type ListCategoriesResponseNonNullableFields, type MaskedCategory, type MessageEnvelope, type MetaData, type Paging, type PagingMetadataV2, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type QueryCategoriesOptions, type QueryCategoriesRequest, type QueryCategoriesResponse, type QueryCategoriesResponseNonNullableFields, type SeoSchema, type Settings, SortOrder, type Sorting, type Tag, type UpdateCategoryRequest, type UpdateCategoryResponse, WebhookIdentityType, __metadata, getCategory, getCategoryBySlug, listCategories, onCategoryCreated, onCategoryDeleted, onCategoryUpdated, queryCategories };
declare const getCategory: BuildRESTFunction<typeof getCategory$1> & typeof getCategory$1;
declare const getCategoryBySlug: BuildRESTFunction<typeof getCategoryBySlug$1> & typeof getCategoryBySlug$1;
declare const listCategories: BuildRESTFunction<typeof listCategories$1> & typeof listCategories$1;
declare const queryCategories: BuildRESTFunction<typeof queryCategories$1> & typeof queryCategories$1;
type _publicOnCategoryCreatedType = typeof onCategoryCreated$1;
/**
* Triggered when a category is created.
*/
declare const onCategoryCreated: ReturnType<typeof createEventModule<_publicOnCategoryCreatedType>>;
type _publicOnCategoryUpdatedType = typeof onCategoryUpdated$1;
/**
* Triggered when a category is updated.
*/
declare const onCategoryUpdated: ReturnType<typeof createEventModule<_publicOnCategoryUpdatedType>>;
type _publicOnCategoryDeletedType = typeof onCategoryDeleted$1;
/**
* Triggered when a category is deleted.
*/
declare const onCategoryDeleted: ReturnType<typeof createEventModule<_publicOnCategoryDeletedType>>;
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 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 GetCategoriesCountByLanguageRequest, type GetCategoriesCountByLanguageResponse, type GetCategoryBySlugOptions, type GetCategoryBySlugRequest, type GetCategoryBySlugResponse, type GetCategoryBySlugResponseNonNullableFields, type GetCategoryOptions, type GetCategoryRequest, type GetCategoryResponse, type GetCategoryResponseNonNullableFields, type IdentificationData, type IdentificationDataIdOneOf, type InitialCategoriesCopied, type ItemMetadata, type Keyword, type ListCategoriesOptions, type ListCategoriesRequest, type ListCategoriesResponse, type ListCategoriesResponseNonNullableFields, type MaskedCategory, type MessageEnvelope, type MetaData, type Paging, type PagingMetadataV2, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type QueryCategoriesOptions, type QueryCategoriesRequest, type QueryCategoriesResponse, type QueryCategoriesResponseNonNullableFields, type RestoreInfo, type SeoSchema, type Settings, SortOrder, type Sorting, type Tag, type UpdateCategoryRequest, type UpdateCategoryResponse, WebhookIdentityType, type _publicOnCategoryCreatedType, type _publicOnCategoryDeletedType, type _publicOnCategoryUpdatedType, getCategory, getCategoryBySlug, listCategories, onCategoryCreated, onCategoryDeleted, onCategoryUpdated, onCategoryCreated$1 as publicOnCategoryCreated, onCategoryDeleted$1 as publicOnCategoryDeleted, onCategoryUpdated$1 as publicOnCategoryUpdated, queryCategories };
interface Category {
/**
* Category ID.
* @readonly
*/
/** Category ID. */
_id?: string;

@@ -29,20 +26,5 @@ /** Category label. Displayed in the Category Menu. */

* Reserved for internal use.
* @deprecated
* @replacedBy cover_image
* @removalDate 2024-06-30
*/
coverMedia?: CoverMedia;
/**
* Reserved for internal use.
* @readonly
*/
oldRank?: number;
/**
* Reserved for internal use.
* @deprecated __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated Category position in sequence.
* @replacedBy display_position
* @removalDate 2024-06-30
* @targetRemovalDate 2024-06-30
*/

@@ -82,28 +64,2 @@ rank?: number | null;

}
interface CoverMedia extends CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
/**
* Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @deprecated Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @replacedBy displayed
* @removalDate 2024-06-30
*/
enabled?: boolean;
/** Whether cover media is displayed. */
displayed?: boolean;
/** If `false`, the cover image is the first media item appearing in the content. */
custom?: boolean;
}
/** @oneof */
interface CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
}
/**

@@ -125,2 +81,4 @@ * 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.

isMain?: boolean;
/** Who added the keyword to the settings */
origin?: string | null;
}

@@ -295,3 +253,3 @@ interface Tag {

interface CategoryLanguageCount {
/** 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
/** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */
languageCode?: string | null;

@@ -305,15 +263,2 @@ /** The count of Categories for the language. */

/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -333,15 +278,2 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -353,3 +285,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -367,17 +299,2 @@ */

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -391,3 +308,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -429,54 +346,2 @@ * If omitted, categories in all languages are returned.

interface QueryCategoriesRequest {
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[];
/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** Query options. */

@@ -491,12 +356,2 @@ query?: PlatformQuery;

}
interface Sorting {
/** Name of the field to sort by. */
fieldName?: string;
/** Sort order. */
order?: SortOrder;
}
declare enum SortOrder {
ASC = "ASC",
DESC = "DESC"
}
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {

@@ -529,2 +384,12 @@ /** Paging options to limit and skip the number of items. */

}
interface Sorting {
/** Name of the field to sort by. */
fieldName?: string;
/** Sort order. */
order?: SortOrder;
}
declare enum SortOrder {
ASC = "ASC",
DESC = "DESC"
}
interface Paging {

@@ -551,15 +416,2 @@ /** Number of items to load. */

categories?: Category[];
/**
* __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @deprecated __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @replacedBy pagingMetadata
* @removalDate 2024-06-30
*/
metaData?: MetaData;
/** Details on the paged set of results returned. */

@@ -623,3 +475,3 @@ pagingMetadata?: PagingMetadataV2;

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -653,2 +505,5 @@ /**

}
interface RestoreInfo {
deletedDate?: Date;
}
interface EntityUpdatedEvent {

@@ -709,147 +564,52 @@ /**

}
interface TagNonNullableFields {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}
interface KeywordNonNullableFields {
term: string;
isMain: boolean;
}
interface SettingsNonNullableFields {
preventAutoRedirect: boolean;
keywords: KeywordNonNullableFields[];
}
interface SeoSchemaNonNullableFields {
tags: TagNonNullableFields[];
settings?: SettingsNonNullableFields;
}
interface CategoryTranslationNonNullableFields {
_id: string;
url: string;
}
interface CategoryNonNullableFields {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
slug: string;
seoData?: SeoSchemaNonNullableFields;
coverImage: string;
translations: CategoryTranslationNonNullableFields[];
}
interface GetCategoryResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface GetCategoryBySlugResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface MetaDataNonNullableFields {
count: number;
offset: number;
total: number;
}
interface ListCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
metaData?: MetaDataNonNullableFields;
}
interface QueryCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
}

@@ -883,3 +643,3 @@ interface BaseEventMetadata {

entityId?: string;
/** Event timestamp. */
/** 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;

@@ -915,2 +675,3 @@ /**

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @webhook

@@ -932,2 +693,3 @@ * @eventType wix.blog.v3.category_created

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @webhook

@@ -948,2 +710,3 @@ * @eventType wix.blog.v3.category_updated

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @webhook

@@ -974,12 +737,2 @@ * @eventType wix.blog.v3.category_deleted

interface GetCategoryOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1013,16 +766,6 @@ fieldsets?: Field[];

interface GetCategoryBySlugOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */
fieldsets?: Field[];
/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -1052,13 +795,2 @@ */

paging?: BlogPaging;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1069,3 +801,3 @@ fieldsets?: Field[];

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -1099,2 +831,3 @@ * If omitted, categories in all languages are returned.

* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-CATEGORY
* @applicableIdentity APP

@@ -1105,42 +838,2 @@ * @applicableIdentity VISITOR

interface QueryCategoriesOptions {
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[] | undefined;
/**
* @internal
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[] | undefined;
/** List of category fields to be included in the response. By default, any fields not passed are not returned. */

@@ -1210,2 +903,2 @@ fieldsets?: Field[] | undefined;

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 CoverMedia, type CoverMediaMediaOneOf, 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 GetCategoriesCountByLanguageRequest, type GetCategoriesCountByLanguageResponse, type GetCategoryBySlugOptions, type GetCategoryBySlugRequest, type GetCategoryBySlugResponse, type GetCategoryBySlugResponseNonNullableFields, type GetCategoryOptions, type GetCategoryRequest, type GetCategoryResponse, type GetCategoryResponseNonNullableFields, type IdentificationData, type IdentificationDataIdOneOf, type InitialCategoriesCopied, type ItemMetadata, type Keyword, type ListCategoriesOptions, type ListCategoriesRequest, type ListCategoriesResponse, type ListCategoriesResponseNonNullableFields, type MaskedCategory, type MessageEnvelope, type MetaData, type Paging, type PagingMetadataV2, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type QueryCategoriesOptions, type QueryCategoriesRequest, type QueryCategoriesResponse, type QueryCategoriesResponseNonNullableFields, type SeoSchema, type Settings, SortOrder, type Sorting, type Tag, type UpdateCategoryRequest, type UpdateCategoryResponse, WebhookIdentityType, getCategory, getCategoryBySlug, listCategories, onCategoryCreated, onCategoryDeleted, onCategoryUpdated, queryCategories };
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 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 GetCategoriesCountByLanguageRequest, type GetCategoriesCountByLanguageResponse, type GetCategoryBySlugOptions, type GetCategoryBySlugRequest, type GetCategoryBySlugResponse, type GetCategoryBySlugResponseNonNullableFields, type GetCategoryOptions, type GetCategoryRequest, type GetCategoryResponse, type GetCategoryResponseNonNullableFields, type IdentificationData, type IdentificationDataIdOneOf, type InitialCategoriesCopied, type ItemMetadata, type Keyword, type ListCategoriesOptions, type ListCategoriesRequest, type ListCategoriesResponse, type ListCategoriesResponseNonNullableFields, type MaskedCategory, type MessageEnvelope, type MetaData, type Paging, type PagingMetadataV2, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type QueryCategoriesOptions, type QueryCategoriesRequest, type QueryCategoriesResponse, type QueryCategoriesResponseNonNullableFields, type RestoreInfo, type SeoSchema, type Settings, SortOrder, type Sorting, type Tag, type UpdateCategoryRequest, type UpdateCategoryResponse, WebhookIdentityType, getCategory, getCategoryBySlug, listCategories, onCategoryCreated, onCategoryDeleted, onCategoryUpdated, queryCategories };
interface Category$1 {
/**
* Category ID.
* @readonly
*/
/** Category ID. */
id?: string;

@@ -24,27 +21,6 @@ /** Category label. Displayed in the Category Menu. */

/**
* __Deprecated.__ Use `coverImage` instead.
* This property will be removed on June 30, 2023.
*
* Category cover image or video.
* @deprecated
* @replacedBy cover_image
* @removalDate 2024-06-30
*/
coverMedia?: CoverMedia$1;
/**
* Reserved for internal use.
* @readonly
*/
oldRank?: number;
/**
* __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated Category position in sequence.
* @replacedBy display_position
* @removalDate 2024-06-30
* @targetRemovalDate 2024-06-30
*/

@@ -63,3 +39,3 @@ rank?: number | null;

*
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
*/

@@ -90,70 +66,2 @@ language?: string | null;

}
interface CoverMedia$1 extends CoverMediaMediaOneOf$1 {
/** Image url. */
image?: Image;
/** Video url. */
video?: Video;
/**
* Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @deprecated Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @replacedBy displayed
* @removalDate 2024-06-30
*/
enabled?: boolean;
/** Whether cover media is displayed. */
displayed?: boolean;
/** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
custom?: boolean;
}
/** @oneof */
interface CoverMediaMediaOneOf$1 {
/** Image url. */
image?: Image;
/** Video url. */
video?: Video;
}
interface Image {
/** WixMedia image ID. */
id?: string;
/** Image URL. */
url?: string;
/**
* Original image height.
* @readonly
*/
height?: number;
/**
* Original image width.
* @readonly
*/
width?: number;
/** Image alt text. */
altText?: string | null;
/**
* Image filename.
* @readonly
*/
filename?: string | null;
}
/** Deprecated - use VideoV2 */
interface Video {
/** WixMedia ID */
id?: string;
/** URL of video */
url?: string;
/**
* Original image height
* @readonly
*/
height?: number;
/**
* Original image width
* @readonly
*/
width?: number;
/** Video poster */
thumbnail?: Image;
}
/**

@@ -175,2 +83,4 @@ * 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.

isMain?: boolean;
/** Who added the keyword to the settings */
origin?: string | null;
}

@@ -210,2 +120,25 @@ interface Tag$1 {

}
interface Image {
/** WixMedia image ID. */
id?: string;
/** Image URL. */
url?: string;
/**
* Original image height.
* @readonly
*/
height?: number;
/**
* Original image width.
* @readonly
*/
width?: number;
/** Image alt text. */
altText?: string | null;
/**
* Image filename.
* @readonly
*/
filename?: string | null;
}
declare enum Field$1 {

@@ -229,15 +162,2 @@ UNKNOWN = "UNKNOWN",

/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field$1[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -257,15 +177,2 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field$1[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -277,3 +184,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -291,17 +198,2 @@ */

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field$1[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -315,3 +207,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -357,54 +249,2 @@ * If omitted, categories in all languages are returned.

interface QueryCategoriesRequest$1 {
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging$1;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting$1[];
/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field$1[];
/** Query options. */

@@ -419,12 +259,2 @@ query?: PlatformQuery$1;

}
interface Sorting$1 {
/** Name of the field to sort by. */
fieldName?: string;
/** Sort order. */
order?: SortOrder$1;
}
declare enum SortOrder$1 {
ASC = "ASC",
DESC = "DESC"
}
interface PlatformQuery$1 extends PlatformQueryPagingMethodOneOf$1 {

@@ -457,2 +287,12 @@ /** Paging options to limit and skip the number of items. */

}
interface Sorting$1 {
/** Name of the field to sort by. */
fieldName?: string;
/** Sort order. */
order?: SortOrder$1;
}
declare enum SortOrder$1 {
ASC = "ASC",
DESC = "DESC"
}
interface Paging$1 {

@@ -479,15 +319,2 @@ /** Number of items to load. */

categories?: Category$1[];
/**
* __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @deprecated __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @replacedBy pagingMetadata
* @removalDate 2024-06-30
*/
metaData?: MetaData$1;
/** Details on the paged set of results returned. */

@@ -514,278 +341,66 @@ pagingMetadata?: PagingMetadataV2$1;

}
interface PageUrlNonNullableFields {
base: string;
path: string;
}
interface TagNonNullableFields$1 {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}
interface KeywordNonNullableFields$1 {
term: string;
isMain: boolean;
}
interface SettingsNonNullableFields$1 {
preventAutoRedirect: boolean;
keywords: KeywordNonNullableFields$1[];
}
interface SeoSchemaNonNullableFields$1 {
tags: TagNonNullableFields$1[];
settings?: SettingsNonNullableFields$1;
}
interface ImageNonNullableFields {
id: string;
url: string;
height: number;
width: number;
}
interface CategoryTranslationNonNullableFields$1 {
id: string;
url?: PageUrlNonNullableFields;
}
interface CategoryNonNullableFields$1 {
id: string;
label: string;
postCount: number;
url?: PageUrlNonNullableFields;
title: string;
slug: string;
seoData?: SeoSchemaNonNullableFields$1;
coverImage?: ImageNonNullableFields;
translations: CategoryTranslationNonNullableFields$1[];
}
interface GetCategoryResponseNonNullableFields$1 {
category?: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
};
category?: CategoryNonNullableFields$1;
}
interface GetCategoryBySlugResponseNonNullableFields$1 {
category?: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
};
category?: CategoryNonNullableFields$1;
}
interface MetaDataNonNullableFields$1 {
count: number;
offset: number;
total: number;
}
interface ListCategoriesResponseNonNullableFields$1 {
categories: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields$1[];
metaData?: MetaDataNonNullableFields$1;
}
interface QueryCategoriesResponseNonNullableFields$1 {
categories: {
id: string;
label: string;
postCount: number;
url?: {
base: string;
path: string;
};
title: string;
coverMedia?: {
image?: {
id: string;
url: string;
height: number;
width: number;
};
video?: {
id: string;
url: string;
height: number;
width: number;
thumbnail?: {
id: string;
url: string;
height: number;
width: number;
};
};
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage?: {
id: string;
url: string;
height: number;
width: number;
};
translations: {
id: string;
url?: {
base: string;
path: string;
};
}[];
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields$1[];
}
interface Category {
/**
* Category ID.
* @readonly
*/
/** Category ID. */
_id?: string;

@@ -814,20 +429,5 @@ /** Category label. Displayed in the Category Menu. */

* Reserved for internal use.
* @deprecated
* @replacedBy cover_image
* @removalDate 2024-06-30
*/
coverMedia?: CoverMedia;
/**
* Reserved for internal use.
* @readonly
*/
oldRank?: number;
/**
* Reserved for internal use.
* @deprecated __Deprecated.__ Use `displayPosition` instead.
* This property will be removed on June 30, 2023.
*
* Category position in sequence.
* @deprecated Category position in sequence.
* @replacedBy display_position
* @removalDate 2024-06-30
* @targetRemovalDate 2024-06-30
*/

@@ -867,28 +467,2 @@ rank?: number | null;

}
interface CoverMedia extends CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
/**
* Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @deprecated Is cover media enabled.
* Selected by user whether to display cover media on the feed
* @replacedBy displayed
* @removalDate 2024-06-30
*/
enabled?: boolean;
/** Whether cover media is displayed. */
displayed?: boolean;
/** If `false`, the cover image is the first media item appearing in the content. */
custom?: boolean;
}
/** @oneof */
interface CoverMediaMediaOneOf {
/** Image url. */
image?: string;
/** Video url. */
video?: string;
}
/**

@@ -910,2 +484,4 @@ * 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.

isMain?: boolean;
/** Who added the keyword to the settings */
origin?: string | null;
}

@@ -963,15 +539,2 @@ interface Tag {

/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -991,15 +554,2 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -1011,3 +561,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

/**
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Language of the category to retrieve.

@@ -1025,17 +575,2 @@ */

/**
* __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
*
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/**
* List of additional category fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in

@@ -1049,3 +584,3 @@ * the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default

*
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive categories that are in that language.

@@ -1087,54 +622,2 @@ * If omitted, categories in all languages are returned.

interface QueryCategoriesRequest {
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Pagination options.
* @replacedBy query
* @removalDate 2024-06-30
*/
paging?: BlogPaging;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 30, 2023.
*
* Filter object.
* @replacedBy query
* @removalDate 2024-06-30
*/
filter?: Record<string, any> | null;
/**
* __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @deprecated __Deprecated.__ Use `query` instead.
* This parameter will be removed on June 3, 2023.
*
* Sorting options.
* @replacedBy query
* @removalDate 2024-06-30
*/
sort?: Sorting[];
/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of category fields to be included in the response.
* @replacedBy fieldsets
* @removalDate 2024-06-30
*/
fieldsToInclude?: Field[];
/** Query options. */

@@ -1149,12 +632,2 @@ query?: PlatformQuery;

}
interface Sorting {
/** Name of the field to sort by. */
fieldName?: string;
/** Sort order. */
order?: SortOrder;
}
declare enum SortOrder {
ASC = "ASC",
DESC = "DESC"
}
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {

@@ -1187,2 +660,12 @@ /** Paging options to limit and skip the number of items. */

}
interface Sorting {
/** Name of the field to sort by. */
fieldName?: string;
/** Sort order. */
order?: SortOrder;
}
declare enum SortOrder {
ASC = "ASC",
DESC = "DESC"
}
interface Paging {

@@ -1209,15 +692,2 @@ /** Number of items to load. */

categories?: Category[];
/**
* __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @deprecated __Deprecated.__ Use `pagingMetadata` instead.
* This property will be removed on June 30, 2023.
*
* Details on the paged set of results returned.
* @replacedBy pagingMetadata
* @removalDate 2024-06-30
*/
metaData?: MetaData;
/** Details on the paged set of results returned. */

@@ -1244,147 +714,52 @@ pagingMetadata?: PagingMetadataV2;

}
interface TagNonNullableFields {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}
interface KeywordNonNullableFields {
term: string;
isMain: boolean;
}
interface SettingsNonNullableFields {
preventAutoRedirect: boolean;
keywords: KeywordNonNullableFields[];
}
interface SeoSchemaNonNullableFields {
tags: TagNonNullableFields[];
settings?: SettingsNonNullableFields;
}
interface CategoryTranslationNonNullableFields {
_id: string;
url: string;
}
interface CategoryNonNullableFields {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
slug: string;
seoData?: SeoSchemaNonNullableFields;
coverImage: string;
translations: CategoryTranslationNonNullableFields[];
}
interface GetCategoryResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface GetCategoryBySlugResponseNonNullableFields {
category?: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
};
category?: CategoryNonNullableFields;
}
interface MetaDataNonNullableFields {
count: number;
offset: number;
total: number;
}
interface ListCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
metaData?: MetaDataNonNullableFields;
}
interface QueryCategoriesResponseNonNullableFields {
categories: {
_id: string;
label: string;
postCount: number;
url: string;
title: string;
coverMedia?: {
image: string;
video: string;
enabled: boolean;
displayed: boolean;
custom: boolean;
};
oldRank: number;
slug: string;
seoData?: {
tags: {
type: string;
children: string;
custom: boolean;
disabled: boolean;
}[];
settings?: {
preventAutoRedirect: boolean;
keywords: {
term: string;
isMain: boolean;
}[];
};
};
coverImage: string;
}[];
metaData?: {
count: number;
offset: number;
total: number;
};
categories: CategoryNonNullableFields[];
}

@@ -1391,0 +766,0 @@

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc