Merge remote-tracking branch 'origin/master' into events---policies

Author: wix-docs-feds

all/all-apis/abandoned-checkouts.service.json

@@ -703,10 +703,27 @@
       "docs": {"summary": " Triggered when a booking is created.\n"},
       "topic": "domain_events_wix.bookings.v2.booking",
       "tag": "Bookings V2",
-      "permissions": [],
+      "permissions": [      {
+        "name": "Read Bookings - Including Participants",
+        "description": "Request permission to read the business's bookings info, and its bookings with staff member and participant data."
+      }],
       "customLabels": [{"id": "maturity-beta"}],
       "eventType": "wix.bookings.v2.booking_created",
       "extra": {"isDomainEvent": true}
+    },
+        {
+      "type": "_com_wixpress_bookings_bookings_v2_BookingUpdatedDomainEvent",
+      "name": "Booking Updated Webhook",
+      "docs": {"summary": " Triggered when a booking is updated.\n"},
+      "topic": "domain_events_wix.bookings.v2.booking",
+      "tag": "Bookings V2",
+      "permissions": [      {
+        "name": "Read Bookings - Including Participants",
+        "description": "Request permission to read the business's bookings info, and its bookings with staff member and participant data."
+      }],
+      "customLabels": [{"id": "maturity-beta"}],
+      "eventType": "wix.bookings.v2.booking_updated",
+      "extra": {"isDomainEvent": true}
     },
         {
       "type": "_com_wixpress_bookings_bookings_v2_NumberOfParticipantsUpdatedDomainEvent",
@@ -977,9 +994,9 @@
         "examples": []
       },
       "members": [      {
-        "name": "currentEntityAsJson",
+        "name": "currentEntity",
         "type": "All APIs.bookingsv2._com_wixpress_bookings_bookings_v2_Booking",
-        "doc": "Event body as a stringified JSON"
+        "doc": "Event body"
       }],
       "enum": null,
       "extra": {},
@@ -1958,7 +1975,7 @@
       "displayName": "namespaces Map Entry Object",
       "locations": [],
       "docs":       {
-        "summary": "Set of key-value pairs.  Data Extensions extended fields\nKey: Namespace\nValue: extended fields data in Struct format\n",
+        "summary": "Set of key-value pairs.  \nExtended field data as key:object pairs. Each key corresponds to the namespace of the app that created the extended fields. \nThe value of each key is structured according to the schema defined when the extended fields were created.\n\nYou can only access fields for which you have the appropriate permissions.\n",
         "links": [],
         "examples": []
       },
@@ -1983,7 +2000,7 @@
       "members": [      {
         "name": "namespaces",
         "type": "All APIs.bookingsv2.namespacesMapEntry",
-        "doc": "Set of key-value pairs.  Data Extensions extended fields\nKey: Namespace\nValue: extended fields data in Struct format\n"
+        "doc": "Set of key-value pairs.  \nExtended field data as key:object pairs. Each key corresponds to the namespace of the app that created the extended fields. \nThe value of each key is structured according to the schema defined when the extended fields were created.\n\nYou can only access fields for which you have the appropriate permissions.\n"
       }],
       "enum": null,
       "extra": {},
