@wix/blog 1.0.151 → 1.0.153
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/src/blog-v3-category.http.d.ts +5 -5
- package/build/cjs/src/blog-v3-category.http.js +5 -5
- package/build/cjs/src/blog-v3-category.public.d.ts +1 -1
- package/build/cjs/src/blog-v3-category.types.d.ts +11 -0
- package/build/cjs/src/blog-v3-category.types.js.map +1 -1
- package/build/cjs/src/blog-v3-category.universal.d.ts +38 -10
- package/build/cjs/src/blog-v3-category.universal.js +5 -5
- package/build/cjs/src/blog-v3-category.universal.js.map +1 -1
- package/build/cjs/src/blog-v3-post.http.d.ts +5 -5
- package/build/cjs/src/blog-v3-post.http.js +5 -5
- package/build/cjs/src/blog-v3-post.public.d.ts +1 -1
- package/build/cjs/src/blog-v3-post.types.d.ts +8 -0
- package/build/cjs/src/blog-v3-post.types.js.map +1 -1
- package/build/cjs/src/blog-v3-post.universal.d.ts +37 -11
- package/build/cjs/src/blog-v3-post.universal.js +5 -5
- package/build/cjs/src/blog-v3-post.universal.js.map +1 -1
- package/build/cjs/src/blog-v3-tag.http.d.ts +5 -5
- package/build/cjs/src/blog-v3-tag.http.js +5 -5
- package/build/cjs/src/blog-v3-tag.public.d.ts +1 -1
- package/build/cjs/src/blog-v3-tag.types.d.ts +8 -0
- package/build/cjs/src/blog-v3-tag.types.js.map +1 -1
- package/build/cjs/src/blog-v3-tag.universal.d.ts +34 -9
- package/build/cjs/src/blog-v3-tag.universal.js +5 -5
- package/build/cjs/src/blog-v3-tag.universal.js.map +1 -1
- package/build/es/src/blog-v3-category.http.d.ts +5 -5
- package/build/es/src/blog-v3-category.http.js +5 -5
- package/build/es/src/blog-v3-category.public.d.ts +1 -1
- package/build/es/src/blog-v3-category.types.d.ts +11 -0
- package/build/es/src/blog-v3-category.types.js.map +1 -1
- package/build/es/src/blog-v3-category.universal.d.ts +38 -10
- package/build/es/src/blog-v3-category.universal.js +5 -5
- package/build/es/src/blog-v3-category.universal.js.map +1 -1
- package/build/es/src/blog-v3-post.http.d.ts +5 -5
- package/build/es/src/blog-v3-post.http.js +5 -5
- package/build/es/src/blog-v3-post.public.d.ts +1 -1
- package/build/es/src/blog-v3-post.types.d.ts +8 -0
- package/build/es/src/blog-v3-post.types.js.map +1 -1
- package/build/es/src/blog-v3-post.universal.d.ts +37 -11
- package/build/es/src/blog-v3-post.universal.js +5 -5
- package/build/es/src/blog-v3-post.universal.js.map +1 -1
- package/build/es/src/blog-v3-tag.http.d.ts +5 -5
- package/build/es/src/blog-v3-tag.http.js +5 -5
- package/build/es/src/blog-v3-tag.public.d.ts +1 -1
- package/build/es/src/blog-v3-tag.types.d.ts +8 -0
- package/build/es/src/blog-v3-tag.types.js.map +1 -1
- package/build/es/src/blog-v3-tag.universal.d.ts +34 -9
- package/build/es/src/blog-v3-tag.universal.js +5 -5
- package/build/es/src/blog-v3-tag.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -29,16 +29,16 @@ export declare function listCategories(payload: ListCategoriesRequest): RequestO
|
|
|
29
29
|
* Creates a query to retrieve a list of categories.
|
|
30
30
|
*
|
|
31
31
|
*
|
|
32
|
-
* 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/
|
|
32
|
+
* 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.
|
|
33
33
|
*
|
|
34
|
-
* 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/
|
|
34
|
+
* 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.
|
|
35
35
|
*
|
|
36
36
|
* 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.
|
|
37
37
|
*
|
|
38
38
|
* `queryCategories()` runs with these `CategoriesQueryBuilder` defaults, which you can override.
|
|
39
|
-
* - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
40
|
-
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
39
|
+
* - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/limit)
|
|
40
|
+
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/ascending)
|
|
41
41
|
*
|
|
42
|
-
* 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/
|
|
42
|
+
* 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).
|
|
43
43
|
*/
|
|
44
44
|
export declare function queryCategories(payload: QueryCategoriesRequest): RequestOptionsFactory<QueryCategoriesResponse>;
|
|
@@ -307,17 +307,17 @@ exports.listCategories = listCategories;
|
|
|
307
307
|
* Creates a query to retrieve a list of categories.
|
|
308
308
|
*
|
|
309
309
|
*
|
|
310
|
-
* 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/
|
|
310
|
+
* 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.
|
|
311
311
|
*
|
|
312
|
-
* 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/
|
|
312
|
+
* 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.
|
|
313
313
|
*
|
|
314
314
|
* 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.
|
|
315
315
|
*
|
|
316
316
|
* `queryCategories()` runs with these `CategoriesQueryBuilder` defaults, which you can override.
|
|
317
|
-
* - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
318
|
-
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
317
|
+
* - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/limit)
|
|
318
|
+
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/ascending)
|
|
319
319
|
*
|
|
320
|
-
* 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/
|
|
320
|
+
* 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).
|
|
321
321
|
*/
|
|
322
322
|
function queryCategories(payload) {
|
|
323
323
|
const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_queryCategoriesRequest, {});
|
|
@@ -5,4 +5,4 @@ export declare function getCategoryBySlug(httpClient: HttpClient): (slug: string
|
|
|
5
5
|
export declare function listCategories(httpClient: HttpClient): (options?: ListCategoriesOptions | undefined) => Promise<import("./blog-v3-category.universal").ListCategoriesResponse>;
|
|
6
6
|
export declare function queryCategories(httpClient: HttpClient): (options?: QueryCategoriesOptions | undefined) => import("./blog-v3-category.universal").CategoriesQueryBuilder;
|
|
7
7
|
export { Field, SortOrder } from './blog-v3-category.universal';
|
|
8
|
-
export { Category, CoverMedia, CoverMediaMediaOneOf, SeoSchema, Tag, Settings, InitialCategoriesCopied, CreateCategoryRequest, CreateCategoryResponse, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkCategoryResult, ItemMetadata, ApplicationError, BulkActionMetadata, BulkUpdateCategoriesRequest, MaskedCategory, BulkUpdateCategoriesResponse, UpdateCategoryRequest, UpdateCategoryResponse, GetCategoryRequest, GetCategoryResponse, GetCategoryBySlugRequest, GetCategoryBySlugResponse, ListCategoriesRequest, BlogPaging, ListCategoriesResponse, MetaData, QueryCategoriesRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryCategoriesResponse, PagingMetadataV2, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, GetCategoryOptions, GetCategoryBySlugOptions, ListCategoriesOptions, QueryCategoriesOptions, CategoriesQueryResult, CategoriesQueryBuilder, } from './blog-v3-category.universal';
|
|
8
|
+
export { Category, CoverMedia, CoverMediaMediaOneOf, SeoSchema, Keyword, Tag, Settings, InitialCategoriesCopied, CreateCategoryRequest, CreateCategoryResponse, BulkCreateCategoriesRequest, BulkCreateCategoriesResponse, BulkCategoryResult, ItemMetadata, ApplicationError, BulkActionMetadata, BulkUpdateCategoriesRequest, MaskedCategory, BulkUpdateCategoriesResponse, UpdateCategoryRequest, UpdateCategoryResponse, GetCategoryRequest, GetCategoryResponse, GetCategoryBySlugRequest, GetCategoryBySlugResponse, ListCategoriesRequest, BlogPaging, ListCategoriesResponse, MetaData, QueryCategoriesRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryCategoriesResponse, PagingMetadataV2, Cursors, DeleteCategoryRequest, DeleteCategoryResponse, GetCategoryOptions, GetCategoryBySlugOptions, ListCategoriesOptions, QueryCategoriesOptions, CategoriesQueryResult, CategoriesQueryBuilder, } from './blog-v3-category.universal';
|
|
@@ -149,6 +149,12 @@ export interface SeoSchema {
|
|
|
149
149
|
/** SEO general settings. */
|
|
150
150
|
settings?: Settings;
|
|
151
151
|
}
|
|
152
|
+
export interface Keyword {
|
|
153
|
+
/** Keyword value */
|
|
154
|
+
term?: string;
|
|
155
|
+
/** Whether the keyword is the main focused */
|
|
156
|
+
isMain?: boolean;
|
|
157
|
+
}
|
|
152
158
|
export interface Tag {
|
|
153
159
|
/**
|
|
154
160
|
* SEO tag type.
|
|
@@ -179,6 +185,8 @@ export interface Settings {
|
|
|
179
185
|
* Default: enabled
|
|
180
186
|
*/
|
|
181
187
|
preventAutoRedirect?: boolean;
|
|
188
|
+
/** User-selected keyword terms for a specific page */
|
|
189
|
+
keywords?: Keyword[];
|
|
182
190
|
}
|
|
183
191
|
export interface InitialCategoriesCopied {
|
|
184
192
|
/** Number of categories copied. */
|
|
@@ -245,8 +253,11 @@ export interface ItemMetadata {
|
|
|
245
253
|
error?: ApplicationError;
|
|
246
254
|
}
|
|
247
255
|
export interface ApplicationError {
|
|
256
|
+
/** Error code. */
|
|
248
257
|
code?: string;
|
|
258
|
+
/** Description of the error. */
|
|
249
259
|
description?: string;
|
|
260
|
+
/** Data related to the error. */
|
|
250
261
|
data?: Record<string, any> | null;
|
|
251
262
|
}
|
|
252
263
|
export interface BulkActionMetadata {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blog-v3-category.types.js","sourceRoot":"","sources":["../../../src/blog-v3-category.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"blog-v3-category.types.js","sourceRoot":"","sources":["../../../src/blog-v3-category.types.ts"],"names":[],"mappings":";;;AAwNA,IAAY,KAWX;AAXD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,6BAA6B;IAC7B,oBAAW,CAAA;IACX;;;OAGG;IACH,oCAA2B,CAAA;IAC3B,yBAAyB;IACzB,oBAAW,CAAA;AACb,CAAC,EAXW,KAAK,GAAL,aAAK,KAAL,aAAK,QAWhB;AAgQD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}
|
|
@@ -42,7 +42,7 @@ export interface Category {
|
|
|
42
42
|
/** Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu). Categories with lower display position are displayed first. */
|
|
43
43
|
displayPosition?: number | null;
|
|
44
44
|
/**
|
|
45
|
-
* ID of the category's translations when [Wix Multilingual](https://wix.
|
|
45
|
+
* ID of the category's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single category will share the same `translationId`.
|
|
46
46
|
* @readonly
|
|
47
47
|
*/
|
|
48
48
|
translationId?: string | null;
|
|
@@ -102,6 +102,12 @@ export interface SeoSchema {
|
|
|
102
102
|
/** SEO general settings. */
|
|
103
103
|
settings?: Settings;
|
|
104
104
|
}
|
|
105
|
+
export interface Keyword {
|
|
106
|
+
/** Keyword value */
|
|
107
|
+
term?: string;
|
|
108
|
+
/** Whether the keyword is the main focused */
|
|
109
|
+
isMain?: boolean;
|
|
110
|
+
}
|
|
105
111
|
export interface Tag {
|
|
106
112
|
/**
|
|
107
113
|
* SEO tag type.
|
|
@@ -132,6 +138,8 @@ export interface Settings {
|
|
|
132
138
|
* Default: enabled
|
|
133
139
|
*/
|
|
134
140
|
preventAutoRedirect?: boolean;
|
|
141
|
+
/** User-selected keyword terms for a specific page */
|
|
142
|
+
keywords?: Keyword[];
|
|
135
143
|
}
|
|
136
144
|
export interface InitialCategoriesCopied {
|
|
137
145
|
/** Number of categories copied. */
|
|
@@ -198,8 +206,11 @@ export interface ItemMetadata {
|
|
|
198
206
|
error?: ApplicationError;
|
|
199
207
|
}
|
|
200
208
|
export interface ApplicationError {
|
|
209
|
+
/** Error code. */
|
|
201
210
|
code?: string;
|
|
211
|
+
/** Description of the error. */
|
|
202
212
|
description?: string;
|
|
213
|
+
/** Data related to the error. */
|
|
203
214
|
data?: Record<string, any> | null;
|
|
204
215
|
}
|
|
205
216
|
export interface BulkActionMetadata {
|
|
@@ -550,17 +561,17 @@ export interface ListCategoriesOptions {
|
|
|
550
561
|
* Creates a query to retrieve a list of categories.
|
|
551
562
|
*
|
|
552
563
|
*
|
|
553
|
-
* 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/
|
|
564
|
+
* 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.
|
|
554
565
|
*
|
|
555
|
-
* 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/
|
|
566
|
+
* 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.
|
|
556
567
|
*
|
|
557
568
|
* 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.
|
|
558
569
|
*
|
|
559
570
|
* `queryCategories()` runs with these `CategoriesQueryBuilder` defaults, which you can override.
|
|
560
|
-
* - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
561
|
-
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
571
|
+
* - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/limit)
|
|
572
|
+
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/ascending)
|
|
562
573
|
*
|
|
563
|
-
* 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/
|
|
574
|
+
* 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).
|
|
564
575
|
* @public
|
|
565
576
|
* @documentationMaturity preview
|
|
566
577
|
* @param options - Options specifying which fields to return.
|
|
@@ -601,44 +612,61 @@ export interface CategoriesQueryResult extends QueryOffsetResult {
|
|
|
601
612
|
export interface CategoriesQueryBuilder {
|
|
602
613
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
603
614
|
* @param value - Value to compare against.
|
|
615
|
+
* @documentationMaturity preview
|
|
604
616
|
*/
|
|
605
617
|
eq: (propertyName: string, value: any) => CategoriesQueryBuilder;
|
|
606
618
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
607
619
|
* @param value - Value to compare against.
|
|
620
|
+
* @documentationMaturity preview
|
|
608
621
|
*/
|
|
609
622
|
ne: (propertyName: string, value: any) => CategoriesQueryBuilder;
|
|
610
623
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
611
624
|
* @param value - Value to compare against.
|
|
625
|
+
* @documentationMaturity preview
|
|
612
626
|
*/
|
|
613
627
|
ge: (propertyName: string, value: any) => CategoriesQueryBuilder;
|
|
614
628
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
615
629
|
* @param value - Value to compare against.
|
|
630
|
+
* @documentationMaturity preview
|
|
616
631
|
*/
|
|
617
632
|
gt: (propertyName: string, value: any) => CategoriesQueryBuilder;
|
|
618
633
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
619
634
|
* @param value - Value to compare against.
|
|
635
|
+
* @documentationMaturity preview
|
|
620
636
|
*/
|
|
621
637
|
le: (propertyName: string, value: any) => CategoriesQueryBuilder;
|
|
622
638
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
623
639
|
* @param value - Value to compare against.
|
|
640
|
+
* @documentationMaturity preview
|
|
624
641
|
*/
|
|
625
642
|
lt: (propertyName: string, value: any) => CategoriesQueryBuilder;
|
|
626
643
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
627
644
|
* @param string - String to compare against. Case-insensitive.
|
|
645
|
+
* @documentationMaturity preview
|
|
628
646
|
*/
|
|
629
647
|
startsWith: (propertyName: string, value: string) => CategoriesQueryBuilder;
|
|
630
648
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
631
649
|
* @param values - List of values to compare against.
|
|
650
|
+
* @documentationMaturity preview
|
|
632
651
|
*/
|
|
633
652
|
hasSome: (propertyName: string, value: any[]) => CategoriesQueryBuilder;
|
|
634
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
653
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
654
|
+
* @documentationMaturity preview
|
|
655
|
+
*/
|
|
635
656
|
ascending: (...propertyNames: string[]) => CategoriesQueryBuilder;
|
|
636
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
657
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
658
|
+
* @documentationMaturity preview
|
|
659
|
+
*/
|
|
637
660
|
descending: (...propertyNames: string[]) => CategoriesQueryBuilder;
|
|
638
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
661
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
662
|
+
* @documentationMaturity preview
|
|
663
|
+
*/
|
|
639
664
|
limit: (limit: number) => CategoriesQueryBuilder;
|
|
640
|
-
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
665
|
+
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
666
|
+
* @documentationMaturity preview
|
|
667
|
+
*/
|
|
641
668
|
skip: (skip: number) => CategoriesQueryBuilder;
|
|
669
|
+
/** @documentationMaturity preview */
|
|
642
670
|
find: () => Promise<CategoriesQueryResult>;
|
|
643
671
|
}
|
|
644
672
|
export {};
|
|
@@ -268,17 +268,17 @@ exports.listCategories = listCategories;
|
|
|
268
268
|
* Creates a query to retrieve a list of categories.
|
|
269
269
|
*
|
|
270
270
|
*
|
|
271
|
-
* 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/
|
|
271
|
+
* 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.
|
|
272
272
|
*
|
|
273
|
-
* 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/
|
|
273
|
+
* 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.
|
|
274
274
|
*
|
|
275
275
|
* 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.
|
|
276
276
|
*
|
|
277
277
|
* `queryCategories()` runs with these `CategoriesQueryBuilder` defaults, which you can override.
|
|
278
|
-
* - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
279
|
-
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
278
|
+
* - [`limit(100)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/limit)
|
|
279
|
+
* - [`ascending(displayPosition)`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesquerybuilder/ascending)
|
|
280
280
|
*
|
|
281
|
-
* 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/
|
|
281
|
+
* 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).
|
|
282
282
|
* @public
|
|
283
283
|
* @documentationMaturity preview
|
|
284
284
|
* @param options - Options specifying which fields to return.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blog-v3-category.universal.js","sourceRoot":"","sources":["../../../src/blog-v3-category.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,qFAAuE;AACvE,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;
|
|
1
|
+
{"version":3,"file":"blog-v3-category.universal.js","sourceRoot":"","sources":["../../../src/blog-v3-category.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,qFAAuE;AACvE,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAkK5B,IAAY,KAWX;AAXD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,6BAA6B;IAC7B,oBAAW,CAAA;IACX;;;OAGG;IACH,oCAA2B,CAAA;IAC3B,yBAAyB;IACzB,oBAAW,CAAA;AACb,CAAC,EAXW,KAAK,GAAL,aAAK,KAAL,aAAK,QAWhB;AA4PD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AA4FD,MAAM,SAAS,GAAG;IAChB,GAAG,EAAE,oBAAoB;IACzB,UAAU,EAAE,kBAAkB;IAC9B,UAAU,EAAE,aAAa;CAC1B,CAAC;AACF,MAAM,WAAW,GAAG,EAAE,KAAK,EAAE,kBAAkB,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;AAC7E,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAC7D,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACvD,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;AAC5D,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,wBAAwB,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;AAE7D;;;;;;;;;;;GAWG;AACH,SAAsB,WAAW,CAC/B,UAAkB,EAClB,OAA4B;;;QAE5B,MAAM,qBAAqB,GAAG;YAC5B,UAAU,EAAE,MAAM;YAClB,eAAe,EAAE,sBAAsB;YACvC,SAAS,EAAE,gBAAgB;SAC5B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;YACzC,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;YAC9B,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE;YACtC,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACxB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAG,2BAA2B,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEjE,KAAK,CAAC,uCAAuC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEnE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,YAAY;gBACZ,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA1DD,kCA0DC;AAcD;;;;;;;;;;;;;;;;GAgBG;AACH,SAAsB,iBAAiB,CACrC,IAAY,EACZ,OAAkC;;;QAElC,MAAM,qBAAqB,GAAG;YAC5B,IAAI,EAAE,MAAM;YACZ,eAAe,EAAE,sBAAsB;YACvC,SAAS,EAAE,gBAAgB;SAC5B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;YACzC,UAAU,EAAE,yBAAyB;YACrC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;YAC9B,UAAU,EAAE,0BAA0B;YACtC,UAAU,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE;YACtC,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACxB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAErD,MAAM,OAAO,GAAG,2BAA2B,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAEvE,KAAK,CAAC,6CAA6C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEzE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,MAAM;gBACN,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA1DD,8CA0DC;AAcD;;;;;;;;GAQG;AACH,SAAsB,cAAc,CAClC,OAA+B;;;QAE/B,MAAM,qBAAqB,GAAG;YAC5B,MAAM,EAAE,aAAa;YACrB,eAAe,EAAE,sBAAsB;YACvC,SAAS,EAAE,gBAAgB;SAC5B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;YACzC,UAAU,EAAE,sBAAsB;YAClC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;YAC9B,UAAU,EAAE,uBAAuB;YACnC,UAAU,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE;YACtC,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAChC,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAE/C,MAAM,OAAO,GAAG,2BAA2B,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEpE,KAAK,CAAC,0CAA0C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEtE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAxDD,wCAwDC;AAgBD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,eAAe,CAC7B,OAAgC;IAEhC,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC7D,MAAM,sBAAsB,GAAG;QAC7B,KAAK,EAAE,cAAc;QACrB,cAAc,EAAE,kBAAkB;KACnC,CAAC;IAEF,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;QACzC,UAAU,EAAE,uBAAuB;QACnC,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,EAAE;YACT,cAAc,EAAE,eAAe;SAChC;QACD,oBAAoB,EAAE,qBAAqB;KAC5C,CAAC,CAAC;IAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;QAC9B,UAAU,EAAE,wBAAwB;QACpC,UAAU,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE;QACtC,kBAAkB,EAAE;YAClB,KAAK,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAChC,cAAc,EAAE,aAAa;SAC9B;QACD,oBAAoB,EAAE,sBAAsB;KAC7C,CAAC,CAAC;IAEH,OAAO,uDAAoB,CAAC;QAC1B,IAAI,EAAE,CAAO,OAAY,EAAE,EAAE;;YAC3B,MAAM,OAAO,GAAG,2BAA2B,CAAC,eAAe,iCACtD,OAAO,GACP,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,EAClB,CAAC;YAEH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;YAC5B,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;aACf;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;aACX;QACH,CAAC,CAAA;QACD,kBAAkB,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC;QACjE,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtD,gBAAgB,EAAE,CAAC,GAAQ,EAAE,EAAE;YAC7B,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;YAEpE,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,4CAAqC,CAAC,aAAa,CAAC;KAC1E,CAAC,CAAC,EAAE,4BAA4B,EAAE,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AA9DD,0CA8DC"}
|
|
@@ -32,21 +32,21 @@ export declare function listPosts(payload: ListPostsRequest): RequestOptionsFact
|
|
|
32
32
|
* Creates a query to retrieve a list of posts.
|
|
33
33
|
*
|
|
34
34
|
*
|
|
35
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
35
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder) object.
|
|
36
36
|
*
|
|
37
|
-
* 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/
|
|
37
|
+
* 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/posts/postsquerybuilder/find) function.
|
|
38
38
|
*
|
|
39
39
|
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
40
40
|
*
|
|
41
41
|
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that can be overridden:
|
|
42
|
-
* + `limit(50)`
|
|
43
|
-
* + `descending('firstPublishedDate')`
|
|
42
|
+
* + [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/limit)
|
|
43
|
+
* + [`descending('firstPublishedDate')`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/descending)
|
|
44
44
|
*
|
|
45
45
|
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
46
46
|
*
|
|
47
47
|
* To learn how to query posts, refer to the table below.
|
|
48
48
|
*
|
|
49
|
-
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult
|
|
49
|
+
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult/items) property in [`PostsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult).
|
|
50
50
|
*/
|
|
51
51
|
export declare function queryPosts(payload: QueryPostsRequest): RequestOptionsFactory<QueryPostsResponse>;
|
|
52
52
|
/**
|
|
@@ -677,21 +677,21 @@ exports.listPosts = listPosts;
|
|
|
677
677
|
* Creates a query to retrieve a list of posts.
|
|
678
678
|
*
|
|
679
679
|
*
|
|
680
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
680
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder) object.
|
|
681
681
|
*
|
|
682
|
-
* 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/
|
|
682
|
+
* 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/posts/postsquerybuilder/find) function.
|
|
683
683
|
*
|
|
684
684
|
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
685
685
|
*
|
|
686
686
|
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that can be overridden:
|
|
687
|
-
* + `limit(50)`
|
|
688
|
-
* + `descending('firstPublishedDate')`
|
|
687
|
+
* + [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/limit)
|
|
688
|
+
* + [`descending('firstPublishedDate')`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/descending)
|
|
689
689
|
*
|
|
690
690
|
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
691
691
|
*
|
|
692
692
|
* To learn how to query posts, refer to the table below.
|
|
693
693
|
*
|
|
694
|
-
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult
|
|
694
|
+
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult/items) property in [`PostsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult).
|
|
695
695
|
*/
|
|
696
696
|
function queryPosts(payload) {
|
|
697
697
|
const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_queryPostsRequest, {});
|
|
@@ -8,4 +8,4 @@ export declare function getPostMetrics(httpClient: HttpClient): (postId: string)
|
|
|
8
8
|
export declare function queryPostCountStats(httpClient: HttpClient): (options?: QueryPostCountStatsOptions | undefined) => Promise<import("./blog-v3-post.universal").QueryPostCountStatsResponse>;
|
|
9
9
|
export declare function getTotalPosts(httpClient: HttpClient): (options?: GetTotalPostsOptions | undefined) => Promise<import("./blog-v3-post.universal").GetTotalPostsResponse>;
|
|
10
10
|
export { NodeType, WidthType, PluginContainerDataAlignment, Type, Target, TextAlignment, LineStyle, Width, Alignment, ViewMode, LayoutType, Orientation, Crop, ThumbnailsAlignment, Source, MapType, ViewRole, VoteRole, PollLayoutType, PollLayoutDirection, BackgroundType, DecorationType, FontType, AppType, InitialExpandedItems, Direction, VerticalAlignment, NullValue, ModerationStatusStatus, GetPostTemplatesSort, Origin, Status, Field, PostFieldField, GetPostsSort, SortOrder, QueryPublicationsCountStatsRequestOrder, Order, } from './blog-v3-post.universal';
|
|
11
|
-
export { Post, CoverMedia, CoverMediaMediaOneOf, PostCountInfo, Metrics, SeoSchema, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, LinkPreviewData, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, OldBlogMigratedEvent, ListMigratedPostsRequest, BlogCursorPaging, ListMigratedPostsResponse, PostMigrationMetaData, CursorMetaData, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, SendActionEventRequest, SendActionEventRequestActionOneOf, SendActionEventResponse, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, QueryPostCountStatsOptions, GetTotalPostsOptions, } from './blog-v3-post.universal';
|
|
11
|
+
export { Post, CoverMedia, CoverMediaMediaOneOf, PostCountInfo, Metrics, SeoSchema, Keyword, Tag, Settings, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, V1Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, LinkPreviewData, MapData, MapSettings, ParagraphData, PollData, Permissions, Option, PollSettings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, Metadata, DocumentStyle, TextNodeStyle, ModerationDetails, Media, MediaMediaOneOf, WixMedia, VideoResolution, EmbedMedia, EmbedThumbnail, EmbedVideo, ListTemplatesRequest, BlogPaging, ListTemplatesResponse, MetaData, Category, GetTemplateRequest, GetTemplateResponse, CreateDraftPostFromTemplateRequest, CreateDraftPostFromTemplateResponse, DraftPost, DraftPostTranslation, GetTotalLikesPerMemberRequest, GetTotalLikesPerMemberResponse, PostLiked, PostLikedInitiatorOneOf, PostUnliked, PostUnlikedInitiatorOneOf, PostCountersUpdated, PostCountersUpdatedInitiatorOneOf, PostOwnerChanged, InitialPostsCopied, GetPostRequest, GetPostResponse, GetPostBySlugRequest, GetPostBySlugResponse, ListPostsRequest, ListPostsResponse, QueryPostsRequest, Sorting, PlatformQuery, PlatformQueryPagingMethodOneOf, Paging, CursorPaging, QueryPostsResponse, PagingMetadataV2, Cursors, GetPostMetricsRequest, GetPostMetricsResponse, BulkGetPostMetricsRequest, BulkGetPostMetricsResponse, BulkGetPostReactionsRequest, BulkGetPostReactionsResponse, Reactions, OldBlogMigratedEvent, ListMigratedPostsRequest, BlogCursorPaging, ListMigratedPostsResponse, PostMigrationMetaData, CursorMetaData, QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsResponse, PeriodPublicationsCount, QueryPostCountStatsRequest, QueryPostCountStatsResponse, PeriodPostCount, GetTotalPublicationsRequest, GetTotalPublicationsResponse, GetTotalPostsRequest, GetTotalPostsResponse, SendActionEventRequest, SendActionEventRequestActionOneOf, SendActionEventResponse, GetPostOptions, GetPostBySlugOptions, ListPostsOptions, QueryPostsOptions, PostsQueryResult, PostsQueryBuilder, QueryPostCountStatsOptions, GetTotalPostsOptions, } from './blog-v3-post.universal';
|
|
@@ -237,6 +237,12 @@ export interface SeoSchema {
|
|
|
237
237
|
/** SEO general settings. */
|
|
238
238
|
settings?: Settings;
|
|
239
239
|
}
|
|
240
|
+
export interface Keyword {
|
|
241
|
+
/** Keyword value */
|
|
242
|
+
term?: string;
|
|
243
|
+
/** Whether the keyword is the main focused */
|
|
244
|
+
isMain?: boolean;
|
|
245
|
+
}
|
|
240
246
|
export interface Tag {
|
|
241
247
|
/**
|
|
242
248
|
* SEO tag type.
|
|
@@ -267,6 +273,8 @@ export interface Settings {
|
|
|
267
273
|
* Default: enabled
|
|
268
274
|
*/
|
|
269
275
|
preventAutoRedirect?: boolean;
|
|
276
|
+
/** User-selected keyword terms for a specific page */
|
|
277
|
+
keywords?: Keyword[];
|
|
270
278
|
}
|
|
271
279
|
export interface RichContent {
|
|
272
280
|
/** Node objects representing a rich content document. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blog-v3-post.types.js","sourceRoot":"","sources":["../../../src/blog-v3-post.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"blog-v3-post.types.js","sourceRoot":"","sources":["../../../src/blog-v3-post.types.ts"],"names":[],"mappings":";;;AA8ZA,IAAY,QA+BX;AA/BD,WAAY,QAAQ;IAClB,mCAAuB,CAAA;IACvB,yBAAa,CAAA;IACb,+BAAmB,CAAA;IACnB,2CAA+B,CAAA;IAC/B,yCAA6B,CAAA;IAC7B,mCAAuB,CAAA;IACvB,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,2BAAe,CAAA;IACf,+BAAmB,CAAA;IACnB,yBAAa,CAAA;IACb,+BAAmB,CAAA;IACnB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,yCAA6B,CAAA;IAC7B,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,mCAAuB,CAAA;IACvB,6BAAiB,CAAA;IACjB,iDAAqC,CAAA;IACrC,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,iDAAqC,CAAA;IACrC,6DAAiD,CAAA;IACjD,2DAA+C,CAAA;IAC/C,qCAAyB,CAAA;IACzB,mCAAuB,CAAA;IACvB,iCAAqB,CAAA;IACrB,2BAAe,CAAA;AACjB,CAAC,EA/BW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA+BnB;AAqDD,IAAY,SASX;AATD,WAAY,SAAS;IACnB,sCAAsC;IACtC,gCAAmB,CAAA;IACnB,kBAAkB;IAClB,4BAAe,CAAA;IACf,gDAAgD;IAChD,kCAAqB,CAAA;IACrB,6BAA6B;IAC7B,sCAAyB,CAAA;AAC3B,CAAC,EATW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASpB;AA8BD,IAAY,4BAOX;AAPD,WAAY,4BAA4B;IACtC,uBAAuB;IACvB,iDAAiB,CAAA;IACjB,qBAAqB;IACrB,6CAAa,CAAA;IACb,sBAAsB;IACtB,+CAAe,CAAA;AACjB,CAAC,EAPW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAOvC;AAgBD,IAAY,IAKX;AALD,WAAY,IAAI;IACd,0BAA0B;IAC1B,qBAAa,CAAA;IACb,qFAAqF;IACrF,yBAAiB,CAAA;AACnB,CAAC,EALW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAKf;AAoCD,IAAY,MASX;AATD,WAAY,MAAM;IAChB,sFAAsF;IACtF,uBAAa,CAAA;IACb,uDAAuD;IACvD,yBAAe,CAAA;IACf,oDAAoD;IACpD,2BAAiB,CAAA;IACjB,+DAA+D;IAC/D,qBAAW,CAAA;AACb,CAAC,EATW,MAAM,GAAN,cAAM,KAAN,cAAM,QASjB;AAyBD,IAAY,aAWX;AAXD,WAAY,aAAa;IACvB,8CAA8C;IAC9C,8BAAa,CAAA;IACb,iBAAiB;IACjB,8BAAa,CAAA;IACb,kBAAkB;IAClB,gCAAe,CAAA;IACf,mBAAmB;IACnB,kCAAiB,CAAA;IACjB,+HAA+H;IAC/H,oCAAmB,CAAA;AACrB,CAAC,EAXW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAWxB;AAaD,IAAY,SASX;AATD,WAAY,SAAS;IACnB,kBAAkB;IAClB,8BAAiB,CAAA;IACjB,kBAAkB;IAClB,8BAAiB,CAAA;IACjB,kBAAkB;IAClB,8BAAiB,CAAA;IACjB,kBAAkB;IAClB,8BAAiB,CAAA;AACnB,CAAC,EATW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QASpB;AAED,IAAY,KAOX;AAPD,WAAY,KAAK;IACf,iBAAiB;IACjB,wBAAe,CAAA;IACf,kBAAkB;IAClB,0BAAiB,CAAA;IACjB,iBAAiB;IACjB,wBAAe,CAAA;AACjB,CAAC,EAPW,KAAK,GAAL,aAAK,KAAL,aAAK,QAOhB;AAED,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,uBAAuB;IACvB,8BAAiB,CAAA;IACjB,qBAAqB;IACrB,0BAAa,CAAA;IACb,sBAAsB;IACtB,4BAAe,CAAA;AACjB,CAAC,EAPW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAOpB;AAqBD,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,kBAAkB;IAClB,yBAAa,CAAA;IACb,oBAAoB;IACpB,yBAAa,CAAA;IACb,oBAAoB;IACpB,yBAAa,CAAA;AACf,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAuGD,IAAY,UAqBX;AArBD,WAAY,UAAU;IACpB,mBAAmB;IACnB,iCAAmB,CAAA;IACnB,mBAAmB;IACnB,iCAAmB,CAAA;IACnB,gBAAgB;IAChB,2BAAa,CAAA;IACb,qBAAqB;IACrB,qCAAuB,CAAA;IACvB,kBAAkB;IAClB,+BAAiB,CAAA;IACjB,qBAAqB;IACrB,qCAAuB,CAAA;IACvB,oBAAoB;IACpB,mCAAqB,CAAA;IACrB,kBAAkB;IAClB,+BAAiB,CAAA;IACjB,iBAAiB;IACjB,6BAAe,CAAA;IACf,2BAA2B;IAC3B,mCAAqB,CAAA;AACvB,CAAC,EArBW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAqBrB;AAED,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,uBAAuB;IACvB,4BAAa,CAAA;IACb,0BAA0B;IAC1B,kCAAmB,CAAA;AACrB,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAED,IAAY,IAKX;AALD,WAAY,IAAI;IACd,mBAAmB;IACnB,qBAAa,CAAA;IACb,kBAAkB;IAClB,mBAAW,CAAA;AACb,CAAC,EALW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAKf;AAED,IAAY,mBAWX;AAXD,WAAY,mBAAmB;IAC7B,oBAAoB;IACpB,kCAAW,CAAA;IACX,sBAAsB;IACtB,sCAAe,CAAA;IACf,uBAAuB;IACvB,wCAAiB,CAAA;IACjB,qBAAqB;IACrB,oCAAa,CAAA;IACb,mBAAmB;IACnB,oCAAa,CAAA;AACf,CAAC,EAXW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAW9B;AAuFD,IAAY,MAGX;AAHD,WAAY,MAAM;IAChB,uBAAa,CAAA;IACb,6BAAmB,CAAA;AACrB,CAAC,EAHW,MAAM,GAAN,cAAM,KAAN,cAAM,QAGjB;AAkED,IAAY,OASX;AATD,WAAY,OAAO;IACjB,uBAAuB;IACvB,8BAAmB,CAAA;IACnB,yBAAyB;IACzB,gCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAiB,CAAA;IACjB,uBAAuB;IACvB,8BAAmB,CAAA;AACrB,CAAC,EATW,OAAO,GAAP,eAAO,KAAP,eAAO,QASlB;AAoBD,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,6CAA6C;IAC7C,+BAAmB,CAAA;IACnB,2CAA2C;IAC3C,6BAAiB,CAAA;IACjB,0DAA0D;IAC1D,iCAAqB,CAAA;AACvB,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAED,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,uBAAuB;IACvB,yCAA6B,CAAA;IAC7B,aAAa;IACb,uBAAW,CAAA;AACb,CAAC,EALW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAKnB;AA6BD,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,WAAW;IACX,+BAAa,CAAA;IACb,WAAW;IACX,+BAAa,CAAA;AACf,CAAC,EALW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAKzB;AAED,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,oBAAoB;IACpB,kCAAW,CAAA;IACX,oBAAoB;IACpB,kCAAW,CAAA;AACb,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B;AAgBD,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,4BAA4B;IAC5B,iCAAe,CAAA;IACf,4BAA4B;IAC5B,iCAAe,CAAA;IACf,+BAA+B;IAC/B,uCAAqB,CAAA;AACvB,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB;AA0HD,IAAY,cAWX;AAXD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,mCAAiB,CAAA;IACjB,yCAAuB,CAAA;IACvB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;IACjB,qCAAmB,CAAA;IACnB,+BAAa,CAAA;IACb,iCAAe,CAAA;IACf,yCAAuB,CAAA;IACvB,uCAAqB,CAAA;AACvB,CAAC,EAXW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAWzB;AAmCD,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,qBAAS,CAAA;IACT,qBAAS,CAAA;AACX,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB;AA6BD,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,0BAAe,CAAA;IACf,8BAAmB,CAAA;AACrB,CAAC,EAJW,OAAO,GAAP,eAAO,KAAP,eAAO,QAIlB;AA6FD,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,2CAA2C;IAC3C,uCAAe,CAAA;IACf,uCAAuC;IACvC,mCAAW,CAAA;IACX,mCAAmC;IACnC,qCAAa,CAAA;AACf,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B;AAED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oBAAoB;IACpB,wBAAW,CAAA;IACX,oBAAoB;IACpB,wBAAW,CAAA;AACb,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AA+BD,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,oBAAoB;IACpB,gCAAW,CAAA;IACX,uBAAuB;IACvB,sCAAiB,CAAA;IACjB,uBAAuB;IACvB,sCAAiB,CAAA;AACnB,CAAC,EAPW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAO5B;AAoBD;;;;;GAKG;AACH,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,kBAAkB;IAClB,sCAAyB,CAAA;AAC3B,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAqGD,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;IACnB,+CAAqB,CAAA;IACrB,+CAAqB,CAAA;AACvB,CAAC,EAJW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAIjC;AA4FD,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,2CAA2C;IAC3C,iEAAyC,CAAA;IACzC,4CAA4C;IAC5C,mEAA2C,CAAA;AAC7C,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAmQD,IAAY,MAkEX;AAlED,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,uBAAuB;IACvB,yBAAe,CAAA;IACf,8BAA8B;IAC9B,2CAAiC,CAAA;IACjC,0BAA0B;IAC1B,iCAAuB,CAAA;IACvB,2BAA2B;IAC3B,yCAA+B,CAAA;IAC/B,eAAe;IACf,2BAAiB,CAAA;IACjB,uBAAuB;IACvB,qCAA2B,CAAA;IAC3B,gCAAgC;IAChC,qCAA2B,CAAA;IAC3B,mBAAmB;IACnB,uCAA6B,CAAA;IAC7B,uBAAuB;IACvB,6CAAmC,CAAA;IACnC,qBAAqB;IACrB,qCAA2B,CAAA;IAC3B,4BAA4B;IAC5B,iCAAuB,CAAA;IACvB,6BAA6B;IAC7B,mCAAyB,CAAA;IACzB,qBAAqB;IACrB,yCAA+B,CAAA;IAC/B,iCAAiC;IACjC,uDAA6C,CAAA;IAC7C,sBAAsB;IACtB,iCAAuB,CAAA;IACvB,oBAAoB;IACpB,6BAAmB,CAAA;IACnB,2BAA2B;IAC3B,2CAAiC,CAAA;IACjC,oBAAoB;IACpB,2BAAiB,CAAA;IACjB,mBAAmB;IACnB,6BAAmB,CAAA;IACnB,wBAAwB;IACxB,6CAAmC,CAAA;IACnC,qBAAqB;IACrB,qCAA2B,CAAA;IAC3B,sBAAsB;IACtB,iCAAuB,CAAA;IACvB,sBAAsB;IACtB,mCAAyB,CAAA;IACzB,mEAAmE;IACnE,+CAAqC,CAAA;IACrC,6BAA6B;IAC7B,qEAA2D,CAAA;IAC3D,+BAA+B;IAC/B,yEAA+D,CAAA;IAC/D,6BAA6B;IAC7B,mEAAyD,CAAA;IACzD,oBAAoB;IACpB,+BAAqB,CAAA;IACrB,kCAAkC;IAClC,2DAAiD,CAAA;IACjD,mCAAmC;IACnC,2DAAiD,CAAA;IACjD,iCAAiC;IACjC,yDAA+C,CAAA;IAC/C,sBAAsB;IACtB,mCAAyB,CAAA;AAC3B,CAAC,EAlEW,MAAM,GAAN,cAAM,KAAN,cAAM,QAkEjB;AAED,IAAY,MAkBX;AAlBD,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,qDAAqD;IACrD,iCAAuB,CAAA;IACvB,uDAAuD;IACvD,qCAA2B,CAAA;IAC3B,qEAAqE;IACrE,iCAAuB,CAAA;IACvB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB;;;;OAIG;IACH,yCAA+B,CAAA;IAC/B,qDAAqD;IACrD,iCAAuB,CAAA;AACzB,CAAC,EAlBW,MAAM,GAAN,cAAM,KAAN,cAAM,QAkBjB;AAkFD,IAAY,KAUX;AAVD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAA4B;IAC5B,0CAAiC,CAAA;IACjC,wBAAwB;IACxB,kCAAyB,CAAA;IACzB,wBAAwB;IACxB,kCAAyB,CAAA;IACzB,yBAAyB;IACzB,sCAA6B,CAAA;AAC/B,CAAC,EAVW,KAAK,GAAL,aAAK,KAAL,aAAK,QAUhB;AA2BD,IAAY,cA0BX;AA1BD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,uCAAuC;IACvC,uCAAqB,CAAA;IACrB,qCAAqC;IACrC,6BAAW,CAAA;IACX,qDAAqD;IACrD,+CAA6B,CAAA;IAC7B,yCAAyC;IACzC,qCAAmB,CAAA;IACnB,wBAAwB;IACxB,6BAAW,CAAA;IACX;;;OAGG;IACH,qCAAmB,CAAA;IACnB;;;OAGG;IACH,6CAA2B,CAAA;IAC3B,sCAAsC;IACtC,2CAAyB,CAAA;IACzB,iCAAiC;IACjC,+CAA6B,CAAA;AAC/B,CAAC,EA1BW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QA0BzB;AAoGD,IAAY,YAiBX;AAjBD,WAAY,YAAY;IACtB,uFAAuF;IACvF,6BAAa,CAAA;IACb,2CAA2C;IAC3C,yDAAyC,CAAA;IACzC,4CAA4C;IAC5C,2DAA2C,CAAA;IAC3C,uCAAuC;IACvC,yCAAyB,CAAA;IACzB,uCAAuC;IACvC,yCAAyB,CAAA;IACzB,iCAAiC;IACjC,uCAAuB,CAAA;IACvB,kCAAkC;IAClC,yCAAyB,CAAA;IACzB,yCAAyC;IACzC,iCAAiB,CAAA;AACnB,CAAC,EAjBW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAiBvB;AAuDD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AA6LD,IAAY,uCAIX;AAJD,WAAY,uCAAuC;IACjD,8DAAmB,CAAA;IACnB,4DAAiB,CAAA;IACjB,4DAAiB,CAAA;AACnB,CAAC,EAJW,uCAAuC,GAAvC,+CAAuC,KAAvC,+CAAuC,QAIlD;AAqDD,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,0BAAiB,CAAA;IACjB,0BAAiB,CAAA;AACnB,CAAC,EAJW,KAAK,GAAL,aAAK,KAAL,aAAK,QAIhB"}
|
|
@@ -46,7 +46,7 @@ export interface Post {
|
|
|
46
46
|
/** Whether the post is pinned. If `true`, the post is placed at the top of the post list. */
|
|
47
47
|
pinned?: boolean;
|
|
48
48
|
/**
|
|
49
|
-
* [Category IDs](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
49
|
+
* [Category IDs](https://www.wix.com/velo/reference/wix-blog-backend/categories) of the post.
|
|
50
50
|
*
|
|
51
51
|
*/
|
|
52
52
|
categoryIds?: string[];
|
|
@@ -216,6 +216,12 @@ export interface SeoSchema {
|
|
|
216
216
|
/** SEO general settings. */
|
|
217
217
|
settings?: Settings;
|
|
218
218
|
}
|
|
219
|
+
export interface Keyword {
|
|
220
|
+
/** Keyword value */
|
|
221
|
+
term?: string;
|
|
222
|
+
/** Whether the keyword is the main focused */
|
|
223
|
+
isMain?: boolean;
|
|
224
|
+
}
|
|
219
225
|
export interface Tag {
|
|
220
226
|
/**
|
|
221
227
|
* SEO tag type.
|
|
@@ -246,6 +252,8 @@ export interface Settings {
|
|
|
246
252
|
* Default: enabled
|
|
247
253
|
*/
|
|
248
254
|
preventAutoRedirect?: boolean;
|
|
255
|
+
/** User-selected keyword terms for a specific page */
|
|
256
|
+
keywords?: Keyword[];
|
|
249
257
|
}
|
|
250
258
|
export interface RichContent {
|
|
251
259
|
/** Node objects representing a rich content document. */
|
|
@@ -2495,7 +2503,7 @@ export interface ListPostsOptions {
|
|
|
2495
2503
|
*/
|
|
2496
2504
|
categoryIds?: string[];
|
|
2497
2505
|
/**
|
|
2498
|
-
* List of tag IDs to filter for.
|
|
2506
|
+
* List of [tag IDs](https://www.wix.com/velo/reference/wix-blog-backend/tags) to filter for.
|
|
2499
2507
|
*
|
|
2500
2508
|
*
|
|
2501
2509
|
* Default: All tags
|
|
@@ -2545,21 +2553,21 @@ export interface ListPostsOptions {
|
|
|
2545
2553
|
* Creates a query to retrieve a list of posts.
|
|
2546
2554
|
*
|
|
2547
2555
|
*
|
|
2548
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
2556
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder) object.
|
|
2549
2557
|
*
|
|
2550
|
-
* 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/
|
|
2558
|
+
* 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/posts/postsquerybuilder/find) function.
|
|
2551
2559
|
*
|
|
2552
2560
|
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
2553
2561
|
*
|
|
2554
2562
|
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that can be overridden:
|
|
2555
|
-
* + `limit(50)`
|
|
2556
|
-
* + `descending('firstPublishedDate')`
|
|
2563
|
+
* + [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/limit)
|
|
2564
|
+
* + [`descending('firstPublishedDate')`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/descending)
|
|
2557
2565
|
*
|
|
2558
2566
|
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
2559
2567
|
*
|
|
2560
2568
|
* To learn how to query posts, refer to the table below.
|
|
2561
2569
|
*
|
|
2562
|
-
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult
|
|
2570
|
+
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult/items) property in [`PostsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult).
|
|
2563
2571
|
* @public
|
|
2564
2572
|
* @documentationMaturity preview
|
|
2565
2573
|
* @param options - Options specifying which fields to return.
|
|
@@ -2600,48 +2608,66 @@ export interface PostsQueryResult extends QueryOffsetResult {
|
|
|
2600
2608
|
export interface PostsQueryBuilder {
|
|
2601
2609
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2602
2610
|
* @param value - Value to compare against.
|
|
2611
|
+
* @documentationMaturity preview
|
|
2603
2612
|
*/
|
|
2604
2613
|
eq: (propertyName: string, value: any) => PostsQueryBuilder;
|
|
2605
2614
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2606
2615
|
* @param value - Value to compare against.
|
|
2616
|
+
* @documentationMaturity preview
|
|
2607
2617
|
*/
|
|
2608
2618
|
ne: (propertyName: string, value: any) => PostsQueryBuilder;
|
|
2609
2619
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2610
2620
|
* @param value - Value to compare against.
|
|
2621
|
+
* @documentationMaturity preview
|
|
2611
2622
|
*/
|
|
2612
2623
|
ge: (propertyName: string, value: any) => PostsQueryBuilder;
|
|
2613
2624
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2614
2625
|
* @param value - Value to compare against.
|
|
2626
|
+
* @documentationMaturity preview
|
|
2615
2627
|
*/
|
|
2616
2628
|
gt: (propertyName: string, value: any) => PostsQueryBuilder;
|
|
2617
2629
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2618
2630
|
* @param value - Value to compare against.
|
|
2631
|
+
* @documentationMaturity preview
|
|
2619
2632
|
*/
|
|
2620
2633
|
le: (propertyName: string, value: any) => PostsQueryBuilder;
|
|
2621
2634
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2622
2635
|
* @param value - Value to compare against.
|
|
2636
|
+
* @documentationMaturity preview
|
|
2623
2637
|
*/
|
|
2624
2638
|
lt: (propertyName: string, value: any) => PostsQueryBuilder;
|
|
2625
2639
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
2626
2640
|
* @param string - String to compare against. Case-insensitive.
|
|
2641
|
+
* @documentationMaturity preview
|
|
2627
2642
|
*/
|
|
2628
2643
|
startsWith: (propertyName: string, value: string) => PostsQueryBuilder;
|
|
2629
2644
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
2630
2645
|
* @param values - List of values to compare against.
|
|
2646
|
+
* @documentationMaturity preview
|
|
2631
2647
|
*/
|
|
2632
2648
|
hasSome: (propertyName: string, value: any[]) => PostsQueryBuilder;
|
|
2633
2649
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
2634
2650
|
* @param values - List of values to compare against.
|
|
2651
|
+
* @documentationMaturity preview
|
|
2635
2652
|
*/
|
|
2636
2653
|
hasAll: (propertyName: string, value: any[]) => PostsQueryBuilder;
|
|
2637
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2654
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2655
|
+
* @documentationMaturity preview
|
|
2656
|
+
*/
|
|
2638
2657
|
ascending: (...propertyNames: string[]) => PostsQueryBuilder;
|
|
2639
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2658
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2659
|
+
* @documentationMaturity preview
|
|
2660
|
+
*/
|
|
2640
2661
|
descending: (...propertyNames: string[]) => PostsQueryBuilder;
|
|
2641
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
2662
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
2663
|
+
* @documentationMaturity preview
|
|
2664
|
+
*/
|
|
2642
2665
|
limit: (limit: number) => PostsQueryBuilder;
|
|
2643
|
-
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
2666
|
+
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
2667
|
+
* @documentationMaturity preview
|
|
2668
|
+
*/
|
|
2644
2669
|
skip: (skip: number) => PostsQueryBuilder;
|
|
2670
|
+
/** @documentationMaturity preview */
|
|
2645
2671
|
find: () => Promise<PostsQueryResult>;
|
|
2646
2672
|
}
|
|
2647
2673
|
/**
|
|
@@ -739,21 +739,21 @@ exports.listPosts = listPosts;
|
|
|
739
739
|
* Creates a query to retrieve a list of posts.
|
|
740
740
|
*
|
|
741
741
|
*
|
|
742
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/
|
|
742
|
+
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a [`PostsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder) object.
|
|
743
743
|
*
|
|
744
|
-
* 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/
|
|
744
|
+
* 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/posts/postsquerybuilder/find) function.
|
|
745
745
|
*
|
|
746
746
|
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
|
747
747
|
*
|
|
748
748
|
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that can be overridden:
|
|
749
|
-
* + `limit(50)`
|
|
750
|
-
* + `descending('firstPublishedDate')`
|
|
749
|
+
* + [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/limit)
|
|
750
|
+
* + [`descending('firstPublishedDate')`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsquerybuilder/descending)
|
|
751
751
|
*
|
|
752
752
|
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
|
753
753
|
*
|
|
754
754
|
* To learn how to query posts, refer to the table below.
|
|
755
755
|
*
|
|
756
|
-
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult
|
|
756
|
+
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult/items) property in [`PostsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/posts/postsqueryresult).
|
|
757
757
|
* @public
|
|
758
758
|
* @documentationMaturity preview
|
|
759
759
|
* @param options - Options specifying which fields to return.
|