@connectedxm/admin-sdk 10.20.1 → 10.22.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 (41) hide show
  1. package/.openapi-generator/FILES +3 -0
  2. package/README.md +2 -2
  3. package/api.ts +456 -2
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/api.d.ts +252 -2
  8. package/dist/api.js +315 -25
  9. package/dist/base.d.ts +1 -1
  10. package/dist/base.js +1 -1
  11. package/dist/common.d.ts +1 -1
  12. package/dist/common.js +1 -1
  13. package/dist/configuration.d.ts +1 -1
  14. package/dist/configuration.js +1 -1
  15. package/dist/esm/api.d.ts +252 -2
  16. package/dist/esm/api.js +291 -1
  17. package/dist/esm/base.d.ts +1 -1
  18. package/dist/esm/base.js +1 -1
  19. package/dist/esm/common.d.ts +1 -1
  20. package/dist/esm/common.js +1 -1
  21. package/dist/esm/configuration.d.ts +1 -1
  22. package/dist/esm/configuration.js +1 -1
  23. package/docs/Activity.md +2 -0
  24. package/docs/ActivityCreateInputs.md +2 -0
  25. package/docs/BaseActivity.md +2 -0
  26. package/docs/BaseEventMediaItem.md +2 -0
  27. package/docs/BaseEventMediaItemLike.md +24 -0
  28. package/docs/EventEmailType.md +2 -0
  29. package/docs/EventMediaItem.md +2 -0
  30. package/docs/EventMediaItemCreateInputs.md +2 -0
  31. package/docs/EventMediaItemLike.md +30 -0
  32. package/docs/EventMediaItemUpdateInputs.md +2 -0
  33. package/docs/EventsMediaApi.md +137 -0
  34. package/docs/EventsRegistrationsApi.md +64 -0
  35. package/docs/GetEventMediaItemLikes200Response.md +26 -0
  36. package/docs/NotificationPreferences.md +2 -0
  37. package/docs/OrganizationModuleSettings.md +4 -0
  38. package/docs/OrganizationModuleSettingsTranslation.md +2 -0
  39. package/docs/OrganizationModuleSettingsTranslationUpdateInputs.md +2 -0
  40. package/docs/OrganizationModuleSettingsUpdateInputs.md +4 -0
  41. package/package.json +1 -1
