@wix/ditto-codegen-public 1.0.162 → 1.0.164

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

@@ -1,50 +1,130 @@
 <data_items_remove>
-<use_cases>
-- Delete items from a collection when they are no longer needed
-- Remove user-generated content that violates policies or is flagged
-- Clean up expired records, such as old sessions or temporary data
-- Delete items based on user actions (e.g., removing from cart, deleting posts)
-- Implement soft delete functionality by removing items from active collections
-- Remove test or duplicate data from collections
-- Delete items as part of GDPR or data privacy compliance
-- Remove outdated or archived records from a collection
-</use_cases>
-
-<usage>
+<description>
+# Method name:
 
+data.items.remove(dataCollectionId: string, itemId: string, options: WixDataRemoveOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/data/items/remove
+
+# Method Description:
+
+Removes an item from a collection.
+
+The `remove()` method returns a Promise that resolves to the removed item
+after it has been removed from the specified collection. The Promise is
+rejected if the current user does not have "delete" permissions for the
+collection.
+
+Calling the `remove()` method triggers the [`beforeRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-remove) and [`afterRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-remove) hooks if they have been defined.
+
+
+> **Note:** The `remove()` method also clears multiple-item reference fields for items in collections referenced by the specified item. For example, suppose you have a **Movies** collection with an **Actors** field that contains multiple references to items in a **People** collection. Removing an item in the **Movies** collection also clears the data in the corresponding multiple-item reference fields in the **People** collection.
+
+# Method Permissions:
+
+- Write Data Items
+
+# Method Permissions Scopes IDs:
+
+- SCOPE.DC-DATA.WRITE
+
+
+
+# Method Code Examples:
+
+## Remove an item from a collection
+
+```javascript
+import { items } from "@wix/data";
+
+async function removeItem() {
+ const result = await items.remove("myCollection", "00001");
+ console.log(result); // See removed item below
+}
+
+/*  removed 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"
+*  }
+*/
+```
+
+
+
+## Remove a collection using a custom function
+
+```javascript
+import { items } from "@wix/data";
+
+// Code for a delete operation using remove() //
+
+function deleteGreeting(itemId) {
+ return items.remove('Greetings', itemId);
+}
+
+```
+
+## Remove an item from a collection with condition
+
+```javascript
 import { items } from "@wix/data";
 
 async function removeItem() {
-  const removed = await items.remove("myCollection", "itemId");
-  console.log(removed); // See below
+ const filter = wixClient.items.filter().eq("active", false);
+ const result = await items.remove("accounts", "00001", { condition: filter });
+ console.log(result); // See removed item below
 }
 
-/*  removed is:
- *
- *  {
- *    "_id":          "itemId",
- *    "_owner":       "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
- *    "_createdDate": "2017-05-24T12:33:18.938Z",
- *    "_updatedDate": "2017-05-24T14:22:51.472Z",
- *    "title":        "Mr.",
- *    "first_name":   "John",
- *    "last_name":    "Doe"
- *  }
- */
-</usage>
+/*  removed 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":       false,
+*  }
+*/
+```
+
+## default
 
+```javascript
+try {
+     const result = await items.remove("collection-0.9304281905629848", "6892593d-d57f-428d-bc53-3f0870a1beef", {});
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
 <type_definition>
- Method: data.items.remove(dataCollectionId, itemId, options)
- Description: Removes an item from a collection.  The `remove()` method returns a Promise that resolves to the removed item after it has been removed from the specified collection. The Promise is rejected if the current user does not have "delete" permissions for the collection.  Calling the `remove()` method triggers the [`beforeRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-remove) and [`afterRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-remove) hooks if they have been defined.   > **Note:** The `remove()` method also clears multiple-item reference fields for items in collections referenced by the specified item. For example, suppose you have a **Movies** collection with an **Actors** field that contains multiple references to items in a **People** collection. Removing an item in the **Movies** collection also clears the data in the corresponding multiple-item reference fields in the **People** collection.
- Method parameters:
-   param name:  dataCollectionId | type: string | description:  GUID of the collection that contains the item. | required: true
-   param name:  itemId | type: string | description:  GUID of the item to remove. | required: true
-   param name:  options | type: WixDataRemoveOptions | description:  Object containing options to use when processing this operation.
- 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_remove>
+```
+Method: data.items.remove(dataCollectionId, itemId, options)
+Description: Removes an item from a collection.  The `remove()` method returns a Promise that resolves to the removed item after it has been removed from the specified collection. The Promise is rejected if the current user does not have "delete" permissions for the collection.  Calling the `remove()` method triggers the [`beforeRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-remove) and [`afterRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-remove) hooks if they have been defined.   > **Note:** The `remove()` method also clears multiple-item reference fields for items in collections referenced by the specified item. For example, suppose you have a **Movies** collection with an **Actors** field that contains multiple references to items in a **People** collection. Removing an item in the **Movies** collection also clears the data in the corresponding multiple-item reference fields in the **People** collection.
+Method parameters:
+  param name:  dataCollectionId | type: string | description:  GUID of the collection that contains the item. | required: true
+  param name:  itemId | type: string | description:  GUID of the item to remove. | required: true
+  param name:  options | type: WixDataRemoveOptions | description:  Object containing options to use when processing this operation. 
+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_remove>