@connectedxm/admin-sdk 7.5.0 → 7.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (211) hide show
  1. package/.openapi-generator/FILES +1 -0
  2. package/README.md +1215 -1212
  3. package/api.ts +9898 -9710
  4. package/dist/api.d.ts +9807 -9710
  5. package/dist/api.js +9842 -9696
  6. package/dist/esm/api.d.ts +9807 -9710
  7. package/dist/esm/api.js +9842 -9696
  8. package/docs/AccountsAddressesApi.md +10 -10
  9. package/docs/AccountsApi.md +42 -42
  10. package/docs/AccountsFollowersApi.md +6 -6
  11. package/docs/AccountsFollowingApi.md +6 -6
  12. package/docs/AccountsGroupsApi.md +6 -6
  13. package/docs/AccountsInterestsApi.md +6 -6
  14. package/docs/AccountsInvitationsApi.md +6 -6
  15. package/docs/AccountsLeadsApi.md +8 -8
  16. package/docs/AccountsTiersApi.md +8 -8
  17. package/docs/ActivitiesApi.md +18 -18
  18. package/docs/ActivitiesScheduleApi.md +4 -4
  19. package/docs/AdvertisementsApi.md +14 -14
  20. package/docs/AnnouncementsApi.md +16 -16
  21. package/docs/AnnouncementsScheduleApi.md +4 -4
  22. package/docs/AnnouncementsTranslationsApi.md +8 -8
  23. package/docs/ApiLogsApi.md +4 -4
  24. package/docs/AuthSessionsApi.md +4 -4
  25. package/docs/BaseEvent.md +6 -0
  26. package/docs/BaseEventSessionLocation.md +2 -0
  27. package/docs/BenefitsApi.md +12 -12
  28. package/docs/BenefitsTranslationsApi.md +8 -8
  29. package/docs/BookingsApi.md +56 -56
  30. package/docs/BookingsAvailabilitiesApi.md +6 -6
  31. package/docs/BookingsBlackoutsApi.md +6 -6
  32. package/docs/BookingsPlacesApi.md +6 -6
  33. package/docs/BookingsPlacesTranslationsApi.md +4 -4
  34. package/docs/BookingsQuestionsApi.md +16 -16
  35. package/docs/BookingsQuestionsChoicesApi.md +12 -12
  36. package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
  37. package/docs/BookingsQuestionsTranslationsApi.md +8 -8
  38. package/docs/BookingsSpacesApi.md +6 -6
  39. package/docs/BookingsSpacesTranslationsApi.md +4 -4
  40. package/docs/ChannelsApi.md +58 -58
  41. package/docs/ChannelsTranslationsApi.md +24 -24
  42. package/docs/DashboardsApi.md +10 -10
  43. package/docs/DashboardsWidgetsApi.md +8 -8
  44. package/docs/EmailReceiptsApi.md +4 -4
  45. package/docs/Event.md +10 -0
  46. package/docs/EventCreateInputs.md +0 -14
  47. package/docs/EventLocationInputs.md +38 -0
  48. package/docs/EventSessionLocation.md +6 -0
  49. package/docs/EventSessionLocationCreateInputs.md +2 -0
  50. package/docs/EventSessionLocationUpdateInputs.md +2 -0
  51. package/docs/EventUpdateInputs.md +0 -14
  52. package/docs/EventsAccessApi.md +6 -6
  53. package/docs/EventsActivationsApi.md +22 -22
  54. package/docs/EventsActivationsSessionsApi.md +6 -6
  55. package/docs/EventsActivationsTranslationsApi.md +8 -8
  56. package/docs/EventsAddonsApi.md +24 -24
  57. package/docs/EventsAddonsTranslationsApi.md +8 -8
  58. package/docs/EventsApi.md +130 -22
  59. package/docs/EventsAttendeesApi.md +24 -24
  60. package/docs/EventsAttendeesPackagesApi.md +10 -10
  61. package/docs/EventsAttendeesReservationsApi.md +18 -18
  62. package/docs/EventsAttributesApi.md +10 -10
  63. package/docs/EventsBenefitsApi.md +4 -4
  64. package/docs/EventsBlocksApi.md +16 -16
  65. package/docs/EventsBypassApi.md +10 -10
  66. package/docs/EventsCohostsApi.md +6 -6
  67. package/docs/EventsCouponsApi.md +28 -28
  68. package/docs/EventsEmailsApi.md +4 -4
  69. package/docs/EventsEmailsTranslationsApi.md +8 -8
  70. package/docs/EventsFaqsApi.md +22 -22
  71. package/docs/EventsFaqsTranslationsApi.md +16 -16
  72. package/docs/EventsFollowupsApi.md +38 -38
  73. package/docs/EventsFollowupsTranslationsApi.md +8 -8
  74. package/docs/EventsMatchesApi.md +34 -34
  75. package/docs/EventsMediaApi.md +16 -16
  76. package/docs/EventsMediaTranslationsApi.md +8 -8
  77. package/docs/EventsOnSiteApi.md +6 -6
  78. package/docs/EventsPackagesApi.md +10 -10
  79. package/docs/EventsPackagesPassesApi.md +10 -10
  80. package/docs/EventsPackagesTranslationsApi.md +8 -8
  81. package/docs/EventsPagesApi.md +16 -16
  82. package/docs/EventsPagesTranslationsApi.md +8 -8
  83. package/docs/EventsPassesAccessesApi.md +10 -10
  84. package/docs/EventsPassesAddonsApi.md +6 -6
  85. package/docs/EventsPassesApi.md +34 -34
  86. package/docs/EventsPassesAttributesApi.md +6 -6
  87. package/docs/EventsPassesFollowupsApi.md +8 -8
  88. package/docs/EventsPassesResponsesApi.md +10 -10
  89. package/docs/EventsPasstypesApi.md +34 -34
  90. package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
  91. package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
  92. package/docs/EventsPasstypesTranslationsApi.md +8 -8
  93. package/docs/EventsQuestionsApi.md +44 -44
  94. package/docs/EventsQuestionsTranslationsApi.md +16 -16
  95. package/docs/EventsRoomsApi.md +18 -18
  96. package/docs/EventsRoomtypesApi.md +24 -24
  97. package/docs/EventsRoomtypesTranslationsApi.md +8 -8
  98. package/docs/EventsSectionsApi.md +38 -38
  99. package/docs/EventsSectionsTranslationsApi.md +8 -8
  100. package/docs/EventsSessionsAccessesApi.md +6 -6
  101. package/docs/EventsSessionsApi.md +70 -70
  102. package/docs/EventsSessionsLocationsApi.md +16 -16
  103. package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
  104. package/docs/EventsSessionsMatchesApi.md +32 -32
  105. package/docs/EventsSessionsPricesApi.md +6 -6
  106. package/docs/EventsSessionsQuestionsApi.md +38 -38
  107. package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
  108. package/docs/EventsSessionsSectionsApi.md +20 -20
  109. package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
  110. package/docs/EventsSessionsTimesApi.md +16 -16
  111. package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
  112. package/docs/EventsSessionsTranslationsApi.md +8 -8
  113. package/docs/EventsSpeakersApi.md +16 -16
  114. package/docs/EventsSpeakersTranslationsApi.md +8 -8
  115. package/docs/EventsSponsorsApi.md +8 -8
  116. package/docs/EventsSponsorshiplevelsApi.md +12 -12
  117. package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
  118. package/docs/EventsSponsorshipsApi.md +12 -12
  119. package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
  120. package/docs/EventsTemplatesApi.md +2 -2
  121. package/docs/EventsTracksApi.md +22 -22
  122. package/docs/EventsTracksTranslationsApi.md +8 -8
  123. package/docs/EventsTransfersApi.md +4 -4
  124. package/docs/EventsTranslationsApi.md +8 -8
  125. package/docs/FilesApi.md +4 -4
  126. package/docs/GroupsApi.md +12 -12
  127. package/docs/GroupsEventsApi.md +6 -6
  128. package/docs/GroupsInterestsApi.md +6 -6
  129. package/docs/GroupsInvitationsApi.md +12 -12
  130. package/docs/GroupsMembersApi.md +8 -8
  131. package/docs/GroupsModeratorsApi.md +6 -6
  132. package/docs/GroupsRequestsApi.md +10 -10
  133. package/docs/GroupsSponsorsApi.md +6 -6
  134. package/docs/GroupsTranslationsApi.md +8 -8
  135. package/docs/ImportsApi.md +8 -8
  136. package/docs/InterestsApi.md +22 -22
  137. package/docs/InvoicesApi.md +20 -20
  138. package/docs/InvoicesLineitemsApi.md +6 -6
  139. package/docs/LoginsAccountsApi.md +6 -6
  140. package/docs/LoginsApi.md +16 -16
  141. package/docs/MeetingsApi.md +14 -14
  142. package/docs/MeetingsLinksApi.md +10 -10
  143. package/docs/MeetingsLivestreamsApi.md +12 -12
  144. package/docs/MeetingsParticipantsApi.md +12 -12
  145. package/docs/MeetingsPresetsApi.md +10 -10
  146. package/docs/MeetingsRecordingsApi.md +4 -4
  147. package/docs/MeetingsSessionsApi.md +16 -16
  148. package/docs/NotificationsApi.md +8 -8
  149. package/docs/OrganizationApi.md +18 -18
  150. package/docs/OrganizationAttributesApi.md +14 -14
  151. package/docs/OrganizationDomainsApi.md +6 -6
  152. package/docs/OrganizationIntegrationsApi.md +10 -10
  153. package/docs/OrganizationModulesApi.md +6 -6
  154. package/docs/OrganizationModulesCustomApi.md +10 -10
  155. package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
  156. package/docs/OrganizationModulesSettingsApi.md +4 -4
  157. package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
  158. package/docs/OrganizationModulesTiersApi.md +12 -12
  159. package/docs/OrganizationPaymentsApi.md +20 -20
  160. package/docs/OrganizationSideeffectsApi.md +8 -8
  161. package/docs/OrganizationTaxApi.md +22 -22
  162. package/docs/OrganizationTeammembersApi.md +10 -10
  163. package/docs/OrganizationUsersApi.md +6 -6
  164. package/docs/OrganizationWebhooksApi.md +12 -12
  165. package/docs/PaymentsApi.md +2 -2
  166. package/docs/PreferencesApi.md +4 -4
  167. package/docs/PushDevicesApi.md +6 -6
  168. package/docs/ReportsApi.md +22 -22
  169. package/docs/ReportsUsersApi.md +6 -6
  170. package/docs/SearchlistsApi.md +10 -10
  171. package/docs/SearchlistsValuesApi.md +14 -14
  172. package/docs/SelfApi.md +10 -10
  173. package/docs/SelfApikeysApi.md +8 -8
  174. package/docs/SelfImagesApi.md +4 -4
  175. package/docs/SeriesApi.md +18 -18
  176. package/docs/SeriesQuestionsApi.md +14 -14
  177. package/docs/SeriesQuestionsChoicesApi.md +8 -8
  178. package/docs/SeriesQuestionsTranslationsApi.md +4 -4
  179. package/docs/SeriesRegistrationsApi.md +18 -18
  180. package/docs/SeriesTranslationsApi.md +8 -8
  181. package/docs/SponsorsAccountsApi.md +6 -6
  182. package/docs/SponsorsApi.md +10 -10
  183. package/docs/SponsorsTranslationsApi.md +8 -8
  184. package/docs/StorageFilesApi.md +6 -6
  185. package/docs/StorageImagesApi.md +18 -18
  186. package/docs/StorageVideosApi.md +14 -14
  187. package/docs/StorageVideosCaptionsApi.md +10 -10
  188. package/docs/StreamsApi.md +14 -14
  189. package/docs/StreamsOutputsApi.md +10 -10
  190. package/docs/StreamsSessionsApi.md +12 -12
  191. package/docs/SupportApi.md +14 -14
  192. package/docs/SupportMessagesApi.md +4 -4
  193. package/docs/SupportNotesApi.md +6 -6
  194. package/docs/SurveysApi.md +12 -12
  195. package/docs/SurveysQuestionsApi.md +38 -38
  196. package/docs/SurveysQuestionsTranslationsApi.md +16 -16
  197. package/docs/SurveysSectionsApi.md +20 -20
  198. package/docs/SurveysSectionsTranslationsApi.md +8 -8
  199. package/docs/SurveysSessionsApi.md +4 -4
  200. package/docs/SurveysSubmissionsApi.md +14 -14
  201. package/docs/SurveysTranslationsApi.md +8 -8
  202. package/docs/ThreadsAccountsApi.md +8 -8
  203. package/docs/ThreadsApi.md +10 -10
  204. package/docs/ThreadsMessagesApi.md +12 -12
  205. package/docs/ThreadsMessagesFilesApi.md +6 -6
  206. package/docs/ThreadsMessagesImagesApi.md +6 -6
  207. package/docs/ThreadsMessagesReactionsApi.md +6 -6
  208. package/docs/ThreadsMessagesVideosApi.md +6 -6
  209. package/docs/ThreadsStorageApi.md +6 -6
  210. package/docs/TiersApi.md +20 -20
  211. package/package.json +1 -1