@@ -9,6 +9,8 @@ All URIs are relative to *https://admin-api.connected.dev*
9
9
  |[**createEventMediaItem**](#createeventmediaitem) | **POST** /events/{eventId}/media | Create an event media item|
10
10
  |[**deleteEventMediaItem**](#deleteeventmediaitem) | **DELETE** /events/{eventId}/media/{mediaItemId} | Delete an event media item|
11
11
  |[**getEventMediaItem**](#geteventmediaitem) | **GET** /events/{eventId}/media/{itemId} | Get a single event media item|
12
+ |[**getEventMediaItemActivities**](#geteventmediaitemactivities) | **GET** /events/{eventId}/media/{mediaItemId}/activities | List a media item\'s activity feed|
13
+ |[**getEventMediaItemLikes**](#geteventmediaitemlikes) | **GET** /events/{eventId}/media/{mediaItemId}/likes | List a media item\'s likes|
12
14
  |[**getEventMediaItemPassTypes**](#geteventmediaitempasstypes) | **GET** /events/{eventId}/media/{mediaItemId}/passTypes | List pass types linked to a media item|
13
15
  |[**getEventMediaItemTiers**](#geteventmediaitemtiers) | **GET** /events/{eventId}/media/{mediaItemId}/tiers | List tiers linked to a media item|
14
16
  |[**getEventMediaItems**](#geteventmediaitems) | **GET** /events/{eventId}/media | List an event\'s media items|
@@ -286,6 +288,141 @@ const { status, data } = await apiInstance.getEventMediaItem(
286
288
  - **Accept**: application/json
287
289
 
288
290
 
291
+ ### HTTP response details
292
+ | Status code | Description | Response headers |
293
+ |-------------|-------------|------------------|
294
+ |**200** | Successful response | - |
295
+
296
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
297
+
298
+ # **getEventMediaItemActivities**
299
+ > GetAccountActivities200Response getEventMediaItemActivities()
300
+
301
+ Returns a paginated list of activity records posted on a specific event media item, optionally filtered by activity status and search term, requiring read permission on events, storage, and activities.
302
+
303
+ ### Example
304
+
305
+ ```typescript
306
+ import {
307
+ EventsMediaApi,
308
+ Configuration
309
+ } from '@connectedxm/admin-sdk';
310
+
311
+ const configuration = new Configuration();
312
+ const apiInstance = new EventsMediaApi(configuration);
313
+
314
+ let eventId: string; //The event identifier (default to undefined)
315
+ let mediaItemId: string; //The mediaItem identifier (default to undefined)
316
+ let status: ActivityStatus; //Filter by status (optional) (default to undefined)
317
+ let page: number; //Page number (optional) (default to 1)
318
+ let pageSize: number; //Number of items per page (optional) (default to 25)
319
+ let orderBy: string; //Field to order by (optional) (default to undefined)
320
+ let search: string; //Search query (optional) (default to undefined)
321
+
322
+ const { status, data } = await apiInstance.getEventMediaItemActivities(
323
+ eventId,
324
+ mediaItemId,
325
+ status,
326
+ page,
327
+ pageSize,
328
+ orderBy,
329
+ search
330
+ );
331
+ ```
332
+
333
+ ### Parameters
334
+
335
+ |Name | Type | Description | Notes|
336
+ |------------- | ------------- | ------------- | -------------|
337
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
338
+ | **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
339
+ | **status** | **ActivityStatus** | Filter by status | (optional) defaults to undefined|
340
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
341
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
342
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
343
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
344
+
345
+
346
+ ### Return type
347
+
348
+ **GetAccountActivities200Response**
349
+
350
+ ### Authorization
351
+
352
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
353
+
354
+ ### HTTP request headers
355
+
356
+ - **Content-Type**: Not defined
357
+ - **Accept**: application/json
358
+
359
+
360
+ ### HTTP response details
361
+ | Status code | Description | Response headers |
362
+ |-------------|-------------|------------------|
363
+ |**200** | Successful response | - |
364
+
365
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
366
+
367
+ # **getEventMediaItemLikes**
368
+ > GetEventMediaItemLikes200Response getEventMediaItemLikes()
369
+
370
+ Returns a paginated list of accounts that liked a specific event media item, optionally filtered by search term and sort order, requiring read permission on events and storage.
371
+
372
+ ### Example
373
+
374
+ ```typescript
375
+ import {
376
+ EventsMediaApi,
377
+ Configuration
378
+ } from '@connectedxm/admin-sdk';
379
+
380
+ const configuration = new Configuration();
381
+ const apiInstance = new EventsMediaApi(configuration);
382
+
383
+ let eventId: string; //The event identifier (default to undefined)
384
+ let mediaItemId: string; //The mediaItem identifier (default to undefined)
385
+ let page: number; //Page number (optional) (default to 1)
386
+ let pageSize: number; //Number of items per page (optional) (default to 25)
387
+ let orderBy: string; //Field to order by (optional) (default to undefined)
388
+ let search: string; //Search query (optional) (default to undefined)
389
+
390
+ const { status, data } = await apiInstance.getEventMediaItemLikes(
391
+ eventId,
392
+ mediaItemId,
393
+ page,
394
+ pageSize,
395
+ orderBy,
396
+ search
397
+ );
398
+ ```
399
+
400
+ ### Parameters
401
+
402
+ |Name | Type | Description | Notes|
403
+ |------------- | ------------- | ------------- | -------------|
404
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
405
+ | **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
406
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
407
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
408
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
409
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
410
+
411
+
412
+ ### Return type
413
+
414
+ **GetEventMediaItemLikes200Response**
415
+
416
+ ### Authorization
417
+
418
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
419
+
420
+ ### HTTP request headers
421
+
422
+ - **Content-Type**: Not defined
423
+ - **Accept**: application/json
424
+
425
+
289
426
  ### HTTP response details
290
427
  | Status code | Description | Response headers |
291
428
  |-------------|-------------|------------------|
@@ -6,6 +6,7 @@ All URIs are relative to *https://admin-api.connected.dev*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**createEventRegistration**](#createeventregistration) | **POST** /events/{eventId}/registrations | Create an event registration|
8
8
  |[**deleteEventRegistration**](#deleteeventregistration) | **DELETE** /events/{eventId}/registrations/{registrationId} | Delete an event registration|
9
+ |[**getEventAbandonedRegistrations**](#geteventabandonedregistrations) | **GET** /events/{eventId}/registrations/abandoned | List an event\'s abandoned registrations|
9
10
  |[**getEventPassRegistrationPasses**](#geteventpassregistrationpasses) | **GET** /events/{eventId}/passes/{passId}/attendee/passes | List every pass on the registration that owns a given pass|
10
11
  |[**getEventRegistration**](#geteventregistration) | **GET** /events/{eventId}/registrations/{registrationId} | Get an event registration|
11
12
  |[**getEventRegistrationCoupons**](#geteventregistrationcoupons) | **GET** /events/{eventId}/registrations/{registrationId}/coupons | List an event registration\'s coupons|
@@ -119,6 +120,69 @@ const { status, data } = await apiInstance.deleteEventRegistration(
119
120
  - **Accept**: application/json
120
121
 
121
122
 
123
+ ### HTTP response details
124
+ | Status code | Description | Response headers |
125
+ |-------------|-------------|------------------|
126
+ |**200** | Successful response | - |
127
+
128
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
129
+
130
+ # **getEventAbandonedRegistrations**
131
+ > GetAccountRegistrations200Response getEventAbandonedRegistrations()
132
+
133
+ Returns a paginated list of registrations for the given event that match the backend abandoned-registration predicate (all passes still draft and untouched for 24 hours); requires \"read\" permission on events and attendees.
134
+
135
+ ### Example
136
+
137
+ ```typescript
138
+ import {
139
+ EventsRegistrationsApi,
140
+ Configuration
141
+ } from '@connectedxm/admin-sdk';
142
+
143
+ const configuration = new Configuration();
144
+ const apiInstance = new EventsRegistrationsApi(configuration);
145
+
146
+ let eventId: string; //The event identifier (default to undefined)
147
+ let page: number; //Page number (optional) (default to 1)
148
+ let pageSize: number; //Number of items per page (optional) (default to 25)
149
+ let orderBy: string; //Field to order by (optional) (default to undefined)
150
+ let search: string; //Search query (optional) (default to undefined)
151
+
152
+ const { status, data } = await apiInstance.getEventAbandonedRegistrations(
153
+ eventId,
154
+ page,
155
+ pageSize,
156
+ orderBy,
157
+ search
158
+ );
159
+ ```
160
+
161
+ ### Parameters
162
+
163
+ |Name | Type | Description | Notes|
164
+ |------------- | ------------- | ------------- | -------------|
165
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
166
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
167
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
168
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
169
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
170
+
171
+
172
+ ### Return type
173
+
174
+ **GetAccountRegistrations200Response**
175
+
176
+ ### Authorization
177
+
178
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
179
+
180
+ ### HTTP request headers
181
+
182
+ - **Content-Type**: Not defined
183
+ - **Accept**: application/json
184
+
185
+
122
186
  ### HTTP response details
123
187
  | Status code | Description | Response headers |
124
188
  |-------------|-------------|------------------|
@@ -0,0 +1,26 @@
1
+ # GetEventMediaItemLikes200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **status** | **string** | | [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+ **data** | [**Array<EventMediaItemLike>**](EventMediaItemLike.md) | | [default to undefined]
11
+ **count** | **number** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { GetEventMediaItemLikes200Response } from '@connectedxm/admin-sdk';
17
+
18
+ const instance: GetEventMediaItemLikes200Response = {
19
+ status,
20
+ message,
21
+ data,
22
+ count,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
11
11
  **transferPush** | **boolean** | | [default to undefined]
12
12
  **transferEmail** | **boolean** | | [default to undefined]
13
13
  **eventReminderEmail** | **boolean** | | [default to undefined]
14
+ **abandonedRegistrationEmail** | **boolean** | | [default to undefined]
14
15
  **bookingReminderEmail** | **boolean** | | [default to undefined]
15
16
  **chatPush** | **boolean** | | [default to undefined]
16
17
  **chatUnreadEmail** | **boolean** | | [default to undefined]
@@ -35,6 +36,7 @@ const instance: NotificationPreferences = {
35
36
  transferPush,
36
37
  transferEmail,
37
38
  eventReminderEmail,
39
+ abandonedRegistrationEmail,
38
40
  bookingReminderEmail,
39
41
  chatPush,
40
42
  chatUnreadEmail,
@@ -26,6 +26,8 @@ Name | Type | Description | Notes
26
26
  **eventDenialEmailBody** | **string** | | [default to undefined]
27
27
  **eventTransferEmailReplyTo** | **string** | | [default to undefined]
28
28
  **eventTransferEmailBody** | **string** | | [default to undefined]
29
+ **eventAbandonedRegistrationEmailReplyTo** | **string** | | [default to undefined]
30
+ **eventAbandonedRegistrationEmailBody** | **string** | | [default to undefined]
29
31
 
30
32
  ## Example
31
33
 
@@ -54,6 +56,8 @@ const instance: OrganizationModuleSettings = {
54
56
  eventDenialEmailBody,
55
57
  eventTransferEmailReplyTo,
56
58
  eventTransferEmailBody,
59
+ eventAbandonedRegistrationEmailReplyTo,
60
+ eventAbandonedRegistrationEmailBody,
57
61
  };
58
62
  ```
59
63
 
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
14
14
  **eventApprovalEmailBody** | **string** | | [default to undefined]
15
15
  **eventDenialEmailBody** | **string** | | [default to undefined]
16
16
  **eventTransferEmailBody** | **string** | | [default to undefined]
17
+ **eventAbandonedRegistrationEmailBody** | **string** | | [default to undefined]
17
18
 
18
19
  ## Example
19
20
 
@@ -30,6 +31,7 @@ const instance: OrganizationModuleSettingsTranslation = {
30
31
  eventApprovalEmailBody,
31
32
  eventDenialEmailBody,
32
33
  eventTransferEmailBody,
34
+ eventAbandonedRegistrationEmailBody,
33
35
  };
34
36
  ```
35
37
 
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **eventApprovalEmailBody** | **string** | | [optional] [default to undefined]
13
13
  **eventDenialEmailBody** | **string** | | [optional] [default to undefined]
14
14
  **eventTransferEmailBody** | **string** | | [optional] [default to undefined]
15
+ **eventAbandonedRegistrationEmailBody** | **string** | | [optional] [default to undefined]
15
16
 
16
17
  ## Example
17
18
 
@@ -26,6 +27,7 @@ const instance: OrganizationModuleSettingsTranslationUpdateInputs = {
26
27
  eventApprovalEmailBody,
27
28
  eventDenialEmailBody,
28
29
  eventTransferEmailBody,
30
+ eventAbandonedRegistrationEmailBody,
29
31
  };
30
32
  ```
31
33
 
@@ -25,6 +25,8 @@ Name | Type | Description | Notes
25
25
  **eventDenialEmailBody** | **string** | | [optional] [default to undefined]
26
26
  **eventTransferEmailReplyTo** | **string** | | [optional] [default to undefined]
27
27
  **eventTransferEmailBody** | **string** | | [optional] [default to undefined]
28
+ **eventAbandonedRegistrationEmailReplyTo** | **string** | | [optional] [default to undefined]
29
+ **eventAbandonedRegistrationEmailBody** | **string** | | [optional] [default to undefined]
28
30
 
29
31
  ## Example
30
32
 
@@ -52,6 +54,8 @@ const instance: OrganizationModuleSettingsUpdateInputs = {
52
54
  eventDenialEmailBody,
53
55
  eventTransferEmailReplyTo,
54
56
  eventTransferEmailBody,
57
+ eventAbandonedRegistrationEmailReplyTo,
58
+ eventAbandonedRegistrationEmailBody,
55
59
  };
56
60
  ```
57
61
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "10.20.1",
3
+ "version": "10.22.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {