@wix/auto_sdk_blog_categories 1.0.0

package/build/internal/es/src/blog-v3-category-categories.public.d.ts

@@ -0,0 +1,99 @@
+import { EventDefinition, HttpClient } from '@wix/sdk-types';
+import { CategoriesQueryBuilder, Category, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryNonNullableFields, CategoryUpdatedEnvelope, CreateCategoryOptions, GetCategoryBySlugOptions, GetCategoryBySlugResponse, GetCategoryBySlugResponseNonNullableFields, GetCategoryOptions, GetCategoryResponse, GetCategoryResponseNonNullableFields, ListCategoriesOptions, ListCategoriesResponse, ListCategoriesResponseNonNullableFields, QueryCategoriesOptions, UpdateCategory, UpdateCategoryOptions } from './blog-v3-category-categories.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function createCategory(httpClient: HttpClient): CreateCategorySignature;
+interface CreateCategorySignature {
+    /**
+     * Creates a category.
+     * @param - Category info.
+     * @returns Category info.
+     */
+    (category: Category, options?: CreateCategoryOptions | undefined): Promise<Category & CategoryNonNullableFields>;
+}
+export declare function updateCategory(httpClient: HttpClient): UpdateCategorySignature;
+interface UpdateCategorySignature {
+    /**
+     * Updates a category.
+     * @param - Category ID.
+     * @returns Category info.
+     */
+    (_id: string, category: UpdateCategory, options?: UpdateCategoryOptions | undefined): Promise<Category & CategoryNonNullableFields>;
+}
+export declare function getCategory(httpClient: HttpClient): GetCategorySignature;
+interface GetCategorySignature {
+    /**
+     * Gets a category with 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 with the specified slug.
+     *
+     * The slug is at the end of the URL of a specific category.
+     * For example, if a category's URL is `https://example.com/blog/categories/famous-cats`, the slug is `famous-cats`.
+     * The slug is a case-sensitive string that is derived from the category's label, unless specified otherwise.
+     * @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 up to 100 categories per request.
+     *
+     * If you pass a language filter to the method, it returns a list of up to 100 categories in the requested language.
+     *
+     * The categoies are displayed in order of their `displayPosition`, starting with `0`. The `displayPosition` is the position in which the categories
+     * are displayed in the Category Menu page. By default, categories get added to the bottom of the Category Menu page with a `displayPosition` of `-1`.
+     *
+     * List Categories runs with these defaults, which you can override:
+     * - `paging.limit` is `50`.
+     * - `paging.offset` is `0`.
+     *
+     * List Categories is sorted by `displayPosition` in descending order. This cannot be overridden.
+     * @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 Query Categories method builds a query to retrieve a list of up to 100 categories per language, and returns a [`CategoriesQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending) object.
+     *
+     * The response contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/find) method.
+     *
+     * You can refine the query by chaining `CategoriesQueryBuilder` methods to the query. `CategoriesQueryBuilder` methods enable you to sort, filter, and control the results that Query Categories returns. Any methods chained to the Query Categories method are applied in the order that they are called.
+     *
+     * Query Categories runs with these `CategoriesQueryBuilder` defaults, which you can override.
+     * - [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/limit)
+     * - [`ascending(displayPosition)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending)
+     *
+     * The following `CategoriesQueryBuilder` methods are supported for Query Categories. For a full description of the `Categories` object, see the response for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-result/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).
+     * @param - Options specifying which fields to return.
+     */
+    (options?: QueryCategoriesOptions | undefined): CategoriesQueryBuilder;
+}
+export declare function deleteCategory(httpClient: HttpClient): DeleteCategorySignature;
+interface DeleteCategorySignature {
+    /**
+     * Deletes a category.
+     * @param - Category ID.
+     */
+    (categoryId: string): Promise<void>;
+}
+export declare const onCategoryCreated: EventDefinition<CategoryCreatedEnvelope, "wix.blog.v3.category_created">;
+export declare const onCategoryDeleted: EventDefinition<CategoryDeletedEnvelope, "wix.blog.v3.category_deleted">;
+export declare const onCategoryUpdated: EventDefinition<CategoryUpdatedEnvelope, "wix.blog.v3.category_updated">;
+export { ActionEvent, ApplicationError, BaseEventMetadata, BlogPaging, BulkActionMetadata, BulkCategoryResult, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkDeleteCategoryRequest, BulkDeleteCategoryResponse, BulkUpdateCategoriesRequest, BulkUpdateCategoriesResponse, CategoriesQueryBuilder, CategoriesQueryResult, Category, CategoryCreatedEnvelope, CategoryDeletedEnvelope, CategoryLanguageCount, CategoryNonNullableFields, CategoryTranslation, CategoryUpdatedEnvelope, CreateCategoryOptions, CreateCategoryRequest, CreateCategoryResponse, CreateCategoryResponseNonNullableFields, CursorPaging, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Field, FocalPoint, 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, UpdateCategory, UpdateCategoryOptions, UpdateCategoryRequest, UpdateCategoryResponse, UpdateCategoryResponseNonNullableFields, WebhookIdentityType, } from './blog-v3-category-categories.universal.js';

package/build/internal/es/src/blog-v3-category-categories.public.js

@@ -0,0 +1,99 @@
+import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
+import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
+import { transformRESTPageURLToSDKPageURL } from '@wix/sdk-runtime/transformations/page-url';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { EventDefinition } from '@wix/sdk-types';
+import { createCategory as universalCreateCategory, deleteCategory as universalDeleteCategory, getCategory as universalGetCategory, getCategoryBySlug as universalGetCategoryBySlug, listCategories as universalListCategories, queryCategories as universalQueryCategories, updateCategory as universalUpdateCategory, } from './blog-v3-category-categories.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/blog' };
+export function createCategory(httpClient) {
+    return (category, options) => universalCreateCategory(category, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function updateCategory(httpClient) {
+    return (_id, category, options) => universalUpdateCategory(_id, category, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getCategory(httpClient) {
+    return (categoryId, options) => universalGetCategory(categoryId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getCategoryBySlug(httpClient) {
+    return (slug, options) => universalGetCategoryBySlug(slug, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function listCategories(httpClient) {
+    return (options) => universalListCategories(options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function queryCategories(httpClient) {
+    return (options) => universalQueryCategories(options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function deleteCategory(httpClient) {
+    return (categoryId) => universalDeleteCategory(categoryId, 
+    // @ts-ignore
+    { httpClient });
+}
+export const onCategoryCreated = EventDefinition('wix.blog.v3.category_created', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTPageURLToSDKPageURL,
+        paths: [{ path: 'entity.url' }, { path: 'entity.translations.url' }],
+    },
+    {
+        transformFn: transformRESTImageToSDKImage,
+        paths: [{ path: 'entity.coverImage' }],
+    },
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+export const onCategoryDeleted = EventDefinition('wix.blog.v3.category_deleted', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTPageURLToSDKPageURL,
+        paths: [
+            { path: 'undefined.url' },
+            { path: 'undefined.translations.url' },
+        ],
+    },
+    {
+        transformFn: transformRESTImageToSDKImage,
+        paths: [{ path: 'undefined.coverImage' }],
+    },
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'undefined.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+export const onCategoryUpdated = EventDefinition('wix.blog.v3.category_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTPageURLToSDKPageURL,
+        paths: [{ path: 'entity.url' }, { path: 'entity.translations.url' }],
+    },
+    {
+        transformFn: transformRESTImageToSDKImage,
+        paths: [{ path: 'entity.coverImage' }],
+    },
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+export { Field, SortOrder, WebhookIdentityType, } from './blog-v3-category-categories.universal.js';
+//# sourceMappingURL=blog-v3-category-categories.public.js.map

package/build/internal/es/src/blog-v3-category-categories.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blog-v3-category-categories.public.js","sourceRoot":"","sources":["../../../../src/blog-v3-category-categories.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,gCAAgC,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAoBL,cAAc,IAAI,uBAAuB,EACzC,cAAc,IAAI,uBAAuB,EACzC,WAAW,IAAI,oBAAoB,EACnC,iBAAiB,IAAI,0BAA0B,EAC/C,cAAc,IAAI,uBAAuB,EACzC,eAAe,IAAI,wBAAwB,EAC3C,cAAc,IAAI,uBAAuB,GAC1C,MAAM,4CAA4C,CAAC;AAEpD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,QAAkB,EAAE,OAA+B,EAAE,EAAE,CAC7D,uBAAuB,CACrB,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAaD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CACL,GAAW,EACX,QAAwB,EACxB,OAA+B,EAC/B,EAAE,CACF,uBAAuB,CACrB,GAAG,EACH,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAeD,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,UAAkB,EAAE,OAA4B,EAAE,EAAE,CAC1D,oBAAoB,CAClB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAaD,MAAM,UAAU,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,CAAC,IAAY,EAAE,OAAkC,EAAE,EAAE,CAC1D,0BAA0B,CACxB,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAmBD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,OAA+B,EAAE,EAAE,CACzC,uBAAuB,CACrB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAuBD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,wBAAwB,CACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAuBD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,UAAkB,EAAE,EAAE,CAC5B,uBAAuB,CACrB,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAUD,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,8BAA8B,EAC9B,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KACrE;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;KACvC;IACD;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAC7B,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,8BAA8B,EAC9B,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,eAAe,EAAE;YACzB,EAAE,IAAI,EAAE,4BAA4B,EAAE;SACvC;KACF;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC;KAC1C;IACD;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAC7B,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,8BAA8B,EAC9B,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC;KACrE;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;KACvC;IACD;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAE7B,OAAO,EAoCL,KAAK,EAmCL,SAAS,EAQT,mBAAmB,GACpB,MAAM,4CAA4C,CAAC"}