@connectedxm/admin-sdk 7.13.0 → 7.13.1
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.
- package/README.md +3 -0
- package/api.ts +347 -0
- package/dist/api.d.ts +178 -0
- package/dist/api.js +255 -0
- package/dist/esm/api.d.ts +178 -0
- package/dist/esm/api.js +255 -0
- package/docs/EventMediaItem.md +2 -0
- package/docs/EventsMediaApi.md +183 -0
- package/package.json +1 -1
package/docs/EventsMediaApi.md
CHANGED
|
@@ -5,12 +5,15 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**addEventMediaItemPassType**](#addeventmediaitempasstype) | **POST** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} | Restrict an event media item to a pass type|
|
|
8
|
+
|[**addEventMediaItemTier**](#addeventmediaitemtier) | **POST** /events/{eventId}/media/{mediaItemId}/tiers/{tierId} | Restrict an event media item to a tier|
|
|
8
9
|
|[**createEventMediaItem**](#createeventmediaitem) | **POST** /events/{eventId}/media | Create an event media item|
|
|
9
10
|
|[**deleteEventMediaItem**](#deleteeventmediaitem) | **DELETE** /events/{eventId}/media/{mediaItemId} | Delete an event media item|
|
|
10
11
|
|[**getEventMediaItem**](#geteventmediaitem) | **GET** /events/{eventId}/media/{itemId} | Get a single event media item|
|
|
11
12
|
|[**getEventMediaItemPassTypes**](#geteventmediaitempasstypes) | **GET** /events/{eventId}/media/{mediaItemId}/passTypes | List pass types linked to a media item|
|
|
13
|
+
|[**getEventMediaItemTiers**](#geteventmediaitemtiers) | **GET** /events/{eventId}/media/{mediaItemId}/tiers | List tiers linked to a media item|
|
|
12
14
|
|[**getEventMediaItems**](#geteventmediaitems) | **GET** /events/{eventId}/media | List an event\'s media items|
|
|
13
15
|
|[**removeEventMediaItemPassType**](#removeeventmediaitempasstype) | **DELETE** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} | Remove a pass type restriction from an event media item|
|
|
16
|
+
|[**removeEventMediaItemTier**](#removeeventmediaitemtier) | **DELETE** /events/{eventId}/media/{mediaItemId}/tiers/{tierId} | Remove a tier restriction from an event media item|
|
|
14
17
|
|[**updateEventMediaItem**](#updateeventmediaitem) | **PUT** /events/{eventId}/media/{mediaItemId} | Update an event media item|
|
|
15
18
|
|
|
16
19
|
# **addEventMediaItemPassType**
|
|
@@ -49,6 +52,63 @@ const { status, data } = await apiInstance.addEventMediaItemPassType(
|
|
|
49
52
|
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
50
53
|
|
|
51
54
|
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
**CreateEventMediaItem200Response**
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: Not defined
|
|
66
|
+
- **Accept**: application/json
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### HTTP response details
|
|
70
|
+
| Status code | Description | Response headers |
|
|
71
|
+
|-------------|-------------|------------------|
|
|
72
|
+
|**200** | Successful response | - |
|
|
73
|
+
|
|
74
|
+
[[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)
|
|
75
|
+
|
|
76
|
+
# **addEventMediaItemTier**
|
|
77
|
+
> CreateEventMediaItem200Response addEventMediaItemTier()
|
|
78
|
+
|
|
79
|
+
Grants a specific account tier (tier/segment) access to an event media item, restricting who can view it, and requires read and update permission on both events and storage.
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
import {
|
|
85
|
+
EventsMediaApi,
|
|
86
|
+
Configuration
|
|
87
|
+
} from '@connectedxm/admin-sdk';
|
|
88
|
+
|
|
89
|
+
const configuration = new Configuration();
|
|
90
|
+
const apiInstance = new EventsMediaApi(configuration);
|
|
91
|
+
|
|
92
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
93
|
+
let mediaItemId: string; //The mediaItem identifier (default to undefined)
|
|
94
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
95
|
+
|
|
96
|
+
const { status, data } = await apiInstance.addEventMediaItemTier(
|
|
97
|
+
eventId,
|
|
98
|
+
mediaItemId,
|
|
99
|
+
tierId
|
|
100
|
+
);
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Parameters
|
|
104
|
+
|
|
105
|
+
|Name | Type | Description | Notes|
|
|
106
|
+
|------------- | ------------- | ------------- | -------------|
|
|
107
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
108
|
+
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
|
|
109
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
110
|
+
|
|
111
|
+
|
|
52
112
|
### Return type
|
|
53
113
|
|
|
54
114
|
**CreateEventMediaItem200Response**
|
|
@@ -292,6 +352,72 @@ const { status, data } = await apiInstance.getEventMediaItemPassTypes(
|
|
|
292
352
|
- **Accept**: application/json
|
|
293
353
|
|
|
294
354
|
|
|
355
|
+
### HTTP response details
|
|
356
|
+
| Status code | Description | Response headers |
|
|
357
|
+
|-------------|-------------|------------------|
|
|
358
|
+
|**200** | Successful response | - |
|
|
359
|
+
|
|
360
|
+
[[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)
|
|
361
|
+
|
|
362
|
+
# **getEventMediaItemTiers**
|
|
363
|
+
> GetAccountTiers200Response getEventMediaItemTiers()
|
|
364
|
+
|
|
365
|
+
Returns a paginated list of the event\'s account tiers (tiers/segments) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
366
|
+
|
|
367
|
+
### Example
|
|
368
|
+
|
|
369
|
+
```typescript
|
|
370
|
+
import {
|
|
371
|
+
EventsMediaApi,
|
|
372
|
+
Configuration
|
|
373
|
+
} from '@connectedxm/admin-sdk';
|
|
374
|
+
|
|
375
|
+
const configuration = new Configuration();
|
|
376
|
+
const apiInstance = new EventsMediaApi(configuration);
|
|
377
|
+
|
|
378
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
379
|
+
let mediaItemId: string; //The mediaItem identifier (default to undefined)
|
|
380
|
+
let page: number; //Page number (optional) (default to 1)
|
|
381
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
382
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
383
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
384
|
+
|
|
385
|
+
const { status, data } = await apiInstance.getEventMediaItemTiers(
|
|
386
|
+
eventId,
|
|
387
|
+
mediaItemId,
|
|
388
|
+
page,
|
|
389
|
+
pageSize,
|
|
390
|
+
orderBy,
|
|
391
|
+
search
|
|
392
|
+
);
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
### Parameters
|
|
396
|
+
|
|
397
|
+
|Name | Type | Description | Notes|
|
|
398
|
+
|------------- | ------------- | ------------- | -------------|
|
|
399
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
400
|
+
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
|
|
401
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
402
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
403
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
404
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
### Return type
|
|
408
|
+
|
|
409
|
+
**GetAccountTiers200Response**
|
|
410
|
+
|
|
411
|
+
### Authorization
|
|
412
|
+
|
|
413
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
414
|
+
|
|
415
|
+
### HTTP request headers
|
|
416
|
+
|
|
417
|
+
- **Content-Type**: Not defined
|
|
418
|
+
- **Accept**: application/json
|
|
419
|
+
|
|
420
|
+
|
|
295
421
|
### HTTP response details
|
|
296
422
|
| Status code | Description | Response headers |
|
|
297
423
|
|-------------|-------------|------------------|
|
|
@@ -401,6 +527,63 @@ const { status, data } = await apiInstance.removeEventMediaItemPassType(
|
|
|
401
527
|
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
|
|
402
528
|
|
|
403
529
|
|
|
530
|
+
### Return type
|
|
531
|
+
|
|
532
|
+
**CreateEventMediaItem200Response**
|
|
533
|
+
|
|
534
|
+
### Authorization
|
|
535
|
+
|
|
536
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
537
|
+
|
|
538
|
+
### HTTP request headers
|
|
539
|
+
|
|
540
|
+
- **Content-Type**: Not defined
|
|
541
|
+
- **Accept**: application/json
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
### HTTP response details
|
|
545
|
+
| Status code | Description | Response headers |
|
|
546
|
+
|-------------|-------------|------------------|
|
|
547
|
+
|**200** | Successful response | - |
|
|
548
|
+
|
|
549
|
+
[[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)
|
|
550
|
+
|
|
551
|
+
# **removeEventMediaItemTier**
|
|
552
|
+
> CreateEventMediaItem200Response removeEventMediaItemTier()
|
|
553
|
+
|
|
554
|
+
Revokes an account tier\'s (tier/segment) access to an event media item, and requires read and update permission on both events and storage.
|
|
555
|
+
|
|
556
|
+
### Example
|
|
557
|
+
|
|
558
|
+
```typescript
|
|
559
|
+
import {
|
|
560
|
+
EventsMediaApi,
|
|
561
|
+
Configuration
|
|
562
|
+
} from '@connectedxm/admin-sdk';
|
|
563
|
+
|
|
564
|
+
const configuration = new Configuration();
|
|
565
|
+
const apiInstance = new EventsMediaApi(configuration);
|
|
566
|
+
|
|
567
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
568
|
+
let mediaItemId: string; //The mediaItem identifier (default to undefined)
|
|
569
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
570
|
+
|
|
571
|
+
const { status, data } = await apiInstance.removeEventMediaItemTier(
|
|
572
|
+
eventId,
|
|
573
|
+
mediaItemId,
|
|
574
|
+
tierId
|
|
575
|
+
);
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
### Parameters
|
|
579
|
+
|
|
580
|
+
|Name | Type | Description | Notes|
|
|
581
|
+
|------------- | ------------- | ------------- | -------------|
|
|
582
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
583
|
+
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
|
|
584
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
585
|
+
|
|
586
|
+
|
|
404
587
|
### Return type
|
|
405
588
|
|
|
406
589
|
**CreateEventMediaItem200Response**
|