@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createDashboard**](#createdashboard) | **POST** /dashboards | Create Dashboard|
8
- |[**deleteDashboard**](#deletedashboard) | **DELETE** /dashboards/{dashboardId} | Delete Dashboard|
9
- |[**getDashboard**](#getdashboard) | **GET** /dashboards/{dashboardId} | Get Dashboard|
10
- |[**getDashboards**](#getdashboards) | **GET** /dashboards | Get Dashboards|
11
- |[**updateDashboard**](#updatedashboard) | **PUT** /dashboards/{dashboardId} | Update Dashboard|
7
+ |[**createDashboard**](#createdashboard) | **POST** /dashboards | Create a dashboard|
8
+ |[**deleteDashboard**](#deletedashboard) | **DELETE** /dashboards/{dashboardId} | Delete a dashboard|
9
+ |[**getDashboard**](#getdashboard) | **GET** /dashboards/{dashboardId} | Get a dashboard|
10
+ |[**getDashboards**](#getdashboards) | **GET** /dashboards | List dashboards|
11
+ |[**updateDashboard**](#updatedashboard) | **PUT** /dashboards/{dashboardId} | Update a dashboard|
12
12
 
13
13
  # **createDashboard**
14
14
  > CreateDashboard200Response createDashboard(dashboardCreateInputs)
15
15
 
16
- Create Dashboard endpoint
16
+ Creates a new analytics dashboard for the organization, optionally scoped to a specific event, and requires create permission on dashboards.
17
17
 
18
18
  ### Example
19
19
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createDashboard(
65
65
  # **deleteDashboard**
66
66
  > SyncAccounts200Response deleteDashboard()
67
67
 
68
- Delete Dashboard endpoint
68
+ Permanently deletes an analytics dashboard, including its widgets, and requires delete permission on dashboards.
69
69
 
70
70
  ### Example
71
71
 
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.deleteDashboard(
116
116
  # **getDashboard**
117
117
  > CreateDashboard200Response getDashboard()
118
118
 
119
- Get Dashboard endpoint
119
+ Returns a single dashboard by ID, including its configuration; requires read permission on dashboards.
120
120
 
121
121
  ### Example
122
122
 
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getDashboard(
167
167
  # **getDashboards**
168
168
  > GetDashboards200Response getDashboards()
169
169
 
170
- Get Dashboards endpoint
170
+ Returns a paginated list of the organization\'s dashboards, optionally filtered to those belonging to a specific event; requires read permission on dashboards.
171
171
 
172
172
  ### Example
173
173
 
@@ -230,7 +230,7 @@ const { status, data } = await apiInstance.getDashboards(
230
230
  # **updateDashboard**
231
231
  > CreateDashboard200Response updateDashboard(dashboardUpdateInputs)
232
232
 
233
- Update Dashboard endpoint
233
+ Updates properties of an existing analytics dashboard, such as its name, and requires update permission on dashboards.
234
234
 
235
235
  ### Example
236
236
 
@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createDashboardWidget**](#createdashboardwidget) | **POST** /dashboards/{dashboardId}/widgets | Create Dashboard Widget|
8
- |[**deleteDashboardWidget**](#deletedashboardwidget) | **DELETE** /dashboards/{dashboardId}/widgets/{widgetId} | Delete Dashboard Widget|
9
- |[**getDashboardWidgets**](#getdashboardwidgets) | **GET** /dashboard/{dashboardId}/widgets | Get Dashboard Widgets|
10
- |[**updateDashboardWidget**](#updatedashboardwidget) | **PUT** /dashboards/{dashboardId}/widgets/{widgetId} | Update Dashboard Widget|
7
+ |[**createDashboardWidget**](#createdashboardwidget) | **POST** /dashboards/{dashboardId}/widgets | Add a widget to a dashboard|
8
+ |[**deleteDashboardWidget**](#deletedashboardwidget) | **DELETE** /dashboards/{dashboardId}/widgets/{widgetId} | Remove a widget from a dashboard|
9
+ |[**getDashboardWidgets**](#getdashboardwidgets) | **GET** /dashboard/{dashboardId}/widgets | List widgets available for a dashboard|
10
+ |[**updateDashboardWidget**](#updatedashboardwidget) | **PUT** /dashboards/{dashboardId}/widgets/{widgetId} | Update a dashboard widget|
11
11
 
12
12
  # **createDashboardWidget**
13
13
  > CreateDashboardWidget200Response createDashboardWidget(dashboardWidgetCreateInputs)
14
14
 
15
- Create Dashboard Widget endpoint
15
+ Creates a new widget on a dashboard using a specified analytics endpoint and widget configuration, and requires update permission on dashboards.
16
16
 
17
17
  ### Example
18
18
 
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.createDashboardWidget(
67
67
  # **deleteDashboardWidget**
68
68
  > SyncAccounts200Response deleteDashboardWidget()
69
69
 
70
- Delete Dashboard Widget endpoint
70
+ Permanently deletes a single widget from a dashboard, and requires update permission on dashboards.
71
71
 
72
72
  ### Example
73
73
 
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.deleteDashboardWidget(
121
121
  # **getDashboardWidgets**
122
122
  > GetDashboardWidgets200Response getDashboardWidgets()
123
123
 
124
- Get Dashboard Widgets endpoint
124
+ Returns the analytics widgets that can be added to the given dashboard, scoped to event or session widgets for event dashboards and organization widgets otherwise, optionally filtered by widget type; requires read permission on dashboards.
125
125
 
126
126
  ### Example
127
127
 
@@ -175,7 +175,7 @@ const { status, data } = await apiInstance.getDashboardWidgets(
175
175
  # **updateDashboardWidget**
176
176
  > CreateDashboardWidget200Response updateDashboardWidget(dashboardWidgetUpdateInputs)
177
177
 
178
- Update Dashboard Widget endpoint
178
+ Updates the configuration of an existing widget on a dashboard, such as its layout, title, or settings, and requires update permission on dashboards.
179
179
 
180
180
  ### Example
181
181
 
@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**getEmailReceipt**](#getemailreceipt) | **GET** /logs/email-receipts/{emailReceiptId} | Get Email Receipt|
8
- |[**getEmailReceipts**](#getemailreceipts) | **GET** /logs/email-receipts | Get Email Receipts|
7
+ |[**getEmailReceipt**](#getemailreceipt) | **GET** /logs/email-receipts/{emailReceiptId} | Get an email receipt|
8
+ |[**getEmailReceipts**](#getemailreceipts) | **GET** /logs/email-receipts | List email receipts|
9
9
 
10
10
  # **getEmailReceipt**
11
11
  > GetEmailReceipt200Response getEmailReceipt()
12
12
 
13
- Get Email Receipt endpoint
13
+ Returns a single logged email receipt by ID, including its delivery status; requires read permission on logs.
14
14
 
15
15
  ### Example
16
16
 
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.getEmailReceipt(
61
61
  # **getEmailReceipts**
62
62
  > GetEmailReceipts200Response getEmailReceipts()
63
63
 
64
- Get Email Receipts endpoint
64
+ Returns a paginated list of logged email receipts for the organization, optionally filtered by delivery status and searched by keyword; requires read permission on logs.
65
65
 
66
66
  ### Example
67
67
 
package/docs/Event.md CHANGED
@@ -26,6 +26,9 @@ Name | Type | Description | Notes
26
26
  **state** | **string** | | [default to undefined]
27
27
  **country** | **string** | | [default to undefined]
28
28
  **zip** | **string** | | [default to undefined]
29
+ **location** | **string** | | [default to undefined]
30
+ **latitude** | **number** | | [default to undefined]
31
+ **longitude** | **number** | | [default to undefined]
29
32
  **imageId** | **string** | | [default to undefined]
30
33
  **image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
31
34
  **squareImageId** | **string** | | [default to undefined]
@@ -40,6 +43,8 @@ Name | Type | Description | Notes
40
43
  **paymentIntegrationId** | **string** | | [default to undefined]
41
44
  **paymentIntegration** | [**BasePaymentIntegration**](BasePaymentIntegration.md) | | [default to undefined]
42
45
  **archived** | **boolean** | | [default to undefined]
46
+ **mapImageLightUrl** | **string** | | [default to undefined]
47
+ **mapImageDarkUrl** | **string** | | [default to undefined]
43
48
  **roundName** | **string** | | [default to undefined]
44
49
  **matchName** | **string** | | [default to undefined]
45
50
  **passSupply** | **number** | | [default to undefined]
@@ -112,6 +117,9 @@ const instance: Event = {
112
117
  state,
113
118
  country,
114
119
  zip,
120
+ location,
121
+ latitude,
122
+ longitude,
115
123
  imageId,
116
124
  image,
117
125
  squareImageId,
@@ -126,6 +134,8 @@ const instance: Event = {
126
134
  paymentIntegrationId,
127
135
  paymentIntegration,
128
136
  archived,
137
+ mapImageLightUrl,
138
+ mapImageDarkUrl,
129
139
  roundName,
130
140
  matchName,
131
141
  passSupply,
@@ -23,13 +23,6 @@ Name | Type | Description | Notes
23
23
  **imageId** | **string** | | [optional] [default to undefined]
24
24
  **squareImageId** | **string** | | [optional] [default to undefined]
25
25
  **backgroundImageId** | **string** | | [optional] [default to undefined]
26
- **venue** | **string** | | [optional] [default to undefined]
27
- **address1** | **string** | | [optional] [default to undefined]
28
- **address2** | **string** | | [optional] [default to undefined]
29
- **city** | **string** | | [optional] [default to undefined]
30
- **state** | **string** | | [optional] [default to undefined]
31
- **country** | **string** | | [optional] [default to undefined]
32
- **zip** | **string** | | [optional] [default to undefined]
33
26
  **creatorId** | **string** | | [optional] [default to undefined]
34
27
  **seriesId** | **string** | | [optional] [default to undefined]
35
28
  **registration** | **boolean** | | [optional] [default to undefined]
@@ -92,13 +85,6 @@ const instance: EventCreateInputs = {
92
85
  imageId,
93
86
  squareImageId,
94
87
  backgroundImageId,
95
- venue,
96
- address1,
97
- address2,
98
- city,
99
- state,
100
- country,
101
- zip,
102
88
  creatorId,
103
89
  seriesId,
104
90
  registration,
@@ -0,0 +1,38 @@
1
+ # EventLocationInputs
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **venue** | **string** | | [optional] [default to undefined]
9
+ **location** | **string** | | [optional] [default to undefined]
10
+ **address1** | **string** | | [optional] [default to undefined]
11
+ **address2** | **string** | | [optional] [default to undefined]
12
+ **city** | **string** | | [optional] [default to undefined]
13
+ **state** | **string** | | [optional] [default to undefined]
14
+ **country** | **string** | | [optional] [default to undefined]
15
+ **zip** | **string** | | [optional] [default to undefined]
16
+ **latitude** | **number** | | [optional] [default to undefined]
17
+ **longitude** | **number** | | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { EventLocationInputs } from '@connectedxm/admin-sdk';
23
+
24
+ const instance: EventLocationInputs = {
25
+ venue,
26
+ location,
27
+ address1,
28
+ address2,
29
+ city,
30
+ state,
31
+ country,
32
+ zip,
33
+ latitude,
34
+ longitude,
35
+ };
36
+ ```
37
+
38
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -13,7 +13,10 @@ Name | Type | Description | Notes
13
13
  **city** | **string** | | [default to undefined]
14
14
  **state** | **string** | | [default to undefined]
15
15
  **country** | **string** | | [default to undefined]
16
+ **location** | **string** | | [default to undefined]
16
17
  **image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
18
+ **latitude** | **number** | | [default to undefined]
19
+ **longitude** | **number** | | [default to undefined]
17
20
  **description** | **string** | | [default to undefined]
18
21
  **createdAt** | **string** | | [default to undefined]
19
22
  **updatedAt** | **string** | | [default to undefined]
@@ -32,7 +35,10 @@ const instance: EventSessionLocation = {
32
35
  city,
33
36
  state,
34
37
  country,
38
+ location,
35
39
  image,
40
+ latitude,
41
+ longitude,
36
42
  description,
37
43
  createdAt,
38
44
  updatedAt,
@@ -5,6 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
+ **location** | **string** | | [optional] [default to undefined]
8
9
  **name** | **string** | | [default to undefined]
9
10
  **description** | **string** | | [optional] [default to undefined]
10
11
  **imageId** | **string** | | [optional] [default to undefined]
@@ -21,6 +22,7 @@ Name | Type | Description | Notes
21
22
  import { EventSessionLocationCreateInputs } from '@connectedxm/admin-sdk';
22
23
 
23
24
  const instance: EventSessionLocationCreateInputs = {
25
+ location,
24
26
  name,
25
27
  description,
26
28
  imageId,
@@ -5,6 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
+ **location** | **string** | | [optional] [default to undefined]
8
9
  **name** | **string** | | [optional] [default to undefined]
9
10
  **description** | **string** | | [optional] [default to undefined]
10
11
  **imageId** | **string** | | [optional] [default to undefined]
@@ -21,6 +22,7 @@ Name | Type | Description | Notes
21
22
  import { EventSessionLocationUpdateInputs } from '@connectedxm/admin-sdk';
22
23
 
23
24
  const instance: EventSessionLocationUpdateInputs = {
25
+ location,
24
26
  name,
25
27
  description,
26
28
  imageId,
@@ -23,13 +23,6 @@ Name | Type | Description | Notes
23
23
  **imageId** | **string** | | [optional] [default to undefined]
24
24
  **squareImageId** | **string** | | [optional] [default to undefined]
25
25
  **backgroundImageId** | **string** | | [optional] [default to undefined]
26
- **venue** | **string** | | [optional] [default to undefined]
27
- **address1** | **string** | | [optional] [default to undefined]
28
- **address2** | **string** | | [optional] [default to undefined]
29
- **city** | **string** | | [optional] [default to undefined]
30
- **state** | **string** | | [optional] [default to undefined]
31
- **country** | **string** | | [optional] [default to undefined]
32
- **zip** | **string** | | [optional] [default to undefined]
33
26
  **creatorId** | **string** | | [optional] [default to undefined]
34
27
  **seriesId** | **string** | | [optional] [default to undefined]
35
28
  **registration** | **boolean** | | [optional] [default to undefined]
@@ -92,13 +85,6 @@ const instance: EventUpdateInputs = {
92
85
  imageId,
93
86
  squareImageId,
94
87
  backgroundImageId,
95
- venue,
96
- address1,
97
- address2,
98
- city,
99
- state,
100
- country,
101
- zip,
102
88
  creatorId,
103
89
  seriesId,
104
90
  registration,
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**addEventAccessUser**](#addeventaccessuser) | **POST** /events/{eventId}/access-users | Add Event Access User|
8
- |[**getEventAccessUsers**](#geteventaccessusers) | **GET** /events/{eventId}/access-users | Get Event Access Users|
9
- |[**removeEventAccessUser**](#removeeventaccessuser) | **DELETE** /events/{eventId}/access-users/{userId} | Remove Event Access User|
7
+ |[**addEventAccessUser**](#addeventaccessuser) | **POST** /events/{eventId}/access-users | Grant a user access to an event|
8
+ |[**getEventAccessUsers**](#geteventaccessusers) | **GET** /events/{eventId}/access-users | List an event\'s access users|
9
+ |[**removeEventAccessUser**](#removeeventaccessuser) | **DELETE** /events/{eventId}/access-users/{userId} | Revoke a user\'s private event access|
10
10
 
11
11
  # **addEventAccessUser**
12
12
  > SyncAccounts200Response addEventAccessUser()
13
13
 
14
- Add Event Access User endpoint
14
+ Looks up an existing platform user by email and grants them admin access to manage a specific event, and requires update permission on events; fails if no user with that email exists.
15
15
 
16
16
  ### Example
17
17
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addEventAccessUser(
65
65
  # **getEventAccessUsers**
66
66
  > GetEventAccessUsers200Response getEventAccessUsers()
67
67
 
68
- Get Event Access Users endpoint
68
+ Returns a paginated list of users granted access to the given private or restricted event, searchable by keyword; requires read permission on events.
69
69
 
70
70
  ### Example
71
71
 
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getEventAccessUsers(
128
128
  # **removeEventAccessUser**
129
129
  > SyncAccounts200Response removeEventAccessUser()
130
130
 
131
- Remove Event Access User endpoint
131
+ Removes a user from the list of users explicitly granted access to a private event, revoking their ability to view or purchase it; requires update permission on events.
132
132
 
133
133
  ### Example
134
134
 
@@ -4,22 +4,22 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createEventActivation**](#createeventactivation) | **POST** /events/{eventId}/activations | Create Event Activation|
8
- |[**createEventActivationCompletion**](#createeventactivationcompletion) | **POST** /events/{eventId}/activations/{activationId}/completions | Create Event Activation Completion|
9
- |[**deleteEventActivation**](#deleteeventactivation) | **DELETE** /events/{eventId}/activations/{activationId} | Delete Event Activation|
10
- |[**deleteEventActivationCompletion**](#deleteeventactivationcompletion) | **DELETE** /events/{eventId}/activations/{activationId}/completions/{completionId} | Delete Event Activation Completion|
11
- |[**getEventActivation**](#geteventactivation) | **GET** /events/{eventId}/activations/{activationId} | Get Event Activation|
12
- |[**getEventActivationCompletion**](#geteventactivationcompletion) | **GET** /events/{eventId}/activations/{activationId}/completions/{completionId} | Get Event Activation Completion|
13
- |[**getEventActivationCompletions**](#geteventactivationcompletions) | **GET** /events/{eventId}/activations/{activationId}/completions | Get Event Activation Completions|
14
- |[**getEventActivationSessions**](#geteventactivationsessions) | **GET** /events/{eventId}/activations/{activationId}/sessions | Get Event Activation Sessions|
15
- |[**getEventActivations**](#geteventactivations) | **GET** /events/{eventId}/activations | Get Event Activations|
16
- |[**updateEventActivation**](#updateeventactivation) | **PUT** /events/{eventId}/activations/{activationId} | Update Event Activation|
17
- |[**updateEventActivationCompletion**](#updateeventactivationcompletion) | **PUT** /events/{eventId}/activations/{activationId}/completions/{completionId} | Update Event Activation Completion|
7
+ |[**createEventActivation**](#createeventactivation) | **POST** /events/{eventId}/activations | Create an event activation|
8
+ |[**createEventActivationCompletion**](#createeventactivationcompletion) | **POST** /events/{eventId}/activations/{activationId}/completions | Record an attendee\'s activation completion|
9
+ |[**deleteEventActivation**](#deleteeventactivation) | **DELETE** /events/{eventId}/activations/{activationId} | Delete an event activation|
10
+ |[**deleteEventActivationCompletion**](#deleteeventactivationcompletion) | **DELETE** /events/{eventId}/activations/{activationId}/completions/{completionId} | Delete an activation completion record|
11
+ |[**getEventActivation**](#geteventactivation) | **GET** /events/{eventId}/activations/{activationId} | Get an event activation|
12
+ |[**getEventActivationCompletion**](#geteventactivationcompletion) | **GET** /events/{eventId}/activations/{activationId}/completions/{completionId} | Get an activation completion record|
13
+ |[**getEventActivationCompletions**](#geteventactivationcompletions) | **GET** /events/{eventId}/activations/{activationId}/completions | List completions for an activation|
14
+ |[**getEventActivationSessions**](#geteventactivationsessions) | **GET** /events/{eventId}/activations/{activationId}/sessions | List sessions linked to an activation|
15
+ |[**getEventActivations**](#geteventactivations) | **GET** /events/{eventId}/activations | List an event\'s activations|
16
+ |[**updateEventActivation**](#updateeventactivation) | **PUT** /events/{eventId}/activations/{activationId} | Update an event activation|
17
+ |[**updateEventActivationCompletion**](#updateeventactivationcompletion) | **PUT** /events/{eventId}/activations/{activationId}/completions/{completionId} | Update an activation completion\'s earned points|
18
18
 
19
19
  # **createEventActivation**
20
20
  > CreateEventActivation200Response createEventActivation(eventActivationCreateInputs)
21
21
 
22
- Create Event Activation endpoint
22
+ Creates a new activation (e.g. a scavenger-hunt or reward task) on the given event, automatically assigning its display sort order if one is not provided; requires update permission on events.
23
23
 
24
24
  ### Example
25
25
 
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.createEventActivation(
74
74
  # **createEventActivationCompletion**
75
75
  > CreateEventActivationCompletion200Response createEventActivationCompletion(eventActivationCompletionCreateInputs)
76
76
 
77
- Create Event Activation Completion endpoint
77
+ Marks an activation as completed for the pass given in the request body, awarding its points (or a specified earned-points amount for \"input\" reward types) and failing if that pass has already completed the activation; requires update permission on events.
78
78
 
79
79
  ### Example
80
80
 
@@ -132,7 +132,7 @@ const { status, data } = await apiInstance.createEventActivationCompletion(
132
132
  # **deleteEventActivation**
133
133
  > CreateAccountInvitations200Response deleteEventActivation()
134
134
 
135
- Delete Event Activation endpoint
135
+ Permanently deletes an activation from the given event, along with its association to any sessions; requires update permission on events.
136
136
 
137
137
  ### Example
138
138
 
@@ -186,7 +186,7 @@ const { status, data } = await apiInstance.deleteEventActivation(
186
186
  # **deleteEventActivationCompletion**
187
187
  > CreateAccountInvitations200Response deleteEventActivationCompletion()
188
188
 
189
- Delete Event Activation Completion endpoint
189
+ Permanently removes a specific attendee\'s completion record for an event activation, effectively un-completing it; requires update permission on events.
190
190
 
191
191
  ### Example
192
192
 
@@ -243,7 +243,7 @@ const { status, data } = await apiInstance.deleteEventActivationCompletion(
243
243
  # **getEventActivation**
244
244
  > CreateEventActivation200Response getEventActivation()
245
245
 
246
- Get Event Activation endpoint
246
+ Retrieves a single activation by ID or slug for the given event, including its configuration and reward details; requires read access to the event\'s events module.
247
247
 
248
248
  ### Example
249
249
 
@@ -297,7 +297,7 @@ const { status, data } = await apiInstance.getEventActivation(
297
297
  # **getEventActivationCompletion**
298
298
  > CreateEventActivationCompletion200Response getEventActivationCompletion()
299
299
 
300
- Get Event Activation Completion endpoint
300
+ Retrieves a single completion record for an event activation, showing the pass that completed it and the points earned; requires read access to the event\'s events module.
301
301
 
302
302
  ### Example
303
303
 
@@ -354,7 +354,7 @@ const { status, data } = await apiInstance.getEventActivationCompletion(
354
354
  # **getEventActivationCompletions**
355
355
  > GetEventActivationCompletions200Response getEventActivationCompletions()
356
356
 
357
- Get Event Activation Completions endpoint
357
+ Returns a paginated list of completion records for an event activation, searchable by the completing attendee\'s name, username, or email; requires read access to the event\'s events module.
358
358
 
359
359
  ### Example
360
360
 
@@ -420,7 +420,7 @@ const { status, data } = await apiInstance.getEventActivationCompletions(
420
420
  # **getEventActivationSessions**
421
421
  > GetEventActivationSessions200Response getEventActivationSessions()
422
422
 
423
- Get Event Activation Sessions endpoint
423
+ Returns a paginated list of event sessions associated with the specified activation, supporting search and ordering; requires read access to the event\'s events module.
424
424
 
425
425
  ### Example
426
426
 
@@ -486,7 +486,7 @@ const { status, data } = await apiInstance.getEventActivationSessions(
486
486
  # **getEventActivations**
487
487
  > GetEventActivations200Response getEventActivations()
488
488
 
489
- Get Event Activations endpoint
489
+ Returns a paginated list of activations configured for the given event, supporting search and ordering; requires read access to the event\'s events module.
490
490
 
491
491
  ### Example
492
492
 
@@ -549,7 +549,7 @@ const { status, data } = await apiInstance.getEventActivations(
549
549
  # **updateEventActivation**
550
550
  > CreateEventActivation200Response updateEventActivation(eventActivationUpdateInputs)
551
551
 
552
- Update Event Activation endpoint
552
+ Updates the fields of a gamification activation for the given event, such as its name, points, or configuration; requires the update permission on events.
553
553
 
554
554
  ### Example
555
555
 
@@ -607,7 +607,7 @@ const { status, data } = await apiInstance.updateEventActivation(
607
607
  # **updateEventActivationCompletion**
608
608
  > CreateEventActivationCompletion200Response updateEventActivationCompletion(eventActivationCompletionUpdateInputs)
609
609
 
610
- Update Event Activation Completion endpoint
610
+ Updates the earned points on an existing completion record for the given event activation, identified by completion id; requires the update permission on events.
611
611
 
612
612
  ### Example
613
613
 
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**addEventActivationSession**](#addeventactivationsession) | **POST** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Add Event Activation Session|
8
- |[**removeEventActivationSession**](#removeeventactivationsession) | **DELETE** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Remove Event Activation Session|
9
- |[**removeEventActivationSessions**](#removeeventactivationsessions) | **DELETE** /events/{eventId}/activations/{activationId}/sessions | Remove Event Activation Sessions|
7
+ |[**addEventActivationSession**](#addeventactivationsession) | **POST** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Attach a session to an activation|
8
+ |[**removeEventActivationSession**](#removeeventactivationsession) | **DELETE** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Detach a session from an activation|
9
+ |[**removeEventActivationSessions**](#removeeventactivationsessions) | **DELETE** /events/{eventId}/activations/{activationId}/sessions | Detach all sessions from an activation|
10
10
 
11
11
  # **addEventActivationSession**
12
12
  > CreateEventActivation200Response addEventActivationSession()
13
13
 
14
- Add Event Activation Session endpoint
14
+ Links an existing event session to an activation so checking in to that session counts toward completing it, failing if the session is already connected to another activation or if the activation\'s reward type is \"input\"; requires update permission on events.
15
15
 
16
16
  ### Example
17
17
 
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.addEventActivationSession(
68
68
  # **removeEventActivationSession**
69
69
  > CreateEventActivation200Response removeEventActivationSession()
70
70
 
71
- Remove Event Activation Session endpoint
71
+ Disconnects a single event session from an activation so checking in to it no longer counts toward completing the activation; requires update permission on events.
72
72
 
73
73
  ### Example
74
74
 
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.removeEventActivationSession(
125
125
  # **removeEventActivationSessions**
126
126
  > CreateEventActivation200Response removeEventActivationSessions()
127
127
 
128
- Remove Event Activation Sessions endpoint
128
+ Disconnects every event session currently linked to an activation, clearing its session-based check-in requirements in a single call; requires update permission on events.
129
129
 
130
130
  ### Example
131
131
 
@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**deleteEventActivationTranslation**](#deleteeventactivationtranslation) | **DELETE** /events/{eventId}/activations/{activationId}/translations/{locale} | Delete Event Activation Translation|
8
- |[**getEventActivationTranslation**](#geteventactivationtranslation) | **GET** /events/{eventId}/activations/{activationId}/translations/{locale} | Get Event Activation Translation|
9
- |[**getEventActivationTranslations**](#geteventactivationtranslations) | **GET** /events/{eventId}/activations/{activationId}/translations | Get Event Activation Translations|
10
- |[**updateEventActivationTranslation**](#updateeventactivationtranslation) | **PUT** /events/{eventId}/activations/{activationId}/translations/{locale} | Update Event Activation Translation|
7
+ |[**deleteEventActivationTranslation**](#deleteeventactivationtranslation) | **DELETE** /events/{eventId}/activations/{activationId}/translations/{locale} | Delete an activation\'s translation|
8
+ |[**getEventActivationTranslation**](#geteventactivationtranslation) | **GET** /events/{eventId}/activations/{activationId}/translations/{locale} | Get an event activation\'s translation|
9
+ |[**getEventActivationTranslations**](#geteventactivationtranslations) | **GET** /events/{eventId}/activations/{activationId}/translations | List translations for an activation|
10
+ |[**updateEventActivationTranslation**](#updateeventactivationtranslation) | **PUT** /events/{eventId}/activations/{activationId}/translations/{locale} | Create or update an activation\'s translation|
11
11
 
12
12
  # **deleteEventActivationTranslation**
13
13
  > SyncAccounts200Response deleteEventActivationTranslation()
14
14
 
15
- Delete Event Activation Translation endpoint
15
+ Removes the translated content for an event activation in the specified locale, deleting that locale\'s name and descriptions; requires update permission on events.
16
16
 
17
17
  ### Example
18
18
 
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventActivationTranslation(
69
69
  # **getEventActivationTranslation**
70
70
  > GetEventActivationTranslation200Response getEventActivationTranslation()
71
71
 
72
- Get Event Activation Translation endpoint
72
+ Returns the translated content for a given event activation in the specified locale, or null if no translation exists for that locale; requires read permission on events.
73
73
 
74
74
  ### Example
75
75
 
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventActivationTranslation(
126
126
  # **getEventActivationTranslations**
127
127
  > GetEventActivationTranslations200Response getEventActivationTranslations()
128
128
 
129
- Get Event Activation Translations endpoint
129
+ Returns a paginated list of locale translations for the specified event activation, supporting search and ordering; requires read access to the event\'s events module.
130
130
 
131
131
  ### Example
132
132
 
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventActivationTranslations(
192
192
  # **updateEventActivationTranslation**
193
193
  > UpdateEventActivationTranslation200Response updateEventActivationTranslation(eventActivationTranslationUpdateInputs)
194
194
 
195
- Update Event Activation Translation endpoint
195
+ Upserts the translated name and descriptions for an event activation in the specified locale, creating the translation record if it does not already exist; requires update permission on events.
196
196
 
197
197
  ### Example
198
198