@wix/auto_sdk_categories_categories 1.0.85 → 1.0.87
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{categories-v1-category-categories.universal-z1qWnkSE.d.ts → categories-v1-category-categories.universal-DQ9i6L8H.d.ts} +23 -20
- package/build/cjs/index.d.ts +9 -7
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +8 -6
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +10 -10
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{categories-v1-category-categories.universal-z1qWnkSE.d.mts → categories-v1-category-categories.universal-DQ9i6L8H.d.mts} +23 -20
- package/build/es/index.d.mts +9 -7
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +8 -6
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +10 -10
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{categories-v1-category-categories.universal-CUXzcBSs.d.ts → categories-v1-category-categories.universal-CYoESLYe.d.ts} +23 -20
- package/build/internal/cjs/index.d.ts +9 -7
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +8 -6
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +10 -10
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{categories-v1-category-categories.universal-CUXzcBSs.d.mts → categories-v1-category-categories.universal-CYoESLYe.d.mts} +23 -20
- package/build/internal/es/index.d.mts +9 -7
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +8 -6
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +10 -10
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -100,7 +100,7 @@ interface Category {
|
|
|
100
100
|
/**
|
|
101
101
|
* Custom extended fields for the category object.
|
|
102
102
|
*
|
|
103
|
-
* [Extended fields](https://dev.wix.com/docs/
|
|
103
|
+
* [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
|
|
104
104
|
*/
|
|
105
105
|
extendedFields?: ExtendedFields;
|
|
106
106
|
}
|
|
@@ -2535,7 +2535,7 @@ interface SearchCategoriesRequest {
|
|
|
2535
2535
|
* Search criteria including filter, sort, aggregations, and paging options.
|
|
2536
2536
|
*
|
|
2537
2537
|
* Refer to the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
2538
|
-
* or the [supported filters article](https://dev.wix.com/docs/
|
|
2538
|
+
* or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST)
|
|
2539
2539
|
* for a complete list of supported filters and sorting options.
|
|
2540
2540
|
*/
|
|
2541
2541
|
search?: CursorSearch;
|
|
@@ -2566,14 +2566,14 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
2566
2566
|
* Filter object for narrowing search results. For example, to return only categories from the Stores app: `"filter": {"appNamespace": "@wix/stores"}`.
|
|
2567
2567
|
*
|
|
2568
2568
|
* Learn more about the filter format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
2569
|
-
* or the [supported filters article](https://dev.wix.com/docs/
|
|
2569
|
+
* or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
|
|
2570
2570
|
*/
|
|
2571
2571
|
filter?: Record<string, any> | null;
|
|
2572
2572
|
/**
|
|
2573
2573
|
* Array of sort objects specifying result order. For example, to sort by creation date in ascending order: `"sort": [{"fieldName": "createdDate", "order": "ASC"}]`.
|
|
2574
2574
|
*
|
|
2575
2575
|
* Learn more about the sort format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
2576
|
-
* or the [supported filters article](https://dev.wix.com/docs/
|
|
2576
|
+
* or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
|
|
2577
2577
|
* @maxSize 10
|
|
2578
2578
|
*/
|
|
2579
2579
|
sort?: Sorting[];
|
|
@@ -2588,7 +2588,7 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
2588
2588
|
/**
|
|
2589
2589
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) or [ISO 8601 UTC offset format](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC) for adjusting time fields in the specified filters and returned aggregation data. For example, `America/New_York`, `UTC`, or `+02:00`.
|
|
2590
2590
|
*
|
|
2591
|
-
* Default: Time zone specified in the business [site properties](https://dev.wix.com/docs/
|
|
2591
|
+
* Default: Time zone specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
|
|
2592
2592
|
* @maxLength 50
|
|
2593
2593
|
*/
|
|
2594
2594
|
timeZone?: string | null;
|
|
@@ -3090,7 +3090,7 @@ interface DeprecatedSearchCategoriesWithOffsetRequest {
|
|
|
3090
3090
|
interface OffsetSearch extends OffsetSearchPagingMethodOneOf {
|
|
3091
3091
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
3092
3092
|
paging?: Paging;
|
|
3093
|
-
/** A filter object. Learn more about [API query language](https://dev.wix.com/docs/
|
|
3093
|
+
/** A filter object. Learn more about [API query language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language). */
|
|
3094
3094
|
filter?: Record<string, any> | null;
|
|
3095
3095
|
/**
|
|
3096
3096
|
* Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
|
|
@@ -3155,7 +3155,7 @@ interface CountCategoriesRequest {
|
|
|
3155
3155
|
/**
|
|
3156
3156
|
* Filter object.
|
|
3157
3157
|
*
|
|
3158
|
-
* Learn more about the [filter object structure](https://dev.wix.com/docs/
|
|
3158
|
+
* Learn more about the [filter object structure](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters).
|
|
3159
3159
|
*/
|
|
3160
3160
|
filter?: Record<string, any> | null;
|
|
3161
3161
|
/** Search options. */
|
|
@@ -3503,7 +3503,7 @@ interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMet
|
|
|
3503
3503
|
/**
|
|
3504
3504
|
* Cursor paging options.
|
|
3505
3505
|
*
|
|
3506
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/
|
|
3506
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging).
|
|
3507
3507
|
*/
|
|
3508
3508
|
cursorPaging?: CursorPaging;
|
|
3509
3509
|
/**
|
|
@@ -3531,7 +3531,7 @@ interface ListItemsInCategoryRequestPagingMethodOneOf {
|
|
|
3531
3531
|
/**
|
|
3532
3532
|
* Cursor paging options.
|
|
3533
3533
|
*
|
|
3534
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/
|
|
3534
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging).
|
|
3535
3535
|
*/
|
|
3536
3536
|
cursorPaging?: CursorPaging;
|
|
3537
3537
|
}
|
|
@@ -4225,6 +4225,7 @@ declare function onCategoryItemsArrangedInCategory(handler: (event: CategoryItem
|
|
|
4225
4225
|
interface CategoryUpdatedEnvelope {
|
|
4226
4226
|
entity: Category;
|
|
4227
4227
|
metadata: EventMetadata;
|
|
4228
|
+
/** @hidden */
|
|
4228
4229
|
modifiedFields: Record<string, any>;
|
|
4229
4230
|
}
|
|
4230
4231
|
/** @permissionScope Manage Stores - all permissions
|
|
@@ -4423,7 +4424,7 @@ interface UpdateCategory {
|
|
|
4423
4424
|
/**
|
|
4424
4425
|
* Custom extended fields for the category object.
|
|
4425
4426
|
*
|
|
4426
|
-
* [Extended fields](https://dev.wix.com/docs/
|
|
4427
|
+
* [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
|
|
4427
4428
|
*/
|
|
4428
4429
|
extendedFields?: ExtendedFields;
|
|
4429
4430
|
}
|
|
@@ -4456,11 +4457,13 @@ declare function deleteCategory(categoryId: string, treeReference: NonNullablePa
|
|
|
4456
4457
|
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
4457
4458
|
*
|
|
4458
4459
|
* For field support for filters and sorting,
|
|
4459
|
-
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/
|
|
4460
|
+
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting).
|
|
4460
4461
|
*
|
|
4461
4462
|
* To learn about working with _Query_ endpoints, see
|
|
4462
|
-
* [API Query Language](https://dev.wix.com/docs/
|
|
4463
|
-
* and [Sorting and Paging](https://dev.wix.com/docs/
|
|
4463
|
+
* [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
|
|
4464
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
|
|
4465
|
+
*
|
|
4466
|
+
* Learn more about the differences between [_Query_ and _Search_](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-search-query-and-list-methods) methods.
|
|
4464
4467
|
* @public
|
|
4465
4468
|
* @permissionId CATEGORIES.CATEGORY_READ
|
|
4466
4469
|
* @applicableIdentity APP
|
|
@@ -4707,14 +4710,14 @@ type CategorySearch = {
|
|
|
4707
4710
|
Filter object for narrowing search results. For example, to return only categories from the Stores app: `"filter": {"appNamespace": "@wix/stores"}`.
|
|
4708
4711
|
|
|
4709
4712
|
Learn more about the filter format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
4710
|
-
or the [supported filters article](https://dev.wix.com/docs/
|
|
4713
|
+
or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
|
|
4711
4714
|
*/
|
|
4712
4715
|
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
4713
4716
|
/**
|
|
4714
4717
|
Array of sort objects specifying result order. For example, to sort by creation date in ascending order: `"sort": [{"fieldName": "createdDate", "order": "ASC"}]`.
|
|
4715
4718
|
|
|
4716
4719
|
Learn more about the sort format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
4717
|
-
or the [supported filters article](https://dev.wix.com/docs/
|
|
4720
|
+
or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
|
|
4718
4721
|
@maxSize: 10
|
|
4719
4722
|
*/
|
|
4720
4723
|
sort?: {
|
|
@@ -4796,7 +4799,7 @@ type CategorySearch = {
|
|
|
4796
4799
|
/**
|
|
4797
4800
|
Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) or [ISO 8601 UTC offset format](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC) for adjusting time fields in the specified filters and returned aggregation data. For example, `America/New_York`, `UTC`, or `+02:00`.
|
|
4798
4801
|
|
|
4799
|
-
Default: Time zone specified in the business [site properties](https://dev.wix.com/docs/
|
|
4802
|
+
Default: Time zone specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties).
|
|
4800
4803
|
@maxLength: 50
|
|
4801
4804
|
*/
|
|
4802
4805
|
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
@@ -4805,7 +4808,7 @@ type CategorySearch = {
|
|
|
4805
4808
|
* Counts the number of categories that match the provided filtering.
|
|
4806
4809
|
*
|
|
4807
4810
|
* For field support for filters and sorting,
|
|
4808
|
-
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/
|
|
4811
|
+
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting).
|
|
4809
4812
|
* @public
|
|
4810
4813
|
* @requiredField options.treeReference
|
|
4811
4814
|
* @requiredField options.treeReference.appNamespace
|
|
@@ -4818,7 +4821,7 @@ interface CountCategoriesOptions {
|
|
|
4818
4821
|
/**
|
|
4819
4822
|
* Filter object.
|
|
4820
4823
|
*
|
|
4821
|
-
* Learn more about the [filter object structure](https://dev.wix.com/docs/
|
|
4824
|
+
* Learn more about the [filter object structure](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters).
|
|
4822
4825
|
*/
|
|
4823
4826
|
filter?: Record<string, any> | null;
|
|
4824
4827
|
/** Search options. */
|
|
@@ -5114,7 +5117,7 @@ interface ListItemsInCategoryOptions extends ListItemsInCategoryOptionsPagingMet
|
|
|
5114
5117
|
/**
|
|
5115
5118
|
* Cursor paging options.
|
|
5116
5119
|
*
|
|
5117
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/
|
|
5120
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging).
|
|
5118
5121
|
*/
|
|
5119
5122
|
cursorPaging?: CursorPaging;
|
|
5120
5123
|
}
|
|
@@ -5123,7 +5126,7 @@ interface ListItemsInCategoryOptionsPagingMethodOneOf {
|
|
|
5123
5126
|
/**
|
|
5124
5127
|
* Cursor paging options.
|
|
5125
5128
|
*
|
|
5126
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/
|
|
5129
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging).
|
|
5127
5130
|
*/
|
|
5128
5131
|
cursorPaging?: CursorPaging;
|
|
5129
5132
|
}
|
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import { C as Category, a as CreateCategoryOptions, b as CreateCategoryApplicationErrors, T as TreeReference, G as GetCategoryOptions, U as UpdateCategory, c as UpdateCategoryOptions, d as UpdateCategoryApplicationErrors, D as DeleteCategoryApplicationErrors, e as CategorySearch, S as SearchCategoriesOptions, f as SearchCategoriesResponse, g as CountCategoriesOptions, h as CountCategoriesResponse, M as MoveCategoryOptions, i as MoveCategoryResponse, j as MoveCategoryApplicationErrors, k as MaskedCategory, B as BulkUpdateCategoriesOptions, l as BulkUpdateCategoriesResponse, m as BulkUpdateCategoriesApplicationErrors, n as UpdateCategoryVisibilityOptions, o as UpdateCategoryVisibilityResponse, p as UpdateCategoryVisibilityApplicationErrors, q as BulkShowCategoriesOptions, r as BulkShowCategoriesResponse, I as ItemReference, s as BulkAddItemsToCategoryOptions, t as BulkAddItemsToCategoryResponse, u as BulkAddItemsToCategoryApplicationErrors, v as BulkAddItemToCategoriesOptions, w as BulkAddItemToCategoriesResponse, x as BulkAddItemToCategoriesApplicationErrors, y as BulkRemoveItemsFromCategoryOptions, z as BulkRemoveItemsFromCategoryResponse, A as BulkRemoveItemsFromCategoryApplicationErrors, E as BulkRemoveItemFromCategoriesOptions, F as BulkRemoveItemFromCategoriesResponse, H as BulkRemoveItemFromCategoriesApplicationErrors, L as ListItemsInCategoryOptions, J as ListItemsInCategoryResponse, K as ListCategoriesForItemOptions, N as ListCategoriesForItemResponse, O as ListCategoriesForItemsOptions, P as ListCategoriesForItemsResponse, Q as ListTreesResponse, R as SetArrangedItemsOptions, V as SetArrangedItemsResponse, W as SetArrangedItemsApplicationErrors, X as GetArrangedItemsResponse, Y as CategoryMovedEnvelope, Z as CategoryCreatedEnvelope, _ as CategoryDeletedEnvelope, $ as CategoryItemAddedToCategoryEnvelope, a0 as CategoryItemRemovedFromCategoryEnvelope, a1 as CategoryItemsArrangedInCategoryEnvelope, a2 as CategoryUpdatedEnvelope, a3 as CategoryQuery, a4 as QueryCategoriesOptions, a5 as typedQueryCategories, a6 as CategoriesQueryBuilder } from './categories-v1-category-categories.universal-
|
|
3
|
-
export { ey as ActionEvent, dg as Aggregation, du as AggregationData, dh as AggregationKindOneOf, dN as AggregationResults, dO as AggregationResultsResultOneOf, dB as AggregationResultsScalarResult, aW as AggregationType, fx as AggregationTypeWithLiterals, aB as Alignment, fc as AlignmentWithLiterals, c5 as AnchorData, cL as App, cc as AppEmbedData, cd as AppEmbedDataAppDataOneOf, aD as AppType, fe as AppTypeWithLiterals, d_ as ApplicationError, ax as AspectRatio, f8 as AspectRatioWithLiterals, cx as AudioData, bX as Background, bY as BackgroundBackgroundOneOf, cD as BackgroundImage, at as BackgroundType, f4 as BackgroundTypeWithLiterals, eD as BaseEventMetadata, cA as BlockquoteData, ce as BookingData, bb as Border, cu as BorderColors, cv as BorderWidths, b0 as Breadcrumb, a$ as BreadcrumbsInfo, d$ as BulkActionMetadata, e8 as BulkAddItemToCategoriesRequest, e5 as BulkAddItemsToCategoryRequest, dY as BulkCategoriesResult, e2 as BulkDeleteCategoriesRequest, e3 as BulkDeleteCategoriesResponse, e4 as BulkDeleteCategoriesResponseBulkCategoriesResult, e9 as BulkItemToCategoriesResult, e6 as BulkItemsToCategoryResult, eb as BulkRemoveItemFromCategoriesRequest, ea as BulkRemoveItemsFromCategoryRequest, fC as BulkSetItemCategoriesApplicationErrors, eJ as BulkSetItemCategoriesOptions, en as BulkSetItemCategoriesRequest, eo as BulkSetItemCategoriesResponse, e1 as BulkShowCategoriesRequest, dX as BulkUpdateCategoriesRequest, cz as BulletedListData, ba as ButtonData, aa as ButtonDataType, eN as ButtonDataTypeWithLiterals, cg as ButtonStyles, cB as CaptionData, cj as CardStyles, eF as CategoriesQueryResult, cQ as CategoryMoved, eG as CategoryQuerySpec, eH as CategorySearchSpec, er as CategoryTreeNode, ct as CellStyle, bm as CodeBlockData, cp as CollapsibleListData, c6 as ColorData, bc as Colors, fD as CommonQueryWithEntityContext, fE as CommonSearchWithEntityContext, dc as CompactCategory, dV as CountCategoriesRequest, cW as CreateCategoryRequest, cX as CreateCategoryResponse, aj as Crop, eW as CropWithLiterals, d6 as CursorPaging, d8 as CursorPagingMetadata, d3 as CursorQuery, d4 as CursorQueryPagingMethodOneOf, de as CursorSearch, df as CursorSearchPagingMethodOneOf, d9 as Cursors, cP as CustomTag, dp as DateHistogramAggregation, dJ as DateHistogramResult, dL as DateHistogramResults, c3 as Decoration, c4 as DecorationDataOneOf, au as DecorationType, f5 as DecorationTypeWithLiterals, d0 as DeleteCategoryRequest, d1 as DeleteCategoryResponse, dP as DeprecatedSearchCategoriesWithOffsetRequest, dT as DeprecatedSearchCategoriesWithOffsetResponse, c1 as Design, aM as DesignTarget, fn as DesignTargetWithLiterals, cr as Dimensions, aF as Direction, fg as DirectionWithLiterals, bo as DividerData, af as DividerDataAlignment, eS as DividerDataAlignmentWithLiterals, cG as DocumentStyle, es as DomainEvent, et as DomainEventBodyOneOf, cn as EmbedData, ez as Empty, eu as EntityCreatedEvent, ex as EntityDeletedEvent, ew as EntityUpdatedEvent, cf as EventData, eE as EventMetadata, cI as ExtendedFields, cO as File, bp as FileData, bq as FileSource, br as FileSourceDataOneOf, cb as FontFamilyData, c9 as FontSizeData, av as FontType, f6 as FontTypeWithLiterals, bE as GIF, bD as GIFData, al as GIFType, eY as GIFTypeWithLiterals, bt as GalleryData, bz as GalleryOptions, bA as GalleryOptionsLayout, em as GetArrangedItemsRequest, ep as GetCategoriesTreeRequest, eq as GetCategoriesTreeResponse, cY as GetCategoryRequest, cZ as GetCategoryResponse, bW as Gradient, dK as GroupByValueResults, bG as HTMLData, bH as HTMLDataDataOneOf, bF as HeadingData, bh as Height, eB as IdentificationData, eC as IdentificationDataIdOneOf, bv as Image, bI as ImageData, bK as ImageDataStyles, aJ as ImagePosition, fk as ImagePositionWithLiterals, ch as ImageStyles, aw as ImageStylesPosition, f7 as ImageStylesPositionWithLiterals, dj as IncludeMissingValuesOptions, aE as InitialExpandedItems, ff as InitialExpandedItemsWithLiterals, aV as Interval, fw as IntervalWithLiterals, cJ as InvalidateCache, cK as InvalidateCacheGetByOneOf, bx as Item, cR as ItemAddedToCategory, by as ItemDataOneOf, dZ as ItemMetadata, e7 as ItemReferenceMetadata, cT as ItemRemovedFromCategory, bB as ItemStyle, cS as ItemsAddedToCategory, cV as ItemsArrangedInCategory, cU as ItemsRemovedFromCategory, b3 as Keyword, aC as Layout, cE as LayoutCellData, cC as LayoutData, ah as LayoutType, eU as LayoutTypeWithLiterals, fd as LayoutWithLiterals, ad as LineStyle, eQ as LineStyleWithLiterals, bj as Link, c7 as LinkData, bk as LinkDataOneOf, bL as LinkPreviewData, bM as LinkPreviewDataStyles, ef as ListCategoriesForItemRequest, eg as ListCategoriesForItemsRequest, da as ListCompactCategoriesByIdsRequest, db as ListCompactCategoriesByIdsResponse, eI as ListItemsInCategoryOptionsPagingMethodOneOf, ec as ListItemsInCategoryRequest, ed as ListItemsInCategoryRequestPagingMethodOneOf, ei as ListTreesRequest, cw as ListValue, bN as MapData, eh as MapItemToCategories, bO as MapSettings, ao as MapType, e$ as MapTypeWithLiterals, bu as Media, c8 as MentionData, eA as MessageEnvelope, cF as Metadata, aS as MissingValues, ft as MissingValuesWithLiterals, aX as Mode, fy as ModeWithLiterals, dW as MoveCategoryRequest, ej as MoveItemInCategoryRequest, aZ as MoveItemInCategoryRequestPosition, fA as MoveItemInCategoryRequestPositionWithLiterals, ek as MoveItemInCategoryResponse, ds as NestedAggregation, dq as NestedAggregationItem, dr as NestedAggregationItemKindOneOf, dx as NestedAggregationResults, dy as NestedAggregationResultsResultOneOf, aU as NestedAggregationType, fv as NestedAggregationTypeWithLiterals, dG as NestedResultValue, dH as NestedResultValueResultOneOf, dM as NestedResults, dC as NestedValueAggregationResult, b7 as Node, b8 as NodeDataOneOf, b9 as NodeStyle, a7 as NodeType, eK as NodeTypeWithLiterals, aH as NullValue, fi as NullValueWithLiterals, co as Oembed, dQ as OffsetSearch, dR as OffsetSearchPagingMethodOneOf, bS as Option, b_ as OptionDesign, bV as OptionLayout, cy as OrderedListData, ai as Orientation, eV as OrientationWithLiterals, bs as PDFSettings, cM as Page, dS as Paging, dU as PagingMetadata, ee as PagingMetadataV2, bP as ParagraphData, b1 as ParentCategory, bR as Permissions, az as Placement, fa as PlacementWithLiterals, cm as PlaybackOptions, bd as PluginContainerData, a9 as PluginContainerDataAlignment, eM as PluginContainerDataAlignmentWithLiterals, be as PluginContainerDataWidth, bf as PluginContainerDataWidthDataOneOf, b$ as Poll, bQ as PollData, c0 as PollDataLayout, bZ as PollDesign, bU as PollLayout, as as PollLayoutDirection, f3 as PollLayoutDirectionWithLiterals, ar as PollLayoutType, f2 as PollLayoutTypeWithLiterals, bT as PollSettings, aY as Position, fz as PositionWithLiterals, ck as PricingData, d2 as QueryCategoriesRequest, d7 as QueryCategoriesResponse, dm as RangeAggregation, dw as RangeAggregationResult, di as RangeBucket, dE as RangeResult, dA as RangeResults, bl as Rel, aP as RequestedFields, fq as RequestedFieldsWithLiterals, ay as Resizing, f9 as ResizingWithLiterals, aL as ResponsivenessBehaviour, fm as ResponsivenessBehaviourWithLiterals, ev as RestoreInfo, dI as Results, ci as RibbonStyles, b6 as RichContent, dn as ScalarAggregation, dF as ScalarResult, aT as ScalarType, fu as ScalarTypeWithLiterals, aI as Scaling, fj as ScalingWithLiterals, dd as SearchCategoriesRequest, dt as SearchDetails, b2 as SeoSchema, el as SetArrangedItemsRequest, b5 as Settings, aN as SingleEntityOpsRequestedFields, fo as SingleEntityOpsRequestedFieldsWithLiterals, aR as SortDirection, fs as SortDirectionWithLiterals, aO as SortOrder, fp as SortOrderWithLiterals, aQ as SortType, fr as SortTypeWithLiterals, d5 as Sorting, am as Source, eZ as SourceWithLiterals, bg as Spoiler, ca as SpoilerData, bi as Styles, bJ as StylesBorder, an as StylesPosition, e_ as StylesPositionWithLiterals, cs as TableCellData, cq as TableData, b4 as Tag, ab as Target, eO as TargetWithLiterals, ac as TextAlignment, eP as TextAlignmentWithLiterals, c2 as TextData, cH as TextNodeStyle, bn as TextStyle, bC as Thumbnails, ak as ThumbnailsAlignment, eX as ThumbnailsAlignmentWithLiterals, aA as Type, fb as TypeWithLiterals, cN as URI, c_ as UpdateCategoryRequest, c$ as UpdateCategoryResponse, e0 as UpdateCategoryVisibilityRequest, dk as ValueAggregation, dl as ValueAggregationOptionsOneOf, dv as ValueAggregationResult, dD as ValueResult, dz as ValueResults, aG as VerticalAlignment, aK as VerticalAlignmentAlignment, fl as VerticalAlignmentAlignmentWithLiterals, fh as VerticalAlignmentWithLiterals, bw as Video, cl as VideoData, ag as ViewMode, eT as ViewModeWithLiterals, ap as ViewRole, f0 as ViewRoleWithLiterals, aq as VoteRole, f1 as VoteRoleWithLiterals, a_ as WebhookIdentityType, fB as WebhookIdentityTypeWithLiterals, ae as Width, a8 as WidthType, eL as WidthTypeWithLiterals, eR as WidthWithLiterals } from './categories-v1-category-categories.universal-
|
|
2
|
+
import { C as Category, a as CreateCategoryOptions, b as CreateCategoryApplicationErrors, T as TreeReference, G as GetCategoryOptions, U as UpdateCategory, c as UpdateCategoryOptions, d as UpdateCategoryApplicationErrors, D as DeleteCategoryApplicationErrors, e as CategorySearch, S as SearchCategoriesOptions, f as SearchCategoriesResponse, g as CountCategoriesOptions, h as CountCategoriesResponse, M as MoveCategoryOptions, i as MoveCategoryResponse, j as MoveCategoryApplicationErrors, k as MaskedCategory, B as BulkUpdateCategoriesOptions, l as BulkUpdateCategoriesResponse, m as BulkUpdateCategoriesApplicationErrors, n as UpdateCategoryVisibilityOptions, o as UpdateCategoryVisibilityResponse, p as UpdateCategoryVisibilityApplicationErrors, q as BulkShowCategoriesOptions, r as BulkShowCategoriesResponse, I as ItemReference, s as BulkAddItemsToCategoryOptions, t as BulkAddItemsToCategoryResponse, u as BulkAddItemsToCategoryApplicationErrors, v as BulkAddItemToCategoriesOptions, w as BulkAddItemToCategoriesResponse, x as BulkAddItemToCategoriesApplicationErrors, y as BulkRemoveItemsFromCategoryOptions, z as BulkRemoveItemsFromCategoryResponse, A as BulkRemoveItemsFromCategoryApplicationErrors, E as BulkRemoveItemFromCategoriesOptions, F as BulkRemoveItemFromCategoriesResponse, H as BulkRemoveItemFromCategoriesApplicationErrors, L as ListItemsInCategoryOptions, J as ListItemsInCategoryResponse, K as ListCategoriesForItemOptions, N as ListCategoriesForItemResponse, O as ListCategoriesForItemsOptions, P as ListCategoriesForItemsResponse, Q as ListTreesResponse, R as SetArrangedItemsOptions, V as SetArrangedItemsResponse, W as SetArrangedItemsApplicationErrors, X as GetArrangedItemsResponse, Y as CategoryMovedEnvelope, Z as CategoryCreatedEnvelope, _ as CategoryDeletedEnvelope, $ as CategoryItemAddedToCategoryEnvelope, a0 as CategoryItemRemovedFromCategoryEnvelope, a1 as CategoryItemsArrangedInCategoryEnvelope, a2 as CategoryUpdatedEnvelope, a3 as CategoryQuery, a4 as QueryCategoriesOptions, a5 as typedQueryCategories, a6 as CategoriesQueryBuilder } from './categories-v1-category-categories.universal-DQ9i6L8H.js';
|
|
3
|
+
export { ey as ActionEvent, dg as Aggregation, du as AggregationData, dh as AggregationKindOneOf, dN as AggregationResults, dO as AggregationResultsResultOneOf, dB as AggregationResultsScalarResult, aW as AggregationType, fx as AggregationTypeWithLiterals, aB as Alignment, fc as AlignmentWithLiterals, c5 as AnchorData, cL as App, cc as AppEmbedData, cd as AppEmbedDataAppDataOneOf, aD as AppType, fe as AppTypeWithLiterals, d_ as ApplicationError, ax as AspectRatio, f8 as AspectRatioWithLiterals, cx as AudioData, bX as Background, bY as BackgroundBackgroundOneOf, cD as BackgroundImage, at as BackgroundType, f4 as BackgroundTypeWithLiterals, eD as BaseEventMetadata, cA as BlockquoteData, ce as BookingData, bb as Border, cu as BorderColors, cv as BorderWidths, b0 as Breadcrumb, a$ as BreadcrumbsInfo, d$ as BulkActionMetadata, e8 as BulkAddItemToCategoriesRequest, e5 as BulkAddItemsToCategoryRequest, dY as BulkCategoriesResult, e2 as BulkDeleteCategoriesRequest, e3 as BulkDeleteCategoriesResponse, e4 as BulkDeleteCategoriesResponseBulkCategoriesResult, e9 as BulkItemToCategoriesResult, e6 as BulkItemsToCategoryResult, eb as BulkRemoveItemFromCategoriesRequest, ea as BulkRemoveItemsFromCategoryRequest, fC as BulkSetItemCategoriesApplicationErrors, eJ as BulkSetItemCategoriesOptions, en as BulkSetItemCategoriesRequest, eo as BulkSetItemCategoriesResponse, e1 as BulkShowCategoriesRequest, dX as BulkUpdateCategoriesRequest, cz as BulletedListData, ba as ButtonData, aa as ButtonDataType, eN as ButtonDataTypeWithLiterals, cg as ButtonStyles, cB as CaptionData, cj as CardStyles, eF as CategoriesQueryResult, cQ as CategoryMoved, eG as CategoryQuerySpec, eH as CategorySearchSpec, er as CategoryTreeNode, ct as CellStyle, bm as CodeBlockData, cp as CollapsibleListData, c6 as ColorData, bc as Colors, fD as CommonQueryWithEntityContext, fE as CommonSearchWithEntityContext, dc as CompactCategory, dV as CountCategoriesRequest, cW as CreateCategoryRequest, cX as CreateCategoryResponse, aj as Crop, eW as CropWithLiterals, d6 as CursorPaging, d8 as CursorPagingMetadata, d3 as CursorQuery, d4 as CursorQueryPagingMethodOneOf, de as CursorSearch, df as CursorSearchPagingMethodOneOf, d9 as Cursors, cP as CustomTag, dp as DateHistogramAggregation, dJ as DateHistogramResult, dL as DateHistogramResults, c3 as Decoration, c4 as DecorationDataOneOf, au as DecorationType, f5 as DecorationTypeWithLiterals, d0 as DeleteCategoryRequest, d1 as DeleteCategoryResponse, dP as DeprecatedSearchCategoriesWithOffsetRequest, dT as DeprecatedSearchCategoriesWithOffsetResponse, c1 as Design, aM as DesignTarget, fn as DesignTargetWithLiterals, cr as Dimensions, aF as Direction, fg as DirectionWithLiterals, bo as DividerData, af as DividerDataAlignment, eS as DividerDataAlignmentWithLiterals, cG as DocumentStyle, es as DomainEvent, et as DomainEventBodyOneOf, cn as EmbedData, ez as Empty, eu as EntityCreatedEvent, ex as EntityDeletedEvent, ew as EntityUpdatedEvent, cf as EventData, eE as EventMetadata, cI as ExtendedFields, cO as File, bp as FileData, bq as FileSource, br as FileSourceDataOneOf, cb as FontFamilyData, c9 as FontSizeData, av as FontType, f6 as FontTypeWithLiterals, bE as GIF, bD as GIFData, al as GIFType, eY as GIFTypeWithLiterals, bt as GalleryData, bz as GalleryOptions, bA as GalleryOptionsLayout, em as GetArrangedItemsRequest, ep as GetCategoriesTreeRequest, eq as GetCategoriesTreeResponse, cY as GetCategoryRequest, cZ as GetCategoryResponse, bW as Gradient, dK as GroupByValueResults, bG as HTMLData, bH as HTMLDataDataOneOf, bF as HeadingData, bh as Height, eB as IdentificationData, eC as IdentificationDataIdOneOf, bv as Image, bI as ImageData, bK as ImageDataStyles, aJ as ImagePosition, fk as ImagePositionWithLiterals, ch as ImageStyles, aw as ImageStylesPosition, f7 as ImageStylesPositionWithLiterals, dj as IncludeMissingValuesOptions, aE as InitialExpandedItems, ff as InitialExpandedItemsWithLiterals, aV as Interval, fw as IntervalWithLiterals, cJ as InvalidateCache, cK as InvalidateCacheGetByOneOf, bx as Item, cR as ItemAddedToCategory, by as ItemDataOneOf, dZ as ItemMetadata, e7 as ItemReferenceMetadata, cT as ItemRemovedFromCategory, bB as ItemStyle, cS as ItemsAddedToCategory, cV as ItemsArrangedInCategory, cU as ItemsRemovedFromCategory, b3 as Keyword, aC as Layout, cE as LayoutCellData, cC as LayoutData, ah as LayoutType, eU as LayoutTypeWithLiterals, fd as LayoutWithLiterals, ad as LineStyle, eQ as LineStyleWithLiterals, bj as Link, c7 as LinkData, bk as LinkDataOneOf, bL as LinkPreviewData, bM as LinkPreviewDataStyles, ef as ListCategoriesForItemRequest, eg as ListCategoriesForItemsRequest, da as ListCompactCategoriesByIdsRequest, db as ListCompactCategoriesByIdsResponse, eI as ListItemsInCategoryOptionsPagingMethodOneOf, ec as ListItemsInCategoryRequest, ed as ListItemsInCategoryRequestPagingMethodOneOf, ei as ListTreesRequest, cw as ListValue, bN as MapData, eh as MapItemToCategories, bO as MapSettings, ao as MapType, e$ as MapTypeWithLiterals, bu as Media, c8 as MentionData, eA as MessageEnvelope, cF as Metadata, aS as MissingValues, ft as MissingValuesWithLiterals, aX as Mode, fy as ModeWithLiterals, dW as MoveCategoryRequest, ej as MoveItemInCategoryRequest, aZ as MoveItemInCategoryRequestPosition, fA as MoveItemInCategoryRequestPositionWithLiterals, ek as MoveItemInCategoryResponse, ds as NestedAggregation, dq as NestedAggregationItem, dr as NestedAggregationItemKindOneOf, dx as NestedAggregationResults, dy as NestedAggregationResultsResultOneOf, aU as NestedAggregationType, fv as NestedAggregationTypeWithLiterals, dG as NestedResultValue, dH as NestedResultValueResultOneOf, dM as NestedResults, dC as NestedValueAggregationResult, b7 as Node, b8 as NodeDataOneOf, b9 as NodeStyle, a7 as NodeType, eK as NodeTypeWithLiterals, aH as NullValue, fi as NullValueWithLiterals, co as Oembed, dQ as OffsetSearch, dR as OffsetSearchPagingMethodOneOf, bS as Option, b_ as OptionDesign, bV as OptionLayout, cy as OrderedListData, ai as Orientation, eV as OrientationWithLiterals, bs as PDFSettings, cM as Page, dS as Paging, dU as PagingMetadata, ee as PagingMetadataV2, bP as ParagraphData, b1 as ParentCategory, bR as Permissions, az as Placement, fa as PlacementWithLiterals, cm as PlaybackOptions, bd as PluginContainerData, a9 as PluginContainerDataAlignment, eM as PluginContainerDataAlignmentWithLiterals, be as PluginContainerDataWidth, bf as PluginContainerDataWidthDataOneOf, b$ as Poll, bQ as PollData, c0 as PollDataLayout, bZ as PollDesign, bU as PollLayout, as as PollLayoutDirection, f3 as PollLayoutDirectionWithLiterals, ar as PollLayoutType, f2 as PollLayoutTypeWithLiterals, bT as PollSettings, aY as Position, fz as PositionWithLiterals, ck as PricingData, d2 as QueryCategoriesRequest, d7 as QueryCategoriesResponse, dm as RangeAggregation, dw as RangeAggregationResult, di as RangeBucket, dE as RangeResult, dA as RangeResults, bl as Rel, aP as RequestedFields, fq as RequestedFieldsWithLiterals, ay as Resizing, f9 as ResizingWithLiterals, aL as ResponsivenessBehaviour, fm as ResponsivenessBehaviourWithLiterals, ev as RestoreInfo, dI as Results, ci as RibbonStyles, b6 as RichContent, dn as ScalarAggregation, dF as ScalarResult, aT as ScalarType, fu as ScalarTypeWithLiterals, aI as Scaling, fj as ScalingWithLiterals, dd as SearchCategoriesRequest, dt as SearchDetails, b2 as SeoSchema, el as SetArrangedItemsRequest, b5 as Settings, aN as SingleEntityOpsRequestedFields, fo as SingleEntityOpsRequestedFieldsWithLiterals, aR as SortDirection, fs as SortDirectionWithLiterals, aO as SortOrder, fp as SortOrderWithLiterals, aQ as SortType, fr as SortTypeWithLiterals, d5 as Sorting, am as Source, eZ as SourceWithLiterals, bg as Spoiler, ca as SpoilerData, bi as Styles, bJ as StylesBorder, an as StylesPosition, e_ as StylesPositionWithLiterals, cs as TableCellData, cq as TableData, b4 as Tag, ab as Target, eO as TargetWithLiterals, ac as TextAlignment, eP as TextAlignmentWithLiterals, c2 as TextData, cH as TextNodeStyle, bn as TextStyle, bC as Thumbnails, ak as ThumbnailsAlignment, eX as ThumbnailsAlignmentWithLiterals, aA as Type, fb as TypeWithLiterals, cN as URI, c_ as UpdateCategoryRequest, c$ as UpdateCategoryResponse, e0 as UpdateCategoryVisibilityRequest, dk as ValueAggregation, dl as ValueAggregationOptionsOneOf, dv as ValueAggregationResult, dD as ValueResult, dz as ValueResults, aG as VerticalAlignment, aK as VerticalAlignmentAlignment, fl as VerticalAlignmentAlignmentWithLiterals, fh as VerticalAlignmentWithLiterals, bw as Video, cl as VideoData, ag as ViewMode, eT as ViewModeWithLiterals, ap as ViewRole, f0 as ViewRoleWithLiterals, aq as VoteRole, f1 as VoteRoleWithLiterals, a_ as WebhookIdentityType, fB as WebhookIdentityTypeWithLiterals, ae as Width, a8 as WidthType, eL as WidthTypeWithLiterals, eR as WidthWithLiterals } from './categories-v1-category-categories.universal-DQ9i6L8H.js';
|
|
4
4
|
|
|
5
5
|
declare function createCategory$1(httpClient: HttpClient): CreateCategorySignature;
|
|
6
6
|
interface CreateCategorySignature {
|
|
@@ -67,18 +67,20 @@ interface SearchCategoriesSignature {
|
|
|
67
67
|
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
68
68
|
*
|
|
69
69
|
* Refer to the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
70
|
-
* or the [supported filters article](https://dev.wix.com/docs/
|
|
70
|
+
* or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST)
|
|
71
71
|
* for a complete list of supported filters and sorting options.
|
|
72
72
|
*
|
|
73
73
|
* ## See also
|
|
74
74
|
*
|
|
75
75
|
* To learn about working with *Search* methods, see
|
|
76
|
-
* [API Query Language](https://dev.wix.com/docs/
|
|
77
|
-
* and [Sorting and Paging](https://dev.wix.com/docs/
|
|
76
|
+
* [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language)
|
|
77
|
+
* and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
|
|
78
|
+
*
|
|
79
|
+
* Learn more about the differences between [_Query_ and _Search_](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-search-query-and-list-methods) methods.
|
|
78
80
|
* @param - Search criteria including filter, sort, aggregations, and paging options.
|
|
79
81
|
*
|
|
80
82
|
* Refer to the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
81
|
-
* or the [supported filters article](https://dev.wix.com/docs/
|
|
83
|
+
* or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST)
|
|
82
84
|
* for a complete list of supported filters and sorting options.
|
|
83
85
|
*/
|
|
84
86
|
(search: CategorySearch, options?: NonNullablePaths<SearchCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<SearchCategoriesResponse, `categories` | `categories.${number}.itemCounter` | `categories.${number}.seoData.settings.preventAutoRedirect` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`, 6>>;
|
|
@@ -89,7 +91,7 @@ interface CountCategoriesSignature {
|
|
|
89
91
|
* Counts the number of categories that match the provided filtering.
|
|
90
92
|
*
|
|
91
93
|
* For field support for filters and sorting,
|
|
92
|
-
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/
|
|
94
|
+
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting).
|
|
93
95
|
*/
|
|
94
96
|
(options?: NonNullablePaths<CountCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<CountCategoriesResponse, `count`, 2>>;
|
|
95
97
|
}
|