@wix/blog 1.0.151 → 1.0.152

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.
@@ -26,16 +26,16 @@ export declare function getTagBySlug(payload: GetTagBySlugRequest): RequestOptio
26
26
  * Creates a query to retrieve a list of tags.
27
27
  *
28
28
  *
29
- * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsquerybuilder) object.
29
+ * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder) object.
30
30
  *
31
- * 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/tag/tagsquerybuilder/find) function.
31
+ * 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/tags/tagsquerybuilder/find) function.
32
32
  *
33
33
  * You can refine the query by chaining `TagsQueryBuilder` functions onto the query. `TagsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTags()` returns.
34
34
  *
35
35
  * `queryTags()` runs with these `TagsQueryBuilder` defaults that can be overridden:
36
- * - `limit(50)`
37
- * - `ascending('_id')`
36
+ * - [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/limit)
37
+ * - [`ascending('_id')`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/ascending)
38
38
  *
39
- * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/post/queryposts).
39
+ * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult).
40
40
  */
41
41
  export declare function queryTags(payload: QueryTagsRequest): RequestOptionsFactory<QueryTagsResponse>;
@@ -295,17 +295,17 @@ export function getTagBySlug(payload) {
295
295
  * Creates a query to retrieve a list of tags.
296
296
  *
297
297
  *
298
- * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsquerybuilder) object.
298
+ * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder) object.
299
299
  *
300
- * 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/tag/tagsquerybuilder/find) function.
300
+ * 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/tags/tagsquerybuilder/find) function.
301
301
  *
302
302
  * You can refine the query by chaining `TagsQueryBuilder` functions onto the query. `TagsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTags()` returns.
303
303
  *
304
304
  * `queryTags()` runs with these `TagsQueryBuilder` defaults that can be overridden:
305
- * - `limit(50)`
306
- * - `ascending('_id')`
305
+ * - [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/limit)
306
+ * - [`ascending('_id')`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/ascending)
307
307
  *
308
- * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/post/queryposts).
308
+ * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult).
309
309
  */
310
310
  export function queryTags(payload) {
311
311
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_queryTagsRequest, {});
@@ -549,17 +549,17 @@ export interface GetTagBySlugOptions {
549
549
  * Creates a query to retrieve a list of tags.
550
550
  *
551
551
  *
552
- * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsquerybuilder) object.
552
+ * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder) object.
553
553
  *
554
- * 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/tag/tagsquerybuilder/find) function.
554
+ * 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/tags/tagsquerybuilder/find) function.
555
555
  *
556
556
  * You can refine the query by chaining `TagsQueryBuilder` functions onto the query. `TagsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTags()` returns.
557
557
  *
558
558
  * `queryTags()` runs with these `TagsQueryBuilder` defaults that can be overridden:
559
- * - `limit(50)`
560
- * - `ascending('_id')`
559
+ * - [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/limit)
560
+ * - [`ascending('_id')`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/ascending)
561
561
  *
562
- * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/post/queryposts).
562
+ * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult).
563
563
  * @public
564
564
  * @documentationMaturity preview
565
565
  * @param options - Options specifying which fields to return.