@@ -2117,7 +2134,7 @@
                 {
           "name": "extendedFields",
           "type": "All APIs.bookingsv2._wix_common_data_dataextensions_ExtendedFields",
-          "doc": "Additional custom fields. This includes fields managed by Wix, by 3rd-party apps, and by the site.\n\nEmpty fields are not returned.\n"
+          "doc": "Custom field data for this object. Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls.\n"
         },
                 {
           "name": "doubleBooked",

all/all-apis/bookingsv2.service.json

@@ -119,7 +119,7 @@
       },
       "locations": [],
       "docs":       {
-        "summary": "\nDeletes multiple contacts.\n\nAll contacts that meet the specified `filter` and `search` criteria are deleted.\nTo perform a dry run, use the intended filter options with\n[Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n\nWhen this endpoint is used, a bulk job is started and the job ID is returned.\nThe job might not complete right away, depending on its size.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\n \n",
+        "summary": "\nDeletes multiple contacts.\n\nAll contacts that meet the specified `filter` and `search` criteria are deleted.\nThe request should contain a `filter` value or a `search` value, or both.\nTo perform a dry run, use the intended filter options with\n[Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n\nWhen this endpoint is used, a bulk job is started and the job ID is returned.\nThe job might not complete right away, depending on its size.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\n \n",
         "description": [],
         "request": "POST",
         "url": "https://www.wixapis.com/contacts/v4/bulk/contacts/delete",
@@ -198,7 +198,7 @@
       },
       "locations": [],
       "docs":       {
-        "summary": "\nAdds and removes labels from multiple contacts.\n\nLabels are added to and removed from all contacts that meet the specified\n`filter` and `search` criteria.\nTo perform a dry run, use the intended filter options with\n[Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n\nWhen this endpoint is used, a bulk job is started and the job ID is returned.\nThe job might not not complete right away, depending on its size.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\n \n",
+        "summary": "\nAdds and removes labels from multiple contacts.\n\nLabels are added to and removed from all contacts that meet the specified\n`filter` and `search` criteria.\nThe request should contain a `filter` value or a `search` value, or both.  To perform a dry run, use the intended filter options with\n[Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n\nWhen this endpoint is used, a bulk job is started and the job ID is returned.\nThe job might not not complete right away, depending on its size.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\n \n",
         "description": [],
         "request": "POST",
         "url": "https://www.wixapis.com/contacts/v4/bulk/contacts/add-remove-labels",
@@ -931,7 +931,7 @@
         "rpcRequestName": "MergeContactsRequest",
         "rpcResponseName": "MergeContactsResponse"
       },
-      "customLabels": [{"id": "maturity-beta"}]
+      "customLabels": []
     },
         {
       "name": "Preview Merge Contacts",
@@ -994,7 +994,7 @@
         "rpcRequestName": "PreviewMergeContactsRequest",
         "rpcResponseName": "PreviewMergeContactsResponse"
       },
-      "customLabels": [{"id": "maturity-beta"}]
+      "customLabels": []
     },
         {
       "name": "Query Contacts",
@@ -1034,7 +1034,7 @@
       },
       "locations": [],
       "docs":       {
-        "summary": "\nRetrieves a list of contacts, given the provided [paging](https://dev.wix.com/api/rest/getting-started/pagination), [filtering, and sorting](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching).\nUp to 1,000 contacts can be returned per request.\n\nFor a detailed list of supported operations, see\nfiltering and sorting for\n[contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n[extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\nand [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\nTo learn how to query contacts, see\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n \n",
+        "summary": "\nRetrieves a list of contacts, given the provided [paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging), [filtering, and sorting](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/sort,-filter,-and-search).\nUp to 1,000 contacts can be returned per request.\n\nFor a detailed list of supported operations, see\nfiltering and sorting for\n[contact properties](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/sort,-filter,-and-search#contacts_contacts_contacts-v4_sort,-filter,-and-search_contact-properties-supported-filters-sorting-and-search),\n[extended fields](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/sort,-filter,-and-search#contacts_contacts_contacts-v4_sort,-filter,-and-search_extended-fields-supported-filters-sorting-and-search),\nand [custom fields](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/sort,-filter,-and-search#contacts_contacts_contacts-v4_sort,-filter,-and-search_custom-fields-supported-filters-sorting-and-search).\nTo learn how to query contacts, see\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n \n",
         "description": [],
         "request": "POST",
         "url": "https://www.wixapis.com/contacts/v4/contacts/query",
@@ -1248,15 +1248,6 @@
           "type": "All APIs.Contacts._com_wixpress_contacts_core_api_v4_ContactInfo",
           "doc": " Contact info.\n",
           "required": true
-        },
-                {
-          "in": "BODY",
-          "name": "fieldMask",
-          "type": "All APIs.Contacts._google_protobuf_FieldMask",
-          "doc": "\nSet of fields to update.\nFields that aren't included in `fieldMask.paths` are ignored.\nSee\n[Field Masks in Update Requests](https://dev.wix.com/api/rest/contacts/contacts/field-masks-in-update-requests)\nfor details on working with field masks.\n\n> **Deprecation Notice:**\n> This parameter will be removed on March 31, 2022.\n> If your app uses this parameter, update your code as soon as possible.\n",
-          "required": false,
-          "fieldMask": "RPC",
-          "deprecated": true
         }
       ],
       "ret":       {
@@ -1339,7 +1330,7 @@
         "name": "Read Contacts",
         "description": "Request permission to read the site's contact info. "
       }],
