@wix/ditto-codegen-public 1.0.162 → 1.0.164

package/dist/docs-output/api-docs/data-items-update-doc.txt

@@ -1,57 +1,436 @@
 <data_items_update>
-<use_cases>
-- Modify existing collection items based on user actions or form submissions
-- Update item properties without losing other field values
-- Change item status or state in workflows (e.g., pending to approved)
-- Update timestamps, counters, or computed fields
-- Modify items conditionally based on current field values
-- Bulk update item properties across multiple records
-- Update items with references to other collections
-- Maintain data integrity by updating related records
-</use_cases>
-
-<usage>
+<description>
+# Method name:
 
+data.items.update(dataCollectionId: string, item: WixDataItem, options: WixDataUpdateOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/data/items/update
+
+# Method Description:
+
+Updates an item in a collection.
+
+The `update()` method returns a Promise that resolves to the updated item from
+the specified collection. The Promise is rejected if the current user does not
+have update permissions for the collection.
+
+Calling the `update()` method triggers the [`beforeUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-update) and [`afterUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-update) hooks if they have been defined.
+
+The `update()` method compares the `_id` property of the specified item
+with the `_id` property values of the items in the specified collection. If
+an item in the collection has that `_id` value, `update()` replaces the
+item's property values with the ones in the specified item. If the existing
+item had properties with values and those properties were not included in
+the specified item, the values in those properties are lost. The item's
+`_updatedDate` property is also updated to the current date.
+
+Any valid JavaScript object can be used as a property value. The `update()`
+method maintains the structure of the specified object. For example,
+objects that contain nested objects, arrays, or arrays with nested objects
+are all added to the collection as defined.
+
+When updating an item in a collection that has a reference field, set the
+value of the reference field to the referenced item's `_id` value or the
+entire referenced item object.
+
+The maximum size of an item that you can update in a collection is 500kb.
+
+> **Notes:**
+> - The specified item must include an `_id` property that already exists in the collection.
+> - The `update()` method does not support multi-reference fields. For multi-reference fields, use `replaceReferences()` or `insertReference()`.
+> - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `update()` fails and issues an error.
+
+# Method Permissions:
+
+- Write Data Items
+
+# Method Permissions Scopes IDs:
+
+- SCOPE.DC-DATA.WRITE
+
+
+
+# Method Code Examples:
+
+## Update an item with a specified ID in a collection
+
+```javascript
 import { items } from "@wix/data";
 
 async function updateItem() {
-  const toUpdate = {
-    _id: "00001",
-    title: "Mr.",
-    first_name: "John",
-    last_name: "Doe",
-  };
-
-  const updatedItem = await items.update("myCollection", toUpdate);
-  console.log(updatedItem); // See below
+ const toUpdate = {
+   "_id":          "00001",
+   "title":        "Mr.",
+   "first_name":   "John",
+   "last_name":    "Doe"
+ };
+
+ const updatedItem = await items.update("myCollection", toUpdate);
+ console.log(updatedItem); // See below
 }
 /*  item is:
- *
- *  {
- *    "_id":          "00001",
- *    "_owner":       "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
- *    "_createdDate": "2017-05-24T12:33:18.938Z",
- *    "_updatedDate": "2017-05-24T12:33:18.938Z",
- *    "title":        "Mr.",
- *    "first_name":   "John",
- *    "last_name":    "Doe"
- *  }
- */
-</usage>
+*
+*  {
+*    "_id":          "00001",
+*    "_owner":       "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
+*    "_createdDate": "2017-05-24T12:33:18.938Z",
+*    "_updatedDate": "2017-05-24T12:33:18.938Z",
+*    "title":        "Mr.",
+*    "first_name":   "John",
+*    "last_name":    "Doe"
+*  }
+*/
+```
+
+
+
+## Get an item in a collection and update it
 
+```javascript
+import { items } from "@wix/data";
+
+/*  given existing item:
+*
+*  {
+*    "_id": "00001",
+*	  "title": "Mr.",
+*	  "first_name": "John",
+*    "last_name": "Doe"
+*  }
+*
+*/
+
+async function updateItem() {
+ const item = await items.get("myCollection", "00001");
+ item.last_name = "Smith"; // Updated last name
+ const updatedItem = await items.update("myCollection", item);
+ console.log(updatedItem); // See below
+}
+
+/*  updated item:
+*
+*  {
+*    "_id": "00001",
+*	  "title": "Mr.",
+*	  "first_name": "John",
+*    "last_name": "Smith"
+*  }
+*
+*/
+
+```
+
+## Query an item in a collection and update it
+
+```javascript
+import { items } from "@wix/data";
+
+/*  given existing item:
+*
+*  {
+*    "_id": "00001",
+*    "_owner": "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
+*    "_createdDate": "2017-05-24T12:33:18.938Z",
+*    "_updatedDate": "2017-05-24T12:33:18.938Z",
+*	  "title": "Mr.",
+*	  "first_name": "John",
+*    "last_name": "Doe"
+*  }
+*
+*/
+
+async function updateItem() {
+ const results = await items.query("myCollection")
+   .eq("first_name", "John")
+   .eq("last_name", "Doe")
+   .find();
+ 
+ if(results.items.length > 0) {
+   const item = results.items[0];
+   item.last_name = "Smith"; // Updated last name
+   const updatedItem = await items.update("myCollection", item);
+   console.log(updatedItem); // See below
+ } else {
+   // handle case where no matching items found
+ }
+}
+/*  updated item:
+*
+*  {
+*    "_id": "00001",
+*    "_owner": "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
+*    "_createdDate": "2017-05-24T12:33:18.938Z",
+*    "_updatedDate": "2017-05-24T16:13:46.545Z",
+*	  "title": "Mr.",
+*	  "first_name": "John",
+*    "last_name": "Smith"
+*  }
+*
+*/
+
+```
+
+## Update an item including a reference to another item using the referenced item's ID
+
+```javascript
+import { items } from "@wix/data";
+
+async function updateItem() {
+ const countryId = "id-of-usa-item";
+ 
+ const toUpdate = {
+   "_id":          "00001",
+   "title":        "Mr.",
+   "first_name":   "John",
+   "last_name":    "Doe",
+   "country":      countryId
+ };
+ 
+ const updatedItem = await items.update("myCollection", toUpdate);
+ console.log(updatedItem); // See below
+}
+/*  item is:
+*
+*  {
+*    "_id":          "rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i",
+*    "_owner":       "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
+*    "_createdDate": "2017-05-24T12:33:18.938Z",
+*    "_updatedDate": "2017-05-24T12:33:18.938Z",
+*    "title":        "Mr.",
+*    "first_name":   "John",
+*    "last_name":    "Doe",
+*    "country":      "id-of-usa-item"
+*  }
+*/
+```
+
+## Update an item including a reference to another item using the referenced item
+
+```javascript
+import { items } from "@wix/data";
+
+async function updateItem() {
+ const countryItem = // Get country item
+ 
+ const toUpdate = {
+   "_id":          "00001",
+   "title":        "Mr.",
+   "first_name":   "John",
+   "last_name":    "Doe",
+   "country":      countryItem
+ };
+ 
+ const updatedItem = await items.update("myCollection", toUpdate);
+ console.log(updatedItem); // See below
+}
+
+/*  item is:
+*
+*  {
+*    "_id":          "rifk4nrk-dj4o-djhe-oidk-fnoqw4oiglk4i",
+*    "_owner":       "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
+*    "_createdDate": "2017-05-24T12:33:18.938Z",
+*    "_updatedDate": "2017-05-24T12:33:18.938Z",
+*    "title":        "Mr.",
+*    "first_name":   "John",
+*    "last_name":    "Doe",
+*    "country":      "id-of-usa-item"
+*  }
+*/
+```
+
+## Update a collection using a custom function
+
+```javascript
+import { items } from "@wix/data";
+
+// Code for an update operation using update() //
+
+function updateGreeting(itemId, language, greeting) {
+ const toUpdate = {
+   _id: itemId,
+   language,
+   greeting
+ };
+
+ return items.update('Greetings', toUpdate);
+}
+
+```
+
+## Update an item in a collection with condition
+
+```javascript
+import { items } from "@wix/data";
+
+async function updateItem() {
+ const filter = items.filter().eq("active", true);
+
+ const toUpdate = {
+   "_id":          "00001",
+   "title":        "Mr.",
+   "first_name":   "John",
+   "last_name":    "Doe",
+   "active":       true
+ };
+
+ const updatedItem = await items.update("Users", toUpdate, { condition: filter });
+ console.log(updatedItem); // See below
+}
+/*  item is:
+*
+*  {
+*    "_id":          "00001",
+*    "_owner":       "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
+*    "_createdDate": "2017-05-24T12:33:18.938Z",
+*    "_updatedDate": "2017-05-24T12:33:18.938Z",
+*    "title":        "Mr.",
+*    "first_name":   "John",
+*    "last_name":    "Doe",
+*    "active":       true,
+*  }
+*/
+```
+
+## default
+
+```javascript
+try {
+     const result = await items.update("collection-0.4576076907162254", {
+         "_id": "6892593d-d57f-428d-bc53-3f0870a1beef",
+         "_owner": "28962158-e9e0-4a9c-8bf0-5f654d78ccb6"
+     }, {
+         "appOptions": {},
+         "showDrafts": false,
+         "suppressHooks": false
+     });
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
 <type_definition>
+```
 Method: data.items.update(dataCollectionId, item, options)
- Description: Updates an item in a collection.  The `update()` method returns a Promise that resolves to the updated item from the specified collection. The Promise is rejected if the current user does not have update permissions for the collection.  Calling the `update()` method triggers the [`beforeUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-update) and [`afterUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-update) hooks if they have been defined.  The `update()` method compares the `_id` property of the specified item with the `_id` property values of the items in the specified collection. If an item in the collection has that `_id` value, `update()` replaces the item's property values with the ones in the specified item. If the existing item had properties with values and those properties were not included in the specified item, the values in those properties are lost. The item's `_updatedDate` property is also updated to the current date.  Any valid JavaScript object can be used as a property value. The `update()` method maintains the structure of the specified object. For example, objects that contain nested objects, arrays, or arrays with nested objects are all added to the collection as defined.  When updating an item in a collection that has a reference field, set the value of the reference field to the referenced item's `_id` value or the entire referenced item object.  The maximum size of an item that you can update in a collection is 500kb.  > **Notes:** > - The specified item must include an `_id` property that already exists in the collection. > - The `update()` method does not support multi-reference fields. For multi-reference fields, use `replaceReferences()` or `insertReference()`. > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `update()` fails and issues an error.
- Method parameters:
-   param name:  dataCollectionId | type: string | description:  GUID of the collection item belongs to. | required: true
-   param name:  item | type: WixDataItem | description:  Data item to update. | required: true
-       - name: _id  | type: string | description:  Data item GUID.
-       - name: _owner  | type: string | description:  GUID of the user who created the item. Can be modified with site owner permissions.
-   param name:  options | type: WixDataUpdateOptions | description:  Options to use when processing this operation.
-       - name: appOptions  | type: Record<string, any> | description:  Options for [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections).
-       - name: condition  | type: WixDataFilter | description:  If provided, item will be updated only if condition is met.
-           Method: data.items.and(filter)
-           Description: Adds an `and` condition to the filter.  A filter with an `and` condition returns all items that meet the conditions defined on both sides of the condition.  Use the `and()` method when performing compound queries. For example, the final filter in this set of queries returns results where status is either pending or rejected **and** age is either less than 25 or greater than 65.  ```js let statusFilter = items.filter()   .eq("status", "pending")   .or(items.filter().eq("status", "rejected"));  let ageFilter = items.filter()   .lt("age", 25)   .or(items.filter().gt("age", 65));  let statusAndAgeFilter = statusFilter.and(ageFilter); ```  > **Notes**: > - The `and()` method is designed to work with 2 or more queries or filters. If used with a single query or filter, it returns all items in a collection. > - When chaining multiple `WixDataFilter` methods to a filter, an `and` condition is implied. In such cases, you do not need to call the `and()` method explicitly. For example, this filter returns results where an item `status` is `active` and `age` is greater than 25: >   ```js >   items.filter().eq("status", "active").gt("age", 25); >
-</type_definition>
-</data_items_update>
+Description: Updates an item in a collection.  The `update()` method returns a Promise that resolves to the updated item from the specified collection. The Promise is rejected if the current user does not have update permissions for the collection.  Calling the `update()` method triggers the [`beforeUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-update) and [`afterUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-update) hooks if they have been defined.  The `update()` method compares the `_id` property of the specified item with the `_id` property values of the items in the specified collection. If an item in the collection has that `_id` value, `update()` replaces the item's property values with the ones in the specified item. If the existing item had properties with values and those properties were not included in the specified item, the values in those properties are lost. The item's `_updatedDate` property is also updated to the current date.  Any valid JavaScript object can be used as a property value. The `update()` method maintains the structure of the specified object. For example, objects that contain nested objects, arrays, or arrays with nested objects are all added to the collection as defined.  When updating an item in a collection that has a reference field, set the value of the reference field to the referenced item's `_id` value or the entire referenced item object.  The maximum size of an item that you can update in a collection is 500kb.  > **Notes:** > - The specified item must include an `_id` property that already exists in the collection. > - The `update()` method does not support multi-reference fields. For multi-reference fields, use `replaceReferences()` or `insertReference()`. > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `update()` fails and issues an error.
+Method parameters:
+  param name:  dataCollectionId | type: string | description:  GUID of the collection item belongs to. | required: true
+  param name:  item | type: WixDataItem | description:  Data item to update. | required: true
+      - name: _id  | type: string | description:  Data item GUID. 
+      - name: _owner  | type: string | description:  GUID of the user who created the item. Can be modified with site owner permissions. 
+  param name:  options | type: WixDataUpdateOptions | description:  Options to use when processing this operation. 
+      - name: appOptions  | type: Record<string, any> | description:  Options for [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections). 
+      - name: condition  | type: WixDataFilter | description:  If provided, item will be updated only if condition is met. 
+          Method: data.items.and(filter)
+          Description: Adds an `and` condition to the filter.  A filter with an `and` condition returns all items that meet the conditions defined on both sides of the condition.  Use the `and()` method when performing compound queries. For example, the final filter in this set of queries returns results where status is either pending or rejected **and** age is either less than 25 or greater than 65.  ```js let statusFilter = items.filter()   .eq("status", "pending")   .or(items.filter().eq("status", "rejected"));  let ageFilter = items.filter()   .lt("age", 25)   .or(items.filter().gt("age", 65));  let statusAndAgeFilter = statusFilter.and(ageFilter); ```  > **Notes**: > - The `and()` method is designed to work with 2 or more queries or filters. If used with a single query or filter, it returns all items in a collection. > - When chaining multiple `WixDataFilter` methods to a filter, an `and` condition is implied. In such cases, you do not need to call the `and()` method explicitly. For example, this filter returns results where an item `status` is `active` and `age` is greater than 25: >   ```js >   items.filter().eq("status", "active").gt("age", 25); >   ```
+          Method parameters:
+            param name:  filter | type: WixDataFilter | description:  `WixDataFilter` used with an `and` condition. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.between(field, rangeStart, rangeEnd)
+          Description: Refines a filter to match items where the value of the specified field is within the defined range.  The `between()` method refines this filter to match items for which the value of the specified field is greater than or equal to `rangeStart` and less than `rangeEnd`. The method only compares values of [the same type](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-type).  The following types can be compared: - Number: Compared numerically. - Date: Compared as JavaScript Date objects. - String: Compared lexicographically:   - `"A"` and `"M"` are considered between `"A"` and `"Z"`, but `"a"`, `"m"`, `"z"` and `"Z"` are not.   - `"A"`, `"M"`, `"Z"`, and `"a"` are considered between `"A"` and `"z"`, but `"z"` is not.  > **Note**: Items that do not have a value for the specified field are considered as the lowest comparable value and are ranked last.
+          Method parameters:
+            param name:  field | type: string | description:  Field to compare with `rangeStart` and `rangeEnd`. 
+            param name:  rangeStart | type: undefined | description:  Starting value of the range to match. 
+            param name:  rangeEnd | type: undefined | description:  Ending value of the range to match. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.contains(field, value)
+          Description: Refines a filter to match items where the value of the specified field contains the specified value.  The `contains()` method refines the filter to only match items for which the value of the specified field contains the specified value. `contains()` is not case-sensitive, so the value `sunday` is considered to contain the value `Sun`.  You can use `contains()` with a [field of type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data) is a string or a reference. When specifying a field of type reference, `contains()` matches by the GUID of the referenced item as a string. To compare by other data types, use the [`eq()`](https://dev.wix.com/docs/sdk/backend-modules/data/wix-data-items-sdk-1-0-0/wix-data-filter/eq) method.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with the provided value. 
+            param name:  value | type: string | description:  Value to locate in the specified field. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.endsWith(field, value)
+          Description: Refines a filter to match items where the value of the specified field ends with a specified value.  The `endsWith()` method refines this filter to only match items where the value of the specified field ends with the specified value. Matching with `endsWith()` is not case sensitive, so `"TEXT"` is considered to end with `"ext"`.  You can only use `endsWith()` with a [field of type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data) string or reference. When specifying a field of type reference, `endsWith()` matches by the GUID of the referenced item as a string.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with the specified value. 
+            param name:  value | type: string | description:  Value to look for at the end of the specified field value. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.eq(field, value)
+          Description: Refines a filter to match items where the value of the specified field equals the specified value.  The `eq()` method refines this filter to only match items where the value of the specified field equals the specified `value`.  Values of different [types](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data) are always considered not equal. For example, a number value stored as a string does not match the same number stored as a number.  Matching strings with `eq()` is case sensitive, so `"text"` is not equal to `"Text"`.  If `field` points to a collection field of type array, `eq()` includes the item as long as at least one array element matches the specified `value`.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with `value`. 
+            param name:  value | type: any | description:  Value to compare with. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.ge(field, value)
+          Description: Refines a filter to match items where the value of the specified field is greater than or equal to the specified value.  The `ge()` method refines this filter to only match items where the value of the specified field is greater than or equal to the specified value.  The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string does not match the same number stored as a number.  If a field contains a number as a string, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.  The following field types can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects. - String: Compares lexicographically,   so `"abc"` is greater than or equal to `"ABC"` (because of the greater than),   but `"ABC"` is not greater than or equal to `"abc"`. - Reference: Compares by the GUID of the referenced item as a string.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with the specified value. 
+            param name:  value | type: undefined | description:  Value to match. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.gt(field, value)
+          Description: Refines a filter to match items where the value of the specified field is greater than the specified value.  The `gt()` method refines this filter to only match items where the value of the specified field is greater than the specified value.  The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string does not match the same number stored as a number.  If a field contains a number as a string, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.  The following field types can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects. - String: Compares lexicographically, so `"text"` is greater than `"Text"`. - Reference: Compares by the GUID of the referenced item as a string.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with the specified value. 
+            param name:  value | type: undefined | description:  Value to match. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.hasAll(field, values)
+          Description: Refines a filter to match items where the values of the specified field contain all of the specified values.  The `hasAll()` method refines this filter to only match items where the specified field contains all of the specified values.  Matching strings with `hasAll()` is case sensitive, so `"text"` is not equal to `"Text"`.  If the value of the specified field is an array, `hasAll()` will match if there is a match in the elements of that array for all of the specified values.  You can specify a list of values to match by providing an array of String, Number, or Date types as the `value` parameters.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with `values`. 
+            param name:  values | type: undefined | description:  Values to match. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.hasSome(field, values)
+          Description: Refines a filter to match items where the values of the specified field contain any of the specified values.  The `hasSome()` method refines this filter to only match items where the specified field contains any of the specified values.  Matching strings with `hasSome()` is case sensitive, so `"text"` is not equal to `"Text"`.  If the value of the specified field is an array, `hasSome()` will match if any of the elements of that array match any of the specified values.  If the specified field contains multiple references, pass item GUIDs in the `value` field. In such a case, `hasSome()` will match if any of the multiple references match any of the specified GUID values.  You can specify a list of values to match by providing an array of String, Number, or Date types as the `value` parameters.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with `value`. 
+            param name:  values | type: undefined | description:  Values to match. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.isEmpty(field)
+          Description: Refines a filter to match items whose specified field does not exist or does not have any value.  The `isEmpty()` method refines this filter to only match items where the value of the specified field is `null` or `undefined` or the field does not exist.  If the field contains any value at all for a given item, including the empty string or an invalid value, that item will match the filter.
+          Method parameters:
+            param name:  field | type: string | description:  Field to check for a value. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.isNotEmpty(field)
+          Description: Refines a filter to match items whose specified field has any value.  The `isNotEmpty()` method refines this filter to only match items where the value of the specified field is not `null` or `undefined`.  If the field contains any value at all for a given item, including the empty string or an invalid value, that item will match the filter.
+          Method parameters:
+            param name:  field | type: string | description:  Field to check for a value. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.le(field, value)
+          Description: Refines a filter to match items where the value of the specified field is less than or equal to the specified value.  The `le()` method refines this filter to only match items where the value of the specified field is less than or equal to the specified value.  The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string does not match the same number stored as a number.  If a field contains a number as a string, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.  The following field types can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects. - String: Compares lexicographically,   so `"ABC"` is less than or equal to `"abc"` (because of the less than),   but `"abc"` is not less than or equal to `"ABC"`. - Reference: Compares by the GUID of the referenced item as a string.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with the specified value. 
+            param name:  value | type: undefined | description:  Value to match. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.lt(field, value)
+          Description: Refines a filter to match items where the value of the specified field is less than the specified value.  The `lt()` method refines this filter to only match items where the value of the specified field is less than the specified `value`.  The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string does not match the same number stored as a number.  If a field contains a number as a String, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.  The following field types can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects. - String: Compares lexicographically, so `"Text"` is less than `"text"`. - Reference: Compares by the GUID of the referenced item as a String.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with `value`. 
+            param name:  value | type: undefined | description:  Value to match. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.ne(field, value)
+          Description: Refines a filter to match items where the value of the specified field does not equal the specified value.  The `ne()` method refines this filter to only match items where the value of the specified field does not equal the specified value.  The method only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string is considered not equal to the same number stored as a number.  Matching strings with `ne()` is case sensitive, so `"text"` is considered not equal to `"Text"`.  If the value of `field` is an array, `ne()` matches items where none of the elements of the array match the specified value.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with `value`. 
+            param name:  value | type: any | description:  Value to match. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.not(filter)
+          Description: Adds a `not` condition to the filter.  The `not()` method adds a `not` condition to this filter. A filter with a `not` returns all the items that match the filter as defined up to the `not` method, but don't match the filter passed to the `not` method.  If the filter only contains a `not()` method, it returns all the items that don't match the filter defined by the `not` method.
+          Method parameters:
+            param name:  filter | type: WixDataFilter | description:  Filter to add to the initial filter as a `not` condition. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.or(filter)
+          Description: Adds an `or` condition to the filter.  The `or()` method adds an inclusive `or` condition to this filter. A filter with an `or` returns all the items that match the filter as defined up to the `or` method, the items that match the filter passed to the `or` method, and the items that match both.  The `or()` method is designed to work with 2 or more queries or filters. If you use it on its own, it will return all the items in a collection.
+          Method parameters:
+            param name:  filter | type: WixDataFilter | description:  Filter to add to the initial filter as an `or` condition. 
+          Return type: REFERENCE<WixDataFilter>
+          Method: data.items.startsWith(field, value)
+          Description: Refines a filter to match items where the value of the specified field starts with a specified value.  The `startsWith()` method refines this filter to only match items where the value of the specified field starts with the specified value. Matching with `startsWith()` is not case sensitive, so specifying `"TEXT"` is considered to start with `"tex"`.  You can only use `startsWith()` with a [field of type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data) string or reference. When specifying a field of type reference, `startsWith()` matches by the GUID of the referenced item as a string.
+          Method parameters:
+            param name:  field | type: string | description:  Field whose value is compared with the specified value. 
+            param name:  value | type: string | description:  Value to look for at the beginning of the specified field value. 
+          Return type: REFERENCE<WixDataFilter>
+      - name: showDrafts  | type: boolean | description:  When `true`, operations include draft items. Read operations include draft items in their response, and write operations modify draft items.  Default: `false`. 
+      - name: suppressHooks  | type: boolean | description:  Prevents hooks from running for the operation. Can only be used in the [backend code of a Wix site](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend).  Default: `false`. 
+Return type: PROMISE<WixDataItem>
+      - name: _createdDate  | type: Date | description:  Date and time the item was added to the collection. 
+      - name: _id  | type: string | description:  Data item GUID. 
+      - name: _owner  | type: string | description:  GUID of the user who created the item. Can be modified with site owner permissions. 
+      - name: _updatedDate  | type: Date | description:  Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value. 
 
+```
+</type_definition>
+</data_items_update>