@wix/sdk-types 1.13.19 → 1.13.21

package/build/browser/index.d.mts

@@ -347,11 +347,13 @@ type OperatorForArrayFiltering = '$matchItems';
  * Cursor-based paging configuration
  */
 interface CursorPaging {
-    /** Maximum number of items to return in the results (0-100) */
+    /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
-     * Pointer to the next or previous page in the results
-     * Pass the cursor token from the pagingMetadata of the previous response
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
      */
     cursor?: string | null;
 }
@@ -697,8 +699,7 @@ type Aggregation<Spec extends SearchSpec> = BaseAggregation<Spec> | {
  */
 interface SearchDetails<Spec extends SearchSpec> {
     /**
-     * The search query text
-     * @example 'urgent task'
+     * Search term or expression.
      */
     expression?: string | null;
     /**
@@ -708,8 +709,7 @@ interface SearchDetails<Spec extends SearchSpec> {
      */
     mode?: 'AND' | 'OR';
     /**
-     * Fields to search within
-     * If not specified, searches all searchable fields
+     Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
      */
     fields?: SearchableFields<Spec>[];
     /**
@@ -725,28 +725,31 @@ interface SearchDetails<Spec extends SearchSpec> {
  */
 type BaseSearch<Entity, Spec extends SearchSpec> = {
     /**
-     * Filter conditions for the search
-     * @example { status: { $eq: 'PUBLISHED' } }
+     * Filter object.
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Filter<Entity, Spec>;
     /**
-     * Sorting options for the results
-     * @example [{ fieldName: 'createdAt', order: 'DESC' }]
+     * List of sort objects.
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting<Spec>[];
     /**
-     * Full-text search configuration
-     * @example { expression: 'urgent', mode: 'AND' }
+     * Free text to match in searchable fields.
      */
     search?: SearchDetails<Spec>;
     /**
-     * Aggregations for data analysis
-     * Aggregations provide summaries about data partitions
+     * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
      */
     aggregations?: Aggregation<Spec>[];
     /**
-     * Timezone for date-related queries
-     * Affects how date fields are interpreted
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
      */
     timeZone?: string | null;
 };

package/build/index.d.mts

@@ -347,11 +347,13 @@ type OperatorForArrayFiltering = '$matchItems';
  * Cursor-based paging configuration
  */
 interface CursorPaging {
-    /** Maximum number of items to return in the results (0-100) */
+    /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
-     * Pointer to the next or previous page in the results
-     * Pass the cursor token from the pagingMetadata of the previous response
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
      */
     cursor?: string | null;
 }
@@ -697,8 +699,7 @@ type Aggregation<Spec extends SearchSpec> = BaseAggregation<Spec> | {
  */
 interface SearchDetails<Spec extends SearchSpec> {
     /**
-     * The search query text
-     * @example 'urgent task'
+     * Search term or expression.
      */
     expression?: string | null;
     /**
@@ -708,8 +709,7 @@ interface SearchDetails<Spec extends SearchSpec> {
      */
     mode?: 'AND' | 'OR';
     /**
-     * Fields to search within
-     * If not specified, searches all searchable fields
+     Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
      */
     fields?: SearchableFields<Spec>[];
     /**
@@ -725,28 +725,31 @@ interface SearchDetails<Spec extends SearchSpec> {
  */
 type BaseSearch<Entity, Spec extends SearchSpec> = {
     /**
-     * Filter conditions for the search
-     * @example { status: { $eq: 'PUBLISHED' } }
+     * Filter object.
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Filter<Entity, Spec>;
     /**
-     * Sorting options for the results
-     * @example [{ fieldName: 'createdAt', order: 'DESC' }]
+     * List of sort objects.
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting<Spec>[];
     /**
-     * Full-text search configuration
-     * @example { expression: 'urgent', mode: 'AND' }
+     * Free text to match in searchable fields.
      */
     search?: SearchDetails<Spec>;
     /**
-     * Aggregations for data analysis
-     * Aggregations provide summaries about data partitions
+     * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
      */
     aggregations?: Aggregation<Spec>[];
     /**
-     * Timezone for date-related queries
-     * Affects how date fields are interpreted
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
      */
     timeZone?: string | null;
 };

package/build/index.d.ts

@@ -347,11 +347,13 @@ type OperatorForArrayFiltering = '$matchItems';
  * Cursor-based paging configuration
  */
 interface CursorPaging {
-    /** Maximum number of items to return in the results (0-100) */
+    /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
-     * Pointer to the next or previous page in the results
-     * Pass the cursor token from the pagingMetadata of the previous response
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
      */
     cursor?: string | null;
 }
@@ -697,8 +699,7 @@ type Aggregation<Spec extends SearchSpec> = BaseAggregation<Spec> | {
  */
 interface SearchDetails<Spec extends SearchSpec> {
     /**
-     * The search query text
-     * @example 'urgent task'
+     * Search term or expression.
      */
     expression?: string | null;
     /**
@@ -708,8 +709,7 @@ interface SearchDetails<Spec extends SearchSpec> {
      */
     mode?: 'AND' | 'OR';
     /**
-     * Fields to search within
-     * If not specified, searches all searchable fields
+     Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
      */
     fields?: SearchableFields<Spec>[];
     /**
@@ -725,28 +725,31 @@ interface SearchDetails<Spec extends SearchSpec> {
  */
 type BaseSearch<Entity, Spec extends SearchSpec> = {
     /**
-     * Filter conditions for the search
-     * @example { status: { $eq: 'PUBLISHED' } }
+     * Filter object.
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Filter<Entity, Spec>;
     /**
-     * Sorting options for the results
-     * @example [{ fieldName: 'createdAt', order: 'DESC' }]
+     * List of sort objects.
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting<Spec>[];
     /**
-     * Full-text search configuration
-     * @example { expression: 'urgent', mode: 'AND' }
+     * Free text to match in searchable fields.
      */
     search?: SearchDetails<Spec>;
     /**
-     * Aggregations for data analysis
-     * Aggregations provide summaries about data partitions
+     * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
      */
     aggregations?: Aggregation<Spec>[];
     /**
-     * Timezone for date-related queries
-     * Affects how date fields are interpreted
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
      */
     timeZone?: string | null;
 };

package/internal/build/browser/index.d.mts

@@ -410,11 +410,13 @@ type OperatorForArrayFiltering = '$matchItems';
  * Cursor-based paging configuration
  */
 interface CursorPaging {
-    /** Maximum number of items to return in the results (0-100) */
+    /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
-     * Pointer to the next or previous page in the results
-     * Pass the cursor token from the pagingMetadata of the previous response
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
      */
     cursor?: string | null;
 }
@@ -760,8 +762,7 @@ type Aggregation<Spec extends SearchSpec> = BaseAggregation<Spec> | {
  */
 interface SearchDetails<Spec extends SearchSpec> {
     /**
-     * The search query text
-     * @example 'urgent task'
+     * Search term or expression.
      */
     expression?: string | null;
     /**
@@ -771,8 +772,7 @@ interface SearchDetails<Spec extends SearchSpec> {
      */
     mode?: 'AND' | 'OR';
     /**
-     * Fields to search within
-     * If not specified, searches all searchable fields
+     Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
      */
     fields?: SearchableFields<Spec>[];
     /**
@@ -788,28 +788,31 @@ interface SearchDetails<Spec extends SearchSpec> {
  */
 type BaseSearch<Entity, Spec extends SearchSpec> = {
     /**
-     * Filter conditions for the search
-     * @example { status: { $eq: 'PUBLISHED' } }
+     * Filter object.
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Filter<Entity, Spec>;
     /**
-     * Sorting options for the results
-     * @example [{ fieldName: 'createdAt', order: 'DESC' }]
+     * List of sort objects.
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting<Spec>[];
     /**
-     * Full-text search configuration
-     * @example { expression: 'urgent', mode: 'AND' }
+     * Free text to match in searchable fields.
      */
     search?: SearchDetails<Spec>;
     /**
-     * Aggregations for data analysis
-     * Aggregations provide summaries about data partitions
+     * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
      */
     aggregations?: Aggregation<Spec>[];
     /**
-     * Timezone for date-related queries
-     * Affects how date fields are interpreted
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
      */
     timeZone?: string | null;
 };

package/internal/build/index.d.mts

@@ -410,11 +410,13 @@ type OperatorForArrayFiltering = '$matchItems';
  * Cursor-based paging configuration
  */
 interface CursorPaging {
-    /** Maximum number of items to return in the results (0-100) */
+    /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
-     * Pointer to the next or previous page in the results
-     * Pass the cursor token from the pagingMetadata of the previous response
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
      */
     cursor?: string | null;
 }
@@ -760,8 +762,7 @@ type Aggregation<Spec extends SearchSpec> = BaseAggregation<Spec> | {
  */
 interface SearchDetails<Spec extends SearchSpec> {
     /**
-     * The search query text
-     * @example 'urgent task'
+     * Search term or expression.
      */
     expression?: string | null;
     /**
@@ -771,8 +772,7 @@ interface SearchDetails<Spec extends SearchSpec> {
      */
     mode?: 'AND' | 'OR';
     /**
-     * Fields to search within
-     * If not specified, searches all searchable fields
+     Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
      */
     fields?: SearchableFields<Spec>[];
     /**
@@ -788,28 +788,31 @@ interface SearchDetails<Spec extends SearchSpec> {
  */
 type BaseSearch<Entity, Spec extends SearchSpec> = {
     /**
-     * Filter conditions for the search
-     * @example { status: { $eq: 'PUBLISHED' } }
+     * Filter object.
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Filter<Entity, Spec>;
     /**
-     * Sorting options for the results
-     * @example [{ fieldName: 'createdAt', order: 'DESC' }]
+     * List of sort objects.
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting<Spec>[];
     /**
-     * Full-text search configuration
-     * @example { expression: 'urgent', mode: 'AND' }
+     * Free text to match in searchable fields.
      */
     search?: SearchDetails<Spec>;
     /**
-     * Aggregations for data analysis
-     * Aggregations provide summaries about data partitions
+     * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
      */
     aggregations?: Aggregation<Spec>[];
     /**
-     * Timezone for date-related queries
-     * Affects how date fields are interpreted
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
      */
     timeZone?: string | null;
 };

package/internal/build/index.d.ts

@@ -410,11 +410,13 @@ type OperatorForArrayFiltering = '$matchItems';
  * Cursor-based paging configuration
  */
 interface CursorPaging {
-    /** Maximum number of items to return in the results (0-100) */
+    /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
-     * Pointer to the next or previous page in the results
-     * Pass the cursor token from the pagingMetadata of the previous response
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
      */
     cursor?: string | null;
 }
@@ -760,8 +762,7 @@ type Aggregation<Spec extends SearchSpec> = BaseAggregation<Spec> | {
  */
 interface SearchDetails<Spec extends SearchSpec> {
     /**
-     * The search query text
-     * @example 'urgent task'
+     * Search term or expression.
      */
     expression?: string | null;
     /**
@@ -771,8 +772,7 @@ interface SearchDetails<Spec extends SearchSpec> {
      */
     mode?: 'AND' | 'OR';
     /**
-     * Fields to search within
-     * If not specified, searches all searchable fields
+     Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
      */
     fields?: SearchableFields<Spec>[];
     /**
@@ -788,28 +788,31 @@ interface SearchDetails<Spec extends SearchSpec> {
  */
 type BaseSearch<Entity, Spec extends SearchSpec> = {
     /**
-     * Filter conditions for the search
-     * @example { status: { $eq: 'PUBLISHED' } }
+     * Filter object.
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
      */
     filter?: Filter<Entity, Spec>;
     /**
-     * Sorting options for the results
-     * @example [{ fieldName: 'createdAt', order: 'DESC' }]
+     * List of sort objects.
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting<Spec>[];
     /**
-     * Full-text search configuration
-     * @example { expression: 'urgent', mode: 'AND' }
+     * Free text to match in searchable fields.
      */
     search?: SearchDetails<Spec>;
     /**
-     * Aggregations for data analysis
-     * Aggregations provide summaries about data partitions
+     * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
      */
     aggregations?: Aggregation<Spec>[];
     /**
-     * Timezone for date-related queries
-     * Affects how date fields are interpreted
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
      */
     timeZone?: string | null;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk-types",
-  "version": "1.13.19",
+  "version": "1.13.21",
   "license": "MIT",
   "author": {
     "name": "Ronny Ringel",
@@ -61,5 +61,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "7a9d971b38d916a059cf9a4b6cd600f6d34c4e03f063d6ece5cc1bb4"
+  "falconPackageHash": "694788ef9dc33a22b172466ce303ac8bf4f7538d4f9175e592c02b63"
 }