added use cases in intro

* Auto commit from WixDocs server * Auto commit from WixDocs server --------- Co-authored-by: Wixplorer <[email protected]>
wix-incubator · May 31, 2023 · 5087699 · 5087699
1 parent c6092f9
commit 5087699
Show file tree

Hide file tree

Showing 2 changed files with 138 additions and 5 deletions.
diff --git a/all/all-apis/event-guests.service.json b/all/all-apis/event-guests.service.json
@@ -35,8 +35,8 @@
     "serviceName": "EventGuestsService",
     "tag": "Event Guest",
     "permissions": [    {
-      "name": "Read Guests",
-      "description": "Request permission to read basic event guests info"
+      "name": "Read Event Tickets and Guest List",
+      "description": "Request permission to read event tickets and guest lists."
     }],
     "events": [],
     "labels": [],
@@ -106,7 +106,10 @@
       },
       "topic": "domain_events_wix.events.guests.v1.guest",
       "tag": "Event Guest",
-      "permissions": [],
+      "permissions": [      {
+        "name": "Read Event Tickets and Guest List",
+        "description": "Request permission to read event tickets and guest lists."
+      }],
       "customLabels": [],
       "eventType": "wix.events.guests.v1.guest_deleted",
       "extra": {"isDomainEvent": true}
@@ -120,7 +123,10 @@
       },
       "topic": "domain_events_wix.events.guests.v1.guest",
       "tag": "Event Guest",
-      "permissions": [],
+      "permissions": [      {
+        "name": "Read Event Tickets and Guest List",
+        "description": "Request permission to read event tickets and guest lists."
+      }],
       "customLabels": [],
       "eventType": "wix.events.guests.v1.guest_updated",
       "extra": {"isDomainEvent": true}
@@ -134,7 +140,10 @@
       },
       "topic": "domain_events_wix.events.guests.v1.guest",
       "tag": "Event Guest",
-      "permissions": [],
+      "permissions": [      {
+        "name": "Read Event Tickets and Guest List",
+        "description": "Request permission to read event tickets and guest lists."
+      }],
       "customLabels": [],
       "eventType": "wix.events.guests.v1.guest_created",
       "extra": {"isDomainEvent": true}
@@ -1565,6 +1574,11 @@
           "name": "form",
           "type": "All APIs.Event Guests._wix_events_FormResponse",
           "doc": " Ticket form response (only assigned tickets contain separate forms).\n"
+        },
+                {
+          "name": "ticketName",
+          "type": "string",
+          "doc": " Ticket name.\n"
         },
                 {
           "name": "anonymized",
@@ -2256,6 +2270,31 @@
       "enum": null,
       "extra": {},
       "labels": []
+    },
+        {
+      "name": "_wix_events_guests_v1_UpdateGuestRequest",
+      "displayName": "Update Guest Request Object",
+      "locations": [],
+      "docs":       {
+        "summary": "",
+        "links": [],
+        "examples": []
+      },
+      "members":       [
+                {
+          "name": "guest",
+          "type": "All APIs.Event Guests._wix_events_guests_v1_EventGuest",
+          "doc": " Updated guest\n"
+        },
+                {
+          "name": "revision",
+          "type": "string",
+          "doc": "Guest revision\n"
+        }
+      ],
+      "enum": null,
+      "extra": {},
+      "labels": []
     },
         {
       "name": "_wix_events_guests_v1_QueryEventGuestsRequest",
@@ -2446,6 +2485,95 @@
       "enum": null,
       "extra": {},
       "labels": []
+    },
+        {
+      "name": "_wix_events_guests_v1_ListGuestListPreviewsRequest",
+      "displayName": "List Guest List Previews Request Object",
+      "locations": [],
+      "docs":       {
+        "summary": "",
+        "links": [],
+        "examples": []
+      },
+      "members":       [
+                {
+          "name": "eventIds",
+          "type":           {
+            "name": "array",
+            "typeParams": ["string"]
+          },
+          "doc": ""
+        },
+                {
+          "name": "cursorPaging",
+          "type": "All APIs.Event Guests._wix_events_guests_upstream_wix_common_CursorPaging",
+          "doc": ""
+        }
+      ],
+      "enum": null,
+      "extra": {},
+      "labels": []
+    },
+        {
+      "name": "_wix_events_guests_v1_ListGuestListPreviewsResponse",
+      "displayName": "List Guest List Previews Response Object",
+      "locations": [],
+      "docs":       {
+        "summary": "",
+        "links": [],
+        "examples": []
+      },
+      "members":       [
+                {
+          "name": "previews",
+          "type":           {
+            "name": "array",
+            "typeParams": ["All APIs.Event Guests._wix_events_guests_v1_GuestListPreview"]
+          },
+          "doc": " List of guests.\n"
+        },
+                {
+          "name": "pagingMetadata",
+          "type": "All APIs.Event Guests._wix_events_guests_upstream_wix_common_PagingMetadataV2",
+          "doc": " Metadata for the paginated results.\n"
+        }
+      ],
+      "enum": null,
+      "extra": {},
+      "labels": []
+    },
+        {
+      "name": "_wix_events_guests_v1_GuestListPreview",
+      "displayName": "Guest List Preview Object",
+      "locations": [],
+      "docs":       {
+        "summary": "",
+        "links": [],
+        "examples": []
+      },
+      "members":       [
+                {
+          "name": "eventId",
+          "type": "string",
+          "doc": ""
+        },
+                {
+          "name": "latestAttendingMembers",
+          "type":           {
+            "name": "array",
+            "typeParams": ["All APIs.Event Guests._wix_events_guests_v1_EventGuest"]
+          },
+          "doc": ""
+        },
+                {
+          "name": "totalAttending",
+          "type": "integer",
+          "doc": ""
+        }
+      ],
+      "enum": null,
+      "extra": {},
+      "labels": []
     },
         {
       "name": "_wix_common_SortOrder",

diff --git a/all/guides/event-guests/docs/intro.md b/all/guides/event-guests/docs/intro.md
@@ -17,6 +17,11 @@ It’s important to note the following points before starting to code:
 - Guest details are returned only when the `guestDetails` fieldset is sent in the request.
 - In some situations, certain webhooks might be triggered twice. For example, changing a guest's name triggers the [Event Guest Updated](https://dev.wix.com/api/rest/wix-events/event-guests/event-guest-updated-webhook) webhook 2 times -- once for the change of name and once for the change of order, which also occured. While technically correct behavior, this might cause the undesired side effect of duplicated actions. Make sure to explicitly add code to make sure parts of your code only run once.
 
+## Use cases
+
+- [Send invitations to customers for a new event](https://dev.wix.com/api/rest/wix-events/event-guests/sample-use-cases-and-flows#wix-events_event-guests_sample-use-cases-and-flows_send-invitations-to-customers-for-a-new-event)
+- [Get guest attendance analytics from your analytics system](https://dev.wix.com/api/rest/wix-events/event-guests/sample-use-cases-and-flows#wix-events_event-guests_sample-use-cases-and-flows_get-guest-attendance-analytics-from-your-analytics-system)
+
 ## Terminology
 
 - **Guest**: The individual who has been invited to the event.