-      "customLabels": [{"id": "maturity-beta"}],
+      "customLabels": [],
       "eventType": "wix.contacts.v4.contact_merged",
       "extra": {"isDomainEvent": true}
     },
@@ -4265,13 +4256,6 @@
           "name": "info",
           "type": "All APIs.Contacts._com_wixpress_contacts_core_api_v4_ContactInfo",
           "doc": " Contact info.\n"
-        },
-                {
-          "name": "fieldMask",
-          "type": "All APIs.Contacts._google_protobuf_FieldMask",
-          "doc": "\nSet of fields to update.\nFields that aren't included in `fieldMask.paths` are ignored.\nSee\n[Field Masks in Update Requests](https://dev.wix.com/api/rest/contacts/contacts/field-masks-in-update-requests)\nfor details on working with field masks.\n\n> **Deprecation Notice:**\n> This parameter will be removed on March 31, 2022.\n> If your app uses this parameter, update your code as soon as possible.\n",
-          "fieldMask": "RPC",
-          "deprecated": true
         }
       ],
       "enum": null,

all/all-apis/contacts.service.json

@@ -0,0 +1,24 @@
+SortOrder: 0
+# About the eCommerce Abandoned Checkouts API
+
+When a customer begins an eCommerce Checkout process but doesn't complete it (for example, after closing their browser tab before putting in their payment details and making a payment), that checkout becomes an abandoned checkout. The Abandoned Checkouts API allows an app developer to help a customer recover their abandoned checkout (return to their incomplete checkout and complete the checkout). When a customer completes their checkout and makes a purchase, the checkout becomes an [order](https://dev.wix.com/api/rest/wix-ecommerce/orders). 
+
+An abandoned checkout holds buyer details, price, reference to the initial checkout, a checkout URL, and more.
+
+The eCommerce Abandoned Checkouts API provides functionality for [getting information about an abandoned checkout](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/get-abandoned-checkout) and [retrieving a list of abandoned checkouts](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/query-abandoned-checkouts). You can also listen for events when an abandoned checkout is [created](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/abandoned-checkout-created-webhook) and [recovered](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/abandoned-checkout-recovered-webhook). 
+
+To assist in migration from the Stores to eCommerce APIs, please refer to the [Stores Cart to eCommerce Checkout Conversion Table](https://dev.wix.com/api/rest/wix-ecommerce/checkout/stores-cart-to-ecommerce-checkout-object-conversion).
+
+## Terminology
+
++ **Recovered**: When a customer returns to their abandoned checkout and completes the checkout.
+
++ **Activities**: This property is only relevant if the site owner set up [automations in the Dashboard](https://support.wix.com/en/article/wix-automations-creating-a-new-automation). The `activities` property is a list of all automation activities performed by [Wix Automations](https://support.wix.com/en/article/wix-automations-getting-started) regarding the abandoned checkout. Wix Automations updates the `activities` field for each actvity in the automation flow. For example, if a site owner set up an automation to send a notification to a site visitor an hour after their abandoned checkout is created, Wix automations does the following:
+  + Updates the `activities` field to `SCHEDULED` when the abandoned checkout is created. 
+  + Updates the `activities` field to `NOTIFICATION_SENT` after an hour, when the notification is sent to the site visitor.
+
+
+  Other `actvities` include:
+    + `EMAIL_SENT` 
+    + `EMAIL_NOT_SENT`
+    + `TASK_CREATED` 

all/guides/abandoned-checkouts/docs/intro.md

@@ -0,0 +1,19 @@
+SortOrder: 1
+# Abandoned Checkouts: Sample Use Case & Flow 
+
+This article shares some possible use cases your app could support, as well as an example flow that could support each
+use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your
+app's implementation.
+
+## Redirect a site visitor with an abandoned checkout back to their checkout page
+
+If a site visitor starts a checkout but doesn't complete it, you can redirect them to their checkout page. You can also check whether the site visitor has recovered their abandoned checkout and completed the purchase. 
+
+To redirect the site visitor to their checkout page:
+
+1. Using the [Abandoned Checkout Created Webhook](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/abandoned-checkout-created-webhook), listen for an event when an abandoned checkout is created (a checkout was not completed).
+
+2. Save the newly created abandoned checkout's ID (`entityId` field) and `checkoutUrl` from the above webhook's payload. Then send a marketing campaign with the `checkoutURL` to your site visitor, redirecting them to their checkout page.
+
+3. After the marketing campaign, call [Get Abandoned Checkout](https://dev.wix.com/api/rest/wix-ecommerce/abandoned-checkouts/get-abandoned-checkout) with the abandoned checkout's ID. Then check the `status` field in the response to see if the abandoned checkout has been recovered.
+

all/guides/abandoned-checkouts/docs/sample-flows.md

@@ -0,0 +1,14 @@
+SortOrder: 2
+# Abandoned Checkouts: Supported Filters and Sorting
+
+The table below shows field support for filters and sorting for the base set of abandoned checkout properties.
+
+| Field                        | Supported Filters                             | Sortable | 
+| ---------------------------- | --------------------------------------------- | -------- |
+| `id`                         | `$eq`, `$ne`, `$in`, `$exists`                |          |
+| `createdDate`                | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`    | Sortable |
+| `updatedDate`                | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte`    | Sortable |
+| `status`                     | `$eq`                                         | Sortable |
+| `buyerInfo.email`            | `$eq`                                         |          |
+| `totalPrice.amount`          | `$eq`, `$gt`, `$lt`, `$gte`, `$lte`           | Sortable |
+| `totalPrice.convertedAmount` | `$eq`, `$gt`, `$lt`, `$gte`, `$lte`           | Sortable |

all/guides/abandoned-checkouts/docs/sort-and-filter.md

@@ -1,5 +1,21 @@
 # Release Notes
 
+## New Release: Wix eCommerce [Abandoned Checkouts API](wix-ecommerce/abandoned-checkouts)
+
+Wix eCommerce introduces the new [Abandoned Checkouts API](wix-ecommerce/abandoned-checkouts). When a customer begins an eCommerce Checkout process but doesn't complete it (for example, after closing their browser tab before putting in their payment details and making a payment), that checkout becomes an abandoned checkout. 
+
+The Abandoned Checkouts API allows an app developer to help a customer recover their abandoned checkout (return to their incomplete checkout and complete the checkout).
+
+The Abandoned Checkouts API provides the following functionalities:
+
++ [Get](wix-ecommerce/abandoned-checkouts/get-abandoned-checkout) an abandoned checkout.
++ [Query](wix-ecommerce/abandoned-checkouts/query-abandoned-checkouts) abandoned checkouts.
++ An event when an abandoned checkout is [created](wix-ecommerce/abandoned-checkouts/abandoned-checkout-created-webhook).
++ An event when an abandoned checkout is [recovered](wix-ecommerce/abandoned-checkouts/abandoned-checkout-recovered-webhook).
+
+
+(June 6, 2023)
+
 
 ## New Webhooks: [Wix Bookings V2](wix-bookings/bookings-v2)