Skip to content

Commit 5087699

Browse files
added use cases in intro
* Auto commit from WixDocs server * Auto commit from WixDocs server --------- Co-authored-by: Wixplorer <[email protected]>
1 parent c6092f9 commit 5087699

File tree

2 files changed

+138
-5
lines changed

2 files changed

+138
-5
lines changed

all/all-apis/event-guests.service.json

+133-5
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
"serviceName": "EventGuestsService",
3636
"tag": "Event Guest",
3737
"permissions": [ {
38-
"name": "Read Guests",
39-
"description": "Request permission to read basic event guests info"
38+
"name": "Read Event Tickets and Guest List",
39+
"description": "Request permission to read event tickets and guest lists."
4040
}],
4141
"events": [],
4242
"labels": [],
@@ -106,7 +106,10 @@
106106
},
107107
"topic": "domain_events_wix.events.guests.v1.guest",
108108
"tag": "Event Guest",
109-
"permissions": [],
109+
"permissions": [ {
110+
"name": "Read Event Tickets and Guest List",
111+
"description": "Request permission to read event tickets and guest lists."
112+
}],
110113
"customLabels": [],
111114
"eventType": "wix.events.guests.v1.guest_deleted",
112115
"extra": {"isDomainEvent": true}
@@ -120,7 +123,10 @@
120123
},
121124
"topic": "domain_events_wix.events.guests.v1.guest",
122125
"tag": "Event Guest",
123-
"permissions": [],
126+
"permissions": [ {
127+
"name": "Read Event Tickets and Guest List",
128+
"description": "Request permission to read event tickets and guest lists."
129+
}],
124130
"customLabels": [],
125131
"eventType": "wix.events.guests.v1.guest_updated",
126132
"extra": {"isDomainEvent": true}
@@ -134,7 +140,10 @@
134140
},
135141
"topic": "domain_events_wix.events.guests.v1.guest",
136142
"tag": "Event Guest",
137-
"permissions": [],
143+
"permissions": [ {
144+
"name": "Read Event Tickets and Guest List",
145+
"description": "Request permission to read event tickets and guest lists."
146+
}],
138147
"customLabels": [],
139148
"eventType": "wix.events.guests.v1.guest_created",
140149
"extra": {"isDomainEvent": true}
@@ -1565,6 +1574,11 @@
15651574
"name": "form",
15661575
"type": "All APIs.Event Guests._wix_events_FormResponse",
15671576
"doc": " Ticket form response (only assigned tickets contain separate forms).\n"
1577+
},
1578+
{
1579+
"name": "ticketName",
1580+
"type": "string",
1581+
"doc": " Ticket name.\n"
15681582
},
15691583
{
15701584
"name": "anonymized",
@@ -2256,6 +2270,31 @@
22562270
"enum": null,
22572271
"extra": {},
22582272
"labels": []
2273+
},
2274+
{
2275+
"name": "_wix_events_guests_v1_UpdateGuestRequest",
2276+
"displayName": "Update Guest Request Object",
2277+
"locations": [],
2278+
"docs": {
2279+
"summary": "",
2280+
"links": [],
2281+
"examples": []
2282+
},
2283+
"members": [
2284+
{
2285+
"name": "guest",
2286+
"type": "All APIs.Event Guests._wix_events_guests_v1_EventGuest",
2287+
"doc": " Updated guest\n"
2288+
},
2289+
{
2290+
"name": "revision",
2291+
"type": "string",
2292+
"doc": "Guest revision\n"
2293+
}
2294+
],
2295+
"enum": null,
2296+
"extra": {},
2297+
"labels": []
22592298
},
22602299
{
22612300
"name": "_wix_events_guests_v1_QueryEventGuestsRequest",
@@ -2446,6 +2485,95 @@
24462485
"enum": null,
24472486
"extra": {},
24482487
"labels": []
2488+
},
2489+
{
2490+
"name": "_wix_events_guests_v1_ListGuestListPreviewsRequest",
2491+
"displayName": "List Guest List Previews Request Object",
2492+
"locations": [],
2493+
"docs": {
2494+
"summary": "",
2495+
"links": [],
2496+
"examples": []
2497+
},
2498+
"members": [
2499+
{
2500+
"name": "eventIds",
2501+
"type": {
2502+
"name": "array",
2503+
"typeParams": ["string"]
2504+
},
2505+
"doc": ""
2506+
},
2507+
{
2508+
"name": "cursorPaging",
2509+
"type": "All APIs.Event Guests._wix_events_guests_upstream_wix_common_CursorPaging",
2510+
"doc": ""
2511+
}
2512+
],
2513+
"enum": null,
2514+
"extra": {},
2515+
"labels": []
2516+
},
2517+
{
2518+
"name": "_wix_events_guests_v1_ListGuestListPreviewsResponse",
2519+
"displayName": "List Guest List Previews Response Object",
2520+
"locations": [],
2521+
"docs": {
2522+
"summary": "",
2523+
"links": [],
2524+
"examples": []
2525+
},
2526+
"members": [
2527+
{
2528+
"name": "previews",
2529+
"type": {
2530+
"name": "array",
2531+
"typeParams": ["All APIs.Event Guests._wix_events_guests_v1_GuestListPreview"]
2532+
},
2533+
"doc": " List of guests.\n"
2534+
},
2535+
{
2536+
"name": "pagingMetadata",
2537+
"type": "All APIs.Event Guests._wix_events_guests_upstream_wix_common_PagingMetadataV2",
2538+
"doc": " Metadata for the paginated results.\n"
2539+
}
2540+
],
2541+
"enum": null,
2542+
"extra": {},
2543+
"labels": []
2544+
},
2545+
{
2546+
"name": "_wix_events_guests_v1_GuestListPreview",
2547+
"displayName": "Guest List Preview Object",
2548+
"locations": [],
2549+
"docs": {
2550+
"summary": "",
2551+
"links": [],
2552+
"examples": []
2553+
},
2554+
"members": [
2555+
{
2556+
"name": "eventId",
2557+
"type": "string",
2558+
"doc": ""
2559+
},
2560+
{
2561+
"name": "latestAttendingMembers",
2562+
"type": {
2563+
"name": "array",
2564+
"typeParams": ["All APIs.Event Guests._wix_events_guests_v1_EventGuest"]
2565+
},
2566+
"doc": ""
2567+
},
2568+
{
2569+
"name": "totalAttending",
2570+
"type": "integer",
2571+
"doc": ""
2572+
}
2573+
],
2574+
"enum": null,
2575+
"extra": {},
2576+
"labels": []
24492577
},
24502578
{
24512579
"name": "_wix_common_SortOrder",

all/guides/event-guests/docs/intro.md

+5
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ It’s important to note the following points before starting to code:
1717
- Guest details are returned only when the `guestDetails` fieldset is sent in the request.
1818
- 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.
1919

20+
## Use cases
21+
22+
- [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)
23+
- [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)
24+
2025
## Terminology
2126

2227
- **Guest**: The individual who has been invited to the event.

0 commit comments

Comments
 (0)