@@ -600,44 +600,61 @@ export interface TagsQueryResult extends QueryOffsetResult {
600
600
  export interface TagsQueryBuilder {
601
601
  /** @param propertyName - Property whose value is compared with `value`.
602
602
  * @param value - Value to compare against.
603
+ * @documentationMaturity preview
603
604
  */
604
605
  eq: (propertyName: string, value: any) => TagsQueryBuilder;
605
606
  /** @param propertyName - Property whose value is compared with `value`.
606
607
  * @param value - Value to compare against.
608
+ * @documentationMaturity preview
607
609
  */
608
610
  ne: (propertyName: string, value: any) => TagsQueryBuilder;
609
611
  /** @param propertyName - Property whose value is compared with `value`.
610
612
  * @param value - Value to compare against.
613
+ * @documentationMaturity preview
611
614
  */
612
615
  ge: (propertyName: string, value: any) => TagsQueryBuilder;
613
616
  /** @param propertyName - Property whose value is compared with `value`.
614
617
  * @param value - Value to compare against.
618
+ * @documentationMaturity preview
615
619
  */
616
620
  gt: (propertyName: string, value: any) => TagsQueryBuilder;
617
621
  /** @param propertyName - Property whose value is compared with `value`.
618
622
  * @param value - Value to compare against.
623
+ * @documentationMaturity preview
619
624
  */
620
625
  le: (propertyName: string, value: any) => TagsQueryBuilder;
621
626
  /** @param propertyName - Property whose value is compared with `value`.
622
627
  * @param value - Value to compare against.
628
+ * @documentationMaturity preview
623
629
  */
624
630
  lt: (propertyName: string, value: any) => TagsQueryBuilder;
625
631
  /** @param propertyName - Property whose value is compared with `string`.
626
632
  * @param string - String to compare against. Case-insensitive.
633
+ * @documentationMaturity preview
627
634
  */
628
635
  startsWith: (propertyName: string, value: string) => TagsQueryBuilder;
629
636
  /** @param propertyName - Property whose value is compared with `values`.
630
637
  * @param values - List of values to compare against.
638
+ * @documentationMaturity preview
631
639
  */
632
640
  hasSome: (propertyName: string, value: any[]) => TagsQueryBuilder;
633
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
641
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
642
+ * @documentationMaturity preview
643
+ */
634
644
  ascending: (...propertyNames: string[]) => TagsQueryBuilder;
635
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
645
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
646
+ * @documentationMaturity preview
647
+ */
636
648
  descending: (...propertyNames: string[]) => TagsQueryBuilder;
637
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
649
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
650
+ * @documentationMaturity preview
651
+ */
638
652
  limit: (limit: number) => TagsQueryBuilder;
639
- /** @param skip - Number of items to skip in the query results before returning the results. */
653
+ /** @param skip - Number of items to skip in the query results before returning the results.
654
+ * @documentationMaturity preview
655
+ */
640
656
  skip: (skip: number) => TagsQueryBuilder;
657
+ /** @documentationMaturity preview */
641
658
  find: () => Promise<TagsQueryResult>;
642
659
  }
643
660
  export {};
@@ -232,17 +232,17 @@ export function getTagBySlug(slug, options) {
232
232
  * Creates a query to retrieve a list of tags.
233
233
  *
234
234
  *
235
- * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsquerybuilder) object.
235
+ * The `queryTags()` function builds a query to retrieve a list of up to 4,000 tags per language, and returns a [`TagsQueryBuilder`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder) object.
236
236
  *
237
- * 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/tag/tagsquerybuilder/find) function.
237
+ * 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/tags/tagsquerybuilder/find) function.
238
238
  *
239
239
  * You can refine the query by chaining `TagsQueryBuilder` functions onto the query. `TagsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTags()` returns.
240
240
  *
241
241
  * `queryTags()` runs with these `TagsQueryBuilder` defaults that can be overridden:
242
- * - `limit(50)`
243
- * - `ascending('_id')`
242
+ * - [`limit(50)`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/limit)
243
+ * - [`ascending('_id')`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsquerybuilder/ascending)
244
244
  *
245
- * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tag/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/post/queryposts).
245
+ * The following `TagQueryBuilder` functions are supported for `queryTags()`. For a full description of the Tags object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult/items) property in [`TagsQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/tags/tagsqueryresult).
246
246
  * @public
247
247
  * @documentationMaturity preview
248
248
  * @param options - Options specifying which fields to return.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/blog",
3
- "version": "1.0.151",
3
+ "version": "1.0.152",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -33,5 +33,5 @@
33
33
  "groupId": "com.wixpress.public-sdk-autogen"
34
34
  }
35
35
  },
36
- "falconPackageHash": "9f01c02426372a0eda509983c6c1632105d3846d359d6f0079453348"
36
+ "falconPackageHash": "31559c90c9b052b42cf751742e7b9b255c7637efba40d19bf6fccd7e"
37
37
  }