@connectedxm/admin-sdk 7.13.0 → 8.0.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.
- package/.openapi-generator/FILES +19 -19
- package/AdminApi.ts +9 -9
- package/README.md +52 -49
- package/api.ts +17745 -17398
- package/dist/AdminApi.d.ts +4 -4
- package/dist/AdminApi.js +3 -3
- package/dist/api.d.ts +9508 -9330
- package/dist/api.js +13530 -13275
- package/dist/esm/AdminApi.d.ts +4 -4
- package/dist/esm/AdminApi.js +4 -4
- package/dist/esm/api.d.ts +9508 -9330
- package/dist/esm/api.js +9403 -9148
- package/docs/BaseEventPass.md +1 -1
- package/docs/{BaseEventAttendee.md → BaseEventRegistration.md} +3 -3
- package/docs/BaseMatchPass.md +1 -1
- package/docs/{BaseAttendeePackage.md → BaseRegistrationPackage.md} +3 -3
- package/docs/BaseTransferLog.md +2 -2
- package/docs/Coupon.md +1 -1
- package/docs/{CreateEventAttendee200Response.md → CreateEventRegistration200Response.md} +4 -4
- package/docs/{CreateEventAttendeePackage200Response.md → CreateEventRegistrationPackage200Response.md} +4 -4
- package/docs/EventMediaItem.md +2 -0
- package/docs/EventPass.md +2 -2
- package/docs/{EventAttendee.md → EventRegistration.md} +5 -5
- package/docs/{EventAttendeeAllOfCount.md → EventRegistrationAllOfCount.md} +3 -3
- package/docs/{EventAttendeeCreateInputs.md → EventRegistrationCreateInputs.md} +3 -3
- package/docs/{EventAttendeePackageCreateInputs.md → EventRegistrationPackageCreateInputs.md} +3 -3
- package/docs/{EventAttendeePackageUpdateInputs.md → EventRegistrationPackageUpdateInputs.md} +3 -3
- package/docs/EventsCouponsApi.md +4 -4
- package/docs/EventsFollowupsApi.md +2 -2
- package/docs/EventsMediaApi.md +183 -0
- package/docs/EventsPassesAddonsApi.md +4 -4
- package/docs/EventsPassesApi.md +29 -29
- package/docs/EventsPassesFollowupsApi.md +18 -18
- package/docs/EventsPassesResponsesApi.md +4 -4
- package/docs/EventsPasstypesApi.md +2 -2
- package/docs/{EventsAttendeesApi.md → EventsRegistrationsApi.md} +146 -146
- package/docs/{EventsAttendeesPackagesApi.md → EventsRegistrationsPackagesApi.md} +61 -61
- package/docs/{EventsAttendeesReservationsApi.md → EventsRegistrationsReservationsApi.md} +45 -45
- package/docs/EventsRoomtypesApi.md +2 -2
- package/docs/GetAccountRegistrations200Response.md +1 -1
- package/docs/{GetEventAttendeeCoupons200Response.md → GetEventCoupons200Response.md} +3 -3
- package/docs/{GetEventPassQuestionFollowups200Response.md → GetEventFollowups200Response.md} +3 -3
- package/docs/{CreateEventPass200Response.md → GetEventPass200Response.md} +3 -3
- package/docs/{GetEventAttendeeTransfersLogs200Response.md → GetEventPassTransferLogs200Response.md} +3 -3
- package/docs/{GetEventAttendeePackages200Response.md → GetEventRegistrationPackages200Response.md} +4 -4
- package/docs/{GetEventAttendeeReservations200Response.md → GetEventRegistrationReservations200Response.md} +3 -3
- package/docs/Payment.md +1 -1
- package/docs/{AttendeePackage.md → RegistrationPackage.md} +3 -3
- package/docs/TransferLog.md +2 -2
- package/package.json +1 -1
package/docs/BaseEventPass.md
CHANGED
|
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**couponId** | **string** | | [default to undefined]
|
|
24
24
|
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
25
25
|
**packageId** | **string** | | [default to undefined]
|
|
26
|
-
**_package** | [**
|
|
26
|
+
**_package** | [**BaseRegistrationPackage**](BaseRegistrationPackage.md) | | [default to undefined]
|
|
27
27
|
**seriesRegistrationId** | **string** | | [default to undefined]
|
|
28
28
|
**createdAt** | **string** | | [default to undefined]
|
|
29
29
|
**updatedAt** | **string** | | [default to undefined]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BaseEventRegistration
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import {
|
|
18
|
+
import { BaseEventRegistration } from '@connectedxm/admin-sdk';
|
|
19
19
|
|
|
20
|
-
const instance:
|
|
20
|
+
const instance: BaseEventRegistration = {
|
|
21
21
|
id,
|
|
22
22
|
alternateId,
|
|
23
23
|
accountId,
|
package/docs/BaseMatchPass.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**alternateId** | **number** | | [default to undefined]
|
|
10
10
|
**ticket** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
11
|
-
**attendee** | [**
|
|
11
|
+
**attendee** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
12
12
|
**responses** | [**Array<BaseRegistrationQuestionResponse>**](BaseRegistrationQuestionResponse.md) | | [optional] [default to undefined]
|
|
13
13
|
**accesses** | [**Array<BaseMatchPassAccessesInner>**](BaseMatchPassAccessesInner.md) | | [optional] [default to undefined]
|
|
14
14
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BaseRegistrationPackage
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import {
|
|
18
|
+
import { BaseRegistrationPackage } from '@connectedxm/admin-sdk';
|
|
19
19
|
|
|
20
|
-
const instance:
|
|
20
|
+
const instance: BaseRegistrationPackage = {
|
|
21
21
|
id,
|
|
22
22
|
attendeeId,
|
|
23
23
|
packageId,
|
package/docs/BaseTransferLog.md
CHANGED
|
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **number** | | [default to undefined]
|
|
9
9
|
**fromRegistrationId** | **string** | | [default to undefined]
|
|
10
|
-
**fromRegistration** | [**
|
|
10
|
+
**fromRegistration** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
11
11
|
**toRegistrationId** | **string** | | [default to undefined]
|
|
12
|
-
**toRegistration** | [**
|
|
12
|
+
**toRegistration** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/Coupon.md
CHANGED
|
@@ -28,7 +28,7 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**applyToReservation** | **boolean** | | [default to undefined]
|
|
29
29
|
**applyToSessions** | **boolean** | | [default to undefined]
|
|
30
30
|
**registrationId** | **string** | | [default to undefined]
|
|
31
|
-
**registration** | [**
|
|
31
|
+
**registration** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
32
32
|
**allowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
33
33
|
**disallowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
34
34
|
**lineItem** | [**PaymentLineItem**](PaymentLineItem.md) | | [default to undefined]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreateEventRegistration200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,14 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**status** | **string** | | [default to undefined]
|
|
9
9
|
**message** | **string** | | [default to undefined]
|
|
10
|
-
**data** | [**
|
|
10
|
+
**data** | [**EventRegistration**](EventRegistration.md) | | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { CreateEventRegistration200Response } from '@connectedxm/admin-sdk';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: CreateEventRegistration200Response = {
|
|
18
18
|
status,
|
|
19
19
|
message,
|
|
20
20
|
data,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreateEventRegistrationPackage200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,14 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**status** | **string** | | [default to undefined]
|
|
9
9
|
**message** | **string** | | [default to undefined]
|
|
10
|
-
**data** | [**
|
|
10
|
+
**data** | [**RegistrationPackage**](RegistrationPackage.md) | | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { CreateEventRegistrationPackage200Response } from '@connectedxm/admin-sdk';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: CreateEventRegistrationPackage200Response = {
|
|
18
18
|
status,
|
|
19
19
|
message,
|
|
20
20
|
data,
|
package/docs/EventMediaItem.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**file** | [**BaseFile**](BaseFile.md) | | [default to undefined]
|
|
17
17
|
**sortOrder** | **number** | | [default to undefined]
|
|
18
18
|
**allowedPassTypes** | [**Array<BaseEventPassType>**](BaseEventPassType.md) | | [default to undefined]
|
|
19
|
+
**allowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
19
20
|
**createdAt** | **string** | | [default to undefined]
|
|
20
21
|
**updatedAt** | **string** | | [default to undefined]
|
|
21
22
|
|
|
@@ -36,6 +37,7 @@ const instance: EventMediaItem = {
|
|
|
36
37
|
file,
|
|
37
38
|
sortOrder,
|
|
38
39
|
allowedPassTypes,
|
|
40
|
+
allowedTiers,
|
|
39
41
|
createdAt,
|
|
40
42
|
updatedAt,
|
|
41
43
|
};
|
package/docs/EventPass.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**eventId** | **string** | | [default to undefined]
|
|
10
10
|
**attendeeId** | **string** | | [default to undefined]
|
|
11
|
-
**attendee** | [**
|
|
11
|
+
**attendee** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
12
12
|
**alternateId** | **number** | | [default to undefined]
|
|
13
13
|
**ticketId** | **string** | | [default to undefined]
|
|
14
14
|
**ticket** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**couponId** | **string** | | [default to undefined]
|
|
24
24
|
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
25
25
|
**packageId** | **string** | | [default to undefined]
|
|
26
|
-
**_package** | [**
|
|
26
|
+
**_package** | [**BaseRegistrationPackage**](BaseRegistrationPackage.md) | | [default to undefined]
|
|
27
27
|
**seriesRegistrationId** | **string** | | [default to undefined]
|
|
28
28
|
**createdAt** | **string** | | [default to undefined]
|
|
29
29
|
**updatedAt** | **string** | | [default to undefined]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistration
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -12,17 +12,17 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**eventId** | **string** | | [default to undefined]
|
|
13
13
|
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
14
14
|
**passes** | [**Array<BaseEventPass>**](BaseEventPass.md) | | [default to undefined]
|
|
15
|
-
**packages** | [**Array<
|
|
15
|
+
**packages** | [**Array<BaseRegistrationPackage>**](BaseRegistrationPackage.md) | | [default to undefined]
|
|
16
16
|
**createdAt** | **string** | | [default to undefined]
|
|
17
17
|
**updatedAt** | **string** | | [default to undefined]
|
|
18
|
-
**_count** | [**
|
|
18
|
+
**_count** | [**EventRegistrationAllOfCount**](EventRegistrationAllOfCount.md) | | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
22
22
|
```typescript
|
|
23
|
-
import {
|
|
23
|
+
import { EventRegistration } from '@connectedxm/admin-sdk';
|
|
24
24
|
|
|
25
|
-
const instance:
|
|
25
|
+
const instance: EventRegistration = {
|
|
26
26
|
id,
|
|
27
27
|
alternateId,
|
|
28
28
|
accountId,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistrationAllOfCount
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { EventRegistrationAllOfCount } from '@connectedxm/admin-sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: EventRegistrationAllOfCount = {
|
|
17
17
|
payments,
|
|
18
18
|
coupons,
|
|
19
19
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistrationCreateInputs
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { EventRegistrationCreateInputs } from '@connectedxm/admin-sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: EventRegistrationCreateInputs = {
|
|
16
16
|
accountId,
|
|
17
17
|
};
|
|
18
18
|
```
|
package/docs/{EventAttendeePackageCreateInputs.md → EventRegistrationPackageCreateInputs.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistrationPackageCreateInputs
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { EventRegistrationPackageCreateInputs } from '@connectedxm/admin-sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: EventRegistrationPackageCreateInputs = {
|
|
17
17
|
packageId,
|
|
18
18
|
status,
|
|
19
19
|
};
|
package/docs/{EventAttendeePackageUpdateInputs.md → EventRegistrationPackageUpdateInputs.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistrationPackageUpdateInputs
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { EventRegistrationPackageUpdateInputs } from '@connectedxm/admin-sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: EventRegistrationPackageUpdateInputs = {
|
|
17
17
|
packageId,
|
|
18
18
|
status,
|
|
19
19
|
};
|
package/docs/EventsCouponsApi.md
CHANGED
|
@@ -556,7 +556,7 @@ const { status, data } = await apiInstance.getEventCouponTiers(
|
|
|
556
556
|
[[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)
|
|
557
557
|
|
|
558
558
|
# **getEventCouponVariants**
|
|
559
|
-
>
|
|
559
|
+
> GetEventCoupons200Response getEventCouponVariants()
|
|
560
560
|
|
|
561
561
|
Returns a paginated list of the child coupon variants belonging to the given parent coupon on the event, supporting search and `orderBy` sorting; requires \"read\" permission on events.
|
|
562
562
|
|
|
@@ -602,7 +602,7 @@ const { status, data } = await apiInstance.getEventCouponVariants(
|
|
|
602
602
|
|
|
603
603
|
### Return type
|
|
604
604
|
|
|
605
|
-
**
|
|
605
|
+
**GetEventCoupons200Response**
|
|
606
606
|
|
|
607
607
|
### Authorization
|
|
608
608
|
|
|
@@ -622,7 +622,7 @@ const { status, data } = await apiInstance.getEventCouponVariants(
|
|
|
622
622
|
[[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)
|
|
623
623
|
|
|
624
624
|
# **getEventCoupons**
|
|
625
|
-
>
|
|
625
|
+
> GetEventCoupons200Response getEventCoupons()
|
|
626
626
|
|
|
627
627
|
Returns a paginated list of coupons for the given event, filterable by `prePaid` (group-paid vs. standard coupons) and by `includeVariants` to include child coupon variants, with search and `orderBy` sorting; requires \"read\" permission on events.
|
|
628
628
|
|
|
@@ -671,7 +671,7 @@ const { status, data } = await apiInstance.getEventCoupons(
|
|
|
671
671
|
|
|
672
672
|
### Return type
|
|
673
673
|
|
|
674
|
-
**
|
|
674
|
+
**GetEventCoupons200Response**
|
|
675
675
|
|
|
676
676
|
### Authorization
|
|
677
677
|
|
|
@@ -686,7 +686,7 @@ const { status, data } = await apiInstance.getEventFollowupTiers(
|
|
|
686
686
|
[[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)
|
|
687
687
|
|
|
688
688
|
# **getEventFollowups**
|
|
689
|
-
>
|
|
689
|
+
> GetEventFollowups200Response getEventFollowups()
|
|
690
690
|
|
|
691
691
|
Returns a paginated list of registration followups configured for the given event, supporting search and ordering; requires read permission on events.
|
|
692
692
|
|
|
@@ -729,7 +729,7 @@ const { status, data } = await apiInstance.getEventFollowups(
|
|
|
729
729
|
|
|
730
730
|
### Return type
|
|
731
731
|
|
|
732
|
-
**
|
|
732
|
+
**GetEventFollowups200Response**
|
|
733
733
|
|
|
734
734
|
### Authorization
|
|
735
735
|
|
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**
|
|
@@ -11,7 +11,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
11
11
|
|[**unfulfillEventPassAddOn**](#unfulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/undo | Undo an add-on fulfillment|
|
|
12
12
|
|
|
13
13
|
# **addEventPassAddOn**
|
|
14
|
-
>
|
|
14
|
+
> GetEventPass200Response addEventPassAddOn()
|
|
15
15
|
|
|
16
16
|
Attaches an event add-on purchase to the specified pass, requires read permission on events and read/update permission on attendees.
|
|
17
17
|
|
|
@@ -48,7 +48,7 @@ const { status, data } = await apiInstance.addEventPassAddOn(
|
|
|
48
48
|
|
|
49
49
|
### Return type
|
|
50
50
|
|
|
51
|
-
**
|
|
51
|
+
**GetEventPass200Response**
|
|
52
52
|
|
|
53
53
|
### Authorization
|
|
54
54
|
|
|
@@ -191,7 +191,7 @@ const { status, data } = await apiInstance.getEventPassAddOns(
|
|
|
191
191
|
[[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)
|
|
192
192
|
|
|
193
193
|
# **removeEventPassAddOn**
|
|
194
|
-
>
|
|
194
|
+
> GetEventPass200Response removeEventPassAddOn()
|
|
195
195
|
|
|
196
196
|
Detaches a previously added event add-on purchase from the specified pass, requires read permission on events and read/update permission on attendees.
|
|
197
197
|
|
|
@@ -228,7 +228,7 @@ const { status, data } = await apiInstance.removeEventPassAddOn(
|
|
|
228
228
|
|
|
229
229
|
### Return type
|
|
230
230
|
|
|
231
|
-
**
|
|
231
|
+
**GetEventPass200Response**
|
|
232
232
|
|
|
233
233
|
### Authorization
|
|
234
234
|
|