@connectedxm/admin-sdk 6.14.5 → 6.17.4
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 +5 -0
- package/AdminApi.ts +12 -0
- package/README.md +19 -17
- package/api.ts +2642 -2390
- package/dist/AdminApi.d.ts +5 -1
- package/dist/AdminApi.js +4 -0
- package/dist/api.d.ts +1224 -1073
- package/dist/api.js +1935 -1726
- package/dist/esm/AdminApi.d.ts +5 -1
- package/dist/esm/AdminApi.js +5 -1
- package/dist/esm/api.d.ts +1224 -1073
- package/dist/esm/api.js +2018 -1825
- package/docs/BaseSideEffect.md +4 -0
- package/docs/BookingSpace.md +4 -0
- package/docs/BookingSpaceCreateInputs.md +4 -0
- package/docs/BookingSpaceTranslation.md +4 -0
- package/docs/BookingSpaceTranslationUpdateInputs.md +4 -0
- package/docs/BookingSpaceUpdateInputs.md +4 -0
- package/docs/BookingsApi.md +58 -0
- package/docs/EventsPassesAccessesApi.md +313 -0
- package/docs/EventsPassesAddonsApi.md +190 -0
- package/docs/EventsPassesApi.md +77 -1149
- package/docs/EventsPassesFollowupsApi.md +272 -0
- package/docs/EventsPassesResponsesApi.md +326 -0
- package/docs/SideEffect.md +8 -0
- package/docs/SideEffectActionType.md +2 -0
- package/docs/SideEffectTriggerType.md +4 -2
- package/docs/UpdateEventPassResponsesInputs.md +20 -0
- package/package.json +1 -1
package/docs/BaseSideEffect.md
CHANGED
|
@@ -10,12 +10,14 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**checkedInPassEventId** | **string** | | [default to undefined]
|
|
11
11
|
**newAccountTierId** | **string** | | [default to undefined]
|
|
12
12
|
**removedAccountTierId** | **string** | | [default to undefined]
|
|
13
|
+
**passWithQuestionChoiceId** | **string** | | [default to undefined]
|
|
13
14
|
**joinGroupId** | **string** | | [default to undefined]
|
|
14
15
|
**leaveGroupId** | **string** | | [default to undefined]
|
|
15
16
|
**addToTierId** | **string** | | [default to undefined]
|
|
16
17
|
**subscribeToChannelId** | **string** | | [default to undefined]
|
|
17
18
|
**sendWebhookId** | **string** | | [default to undefined]
|
|
18
19
|
**completeActivationId** | **string** | | [default to undefined]
|
|
20
|
+
**registerForSessionId** | **string** | | [default to undefined]
|
|
19
21
|
|
|
20
22
|
## Example
|
|
21
23
|
|
|
@@ -28,12 +30,14 @@ const instance: BaseSideEffect = {
|
|
|
28
30
|
checkedInPassEventId,
|
|
29
31
|
newAccountTierId,
|
|
30
32
|
removedAccountTierId,
|
|
33
|
+
passWithQuestionChoiceId,
|
|
31
34
|
joinGroupId,
|
|
32
35
|
leaveGroupId,
|
|
33
36
|
addToTierId,
|
|
34
37
|
subscribeToChannelId,
|
|
35
38
|
sendWebhookId,
|
|
36
39
|
completeActivationId,
|
|
40
|
+
registerForSessionId,
|
|
37
41
|
};
|
|
38
42
|
```
|
|
39
43
|
|
package/docs/BookingSpace.md
CHANGED
|
@@ -22,6 +22,8 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [default to undefined]
|
|
23
23
|
**confirmationBody** | **string** | | [default to undefined]
|
|
24
24
|
**confirmationReplyTo** | **string** | | [default to undefined]
|
|
25
|
+
**cancellationBody** | **string** | | [default to undefined]
|
|
26
|
+
**cancellationReplyTo** | **string** | | [default to undefined]
|
|
25
27
|
**createdAt** | **string** | | [default to undefined]
|
|
26
28
|
**updatedAt** | **string** | | [default to undefined]
|
|
27
29
|
|
|
@@ -48,6 +50,8 @@ const instance: BookingSpace = {
|
|
|
48
50
|
taxLocation,
|
|
49
51
|
confirmationBody,
|
|
50
52
|
confirmationReplyTo,
|
|
53
|
+
cancellationBody,
|
|
54
|
+
cancellationReplyTo,
|
|
51
55
|
createdAt,
|
|
52
56
|
updatedAt,
|
|
53
57
|
};
|
|
@@ -17,6 +17,8 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**visible** | **boolean** | | [optional] [default to undefined]
|
|
18
18
|
**confirmationBody** | **string** | | [optional] [default to undefined]
|
|
19
19
|
**confirmationReplyTo** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**cancellationBody** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**cancellationReplyTo** | **string** | | [optional] [default to undefined]
|
|
20
22
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
21
23
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
22
24
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
@@ -39,6 +41,8 @@ const instance: BookingSpaceCreateInputs = {
|
|
|
39
41
|
visible,
|
|
40
42
|
confirmationBody,
|
|
41
43
|
confirmationReplyTo,
|
|
44
|
+
cancellationBody,
|
|
45
|
+
cancellationReplyTo,
|
|
42
46
|
taxCode,
|
|
43
47
|
taxIncluded,
|
|
44
48
|
taxLocation,
|
|
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**locale** | **string** | | [default to undefined]
|
|
10
10
|
**name** | **string** | | [default to undefined]
|
|
11
11
|
**description** | **string** | | [default to undefined]
|
|
12
|
+
**confirmationBody** | **string** | | [default to undefined]
|
|
13
|
+
**cancellationBody** | **string** | | [default to undefined]
|
|
12
14
|
**createdAt** | **string** | | [default to undefined]
|
|
13
15
|
**updatedAt** | **string** | | [default to undefined]
|
|
14
16
|
|
|
@@ -22,6 +24,8 @@ const instance: BookingSpaceTranslation = {
|
|
|
22
24
|
locale,
|
|
23
25
|
name,
|
|
24
26
|
description,
|
|
27
|
+
confirmationBody,
|
|
28
|
+
cancellationBody,
|
|
25
29
|
createdAt,
|
|
26
30
|
updatedAt,
|
|
27
31
|
};
|
|
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**name** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**confirmationBody** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**cancellationBody** | **string** | | [optional] [default to undefined]
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
@@ -16,6 +18,8 @@ import { BookingSpaceTranslationUpdateInputs } from '@connectedxm/admin-sdk';
|
|
|
16
18
|
const instance: BookingSpaceTranslationUpdateInputs = {
|
|
17
19
|
name,
|
|
18
20
|
description,
|
|
21
|
+
confirmationBody,
|
|
22
|
+
cancellationBody,
|
|
19
23
|
};
|
|
20
24
|
```
|
|
21
25
|
|
|
@@ -16,6 +16,8 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**visible** | **boolean** | | [optional] [default to undefined]
|
|
17
17
|
**confirmationBody** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**confirmationReplyTo** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**cancellationBody** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**cancellationReplyTo** | **string** | | [optional] [default to undefined]
|
|
19
21
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
20
22
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
21
23
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
@@ -37,6 +39,8 @@ const instance: BookingSpaceUpdateInputs = {
|
|
|
37
39
|
visible,
|
|
38
40
|
confirmationBody,
|
|
39
41
|
confirmationReplyTo,
|
|
42
|
+
cancellationBody,
|
|
43
|
+
cancellationReplyTo,
|
|
40
44
|
taxCode,
|
|
41
45
|
taxIncluded,
|
|
42
46
|
taxLocation,
|
package/docs/BookingsApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**cancelBooking**](#cancelbooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/cancel | Cancel Booking|
|
|
7
8
|
|[**createBooking**](#createbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings | Create Booking|
|
|
8
9
|
|[**deleteBooking**](#deletebooking) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Delete Booking|
|
|
9
10
|
|[**getBooking**](#getbooking) | **GET** /bookings/{bookingId} | Get Booking|
|
|
@@ -22,6 +23,63 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
22
23
|
|[**getBookingSpaces**](#getbookingspaces) | **GET** /bookings/places/{placeId}/spaces | Get Booking Spaces|
|
|
23
24
|
|[**updateBooking**](#updatebooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Update Booking|
|
|
24
25
|
|
|
26
|
+
# **cancelBooking**
|
|
27
|
+
> CreateBooking200Response cancelBooking()
|
|
28
|
+
|
|
29
|
+
Cancel Booking endpoint
|
|
30
|
+
|
|
31
|
+
### Example
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import {
|
|
35
|
+
BookingsApi,
|
|
36
|
+
Configuration
|
|
37
|
+
} from '@connectedxm/admin-sdk';
|
|
38
|
+
|
|
39
|
+
const configuration = new Configuration();
|
|
40
|
+
const apiInstance = new BookingsApi(configuration);
|
|
41
|
+
|
|
42
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
43
|
+
let spaceId: string; //The space identifier (default to undefined)
|
|
44
|
+
let bookingId: string; //The booking identifier (default to undefined)
|
|
45
|
+
|
|
46
|
+
const { status, data } = await apiInstance.cancelBooking(
|
|
47
|
+
placeId,
|
|
48
|
+
spaceId,
|
|
49
|
+
bookingId
|
|
50
|
+
);
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
|Name | Type | Description | Notes|
|
|
56
|
+
|------------- | ------------- | ------------- | -------------|
|
|
57
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
58
|
+
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
59
|
+
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### Return type
|
|
63
|
+
|
|
64
|
+
**CreateBooking200Response**
|
|
65
|
+
|
|
66
|
+
### Authorization
|
|
67
|
+
|
|
68
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
69
|
+
|
|
70
|
+
### HTTP request headers
|
|
71
|
+
|
|
72
|
+
- **Content-Type**: Not defined
|
|
73
|
+
- **Accept**: application/json
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
### HTTP response details
|
|
77
|
+
| Status code | Description | Response headers |
|
|
78
|
+
|-------------|-------------|------------------|
|
|
79
|
+
|**200** | Successful response | - |
|
|
80
|
+
|
|
81
|
+
[[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)
|
|
82
|
+
|
|
25
83
|
# **createBooking**
|
|
26
84
|
> CreateBooking200Response createBooking(bookingCreateInputs)
|
|
27
85
|
|
|
@@ -0,0 +1,313 @@
|
|
|
1
|
+
# EventsPassesAccessesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createEventSessionAccess**](#createeventsessionaccess) | **POST** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Create Event Session Access|
|
|
8
|
+
|[**deleteEventSessionAccess**](#deleteeventsessionaccess) | **DELETE** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Delete Event Session Access|
|
|
9
|
+
|[**getEventPassAccesses**](#geteventpassaccesses) | **GET** /events/{eventId}/passes/{passId}/accesses | Get Event Pass Accesses|
|
|
10
|
+
|[**updateEventSessionAccess**](#updateeventsessionaccess) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Update Event Session Access|
|
|
11
|
+
|[**updateEventSessionAccessResponses**](#updateeventsessionaccessresponses) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId}/responses | Update Event Session Access Responses|
|
|
12
|
+
|
|
13
|
+
# **createEventSessionAccess**
|
|
14
|
+
> GetEventSessionAccess200Response createEventSessionAccess()
|
|
15
|
+
|
|
16
|
+
Create Event Session Access endpoint
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
EventsPassesAccessesApi,
|
|
23
|
+
Configuration
|
|
24
|
+
} from '@connectedxm/admin-sdk';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new EventsPassesAccessesApi(configuration);
|
|
28
|
+
|
|
29
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
30
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
31
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.createEventSessionAccess(
|
|
34
|
+
eventId,
|
|
35
|
+
sessionId,
|
|
36
|
+
passId
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
45
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
46
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
**GetEventSessionAccess200Response**
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: Not defined
|
|
60
|
+
- **Accept**: application/json
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### HTTP response details
|
|
64
|
+
| Status code | Description | Response headers |
|
|
65
|
+
|-------------|-------------|------------------|
|
|
66
|
+
|**200** | Successful response | - |
|
|
67
|
+
|
|
68
|
+
[[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)
|
|
69
|
+
|
|
70
|
+
# **deleteEventSessionAccess**
|
|
71
|
+
> CreateAccountInvitations200Response deleteEventSessionAccess()
|
|
72
|
+
|
|
73
|
+
Delete Event Session Access endpoint
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
EventsPassesAccessesApi,
|
|
80
|
+
Configuration
|
|
81
|
+
} from '@connectedxm/admin-sdk';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new EventsPassesAccessesApi(configuration);
|
|
85
|
+
|
|
86
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
87
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
88
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
89
|
+
|
|
90
|
+
const { status, data } = await apiInstance.deleteEventSessionAccess(
|
|
91
|
+
eventId,
|
|
92
|
+
sessionId,
|
|
93
|
+
passId
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|Name | Type | Description | Notes|
|
|
100
|
+
|------------- | ------------- | ------------- | -------------|
|
|
101
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
102
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
103
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
**CreateAccountInvitations200Response**
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: Not defined
|
|
117
|
+
- **Accept**: application/json
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
### HTTP response details
|
|
121
|
+
| Status code | Description | Response headers |
|
|
122
|
+
|-------------|-------------|------------------|
|
|
123
|
+
|**200** | Successful response | - |
|
|
124
|
+
|
|
125
|
+
[[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)
|
|
126
|
+
|
|
127
|
+
# **getEventPassAccesses**
|
|
128
|
+
> GetEventPassAccesses200Response getEventPassAccesses()
|
|
129
|
+
|
|
130
|
+
Get Event Pass Accesses endpoint
|
|
131
|
+
|
|
132
|
+
### Example
|
|
133
|
+
|
|
134
|
+
```typescript
|
|
135
|
+
import {
|
|
136
|
+
EventsPassesAccessesApi,
|
|
137
|
+
Configuration
|
|
138
|
+
} from '@connectedxm/admin-sdk';
|
|
139
|
+
|
|
140
|
+
const configuration = new Configuration();
|
|
141
|
+
const apiInstance = new EventsPassesAccessesApi(configuration);
|
|
142
|
+
|
|
143
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
144
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
145
|
+
let page: number; //Page number (optional) (default to 1)
|
|
146
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
147
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
148
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
149
|
+
|
|
150
|
+
const { status, data } = await apiInstance.getEventPassAccesses(
|
|
151
|
+
eventId,
|
|
152
|
+
passId,
|
|
153
|
+
page,
|
|
154
|
+
pageSize,
|
|
155
|
+
orderBy,
|
|
156
|
+
search
|
|
157
|
+
);
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Parameters
|
|
161
|
+
|
|
162
|
+
|Name | Type | Description | Notes|
|
|
163
|
+
|------------- | ------------- | ------------- | -------------|
|
|
164
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
165
|
+
| **passId** | [**string**] | The pass 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
|
+
**GetEventPassAccesses200Response**
|
|
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
|
+
|
|
186
|
+
### HTTP response details
|
|
187
|
+
| Status code | Description | Response headers |
|
|
188
|
+
|-------------|-------------|------------------|
|
|
189
|
+
|**200** | Successful response | - |
|
|
190
|
+
|
|
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
|
+
|
|
193
|
+
# **updateEventSessionAccess**
|
|
194
|
+
> GetEventSessionAccess200Response updateEventSessionAccess(eventSessionAccessUpdateInputs)
|
|
195
|
+
|
|
196
|
+
Update Event Session Access endpoint
|
|
197
|
+
|
|
198
|
+
### Example
|
|
199
|
+
|
|
200
|
+
```typescript
|
|
201
|
+
import {
|
|
202
|
+
EventsPassesAccessesApi,
|
|
203
|
+
Configuration,
|
|
204
|
+
EventSessionAccessUpdateInputs
|
|
205
|
+
} from '@connectedxm/admin-sdk';
|
|
206
|
+
|
|
207
|
+
const configuration = new Configuration();
|
|
208
|
+
const apiInstance = new EventsPassesAccessesApi(configuration);
|
|
209
|
+
|
|
210
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
211
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
212
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
213
|
+
let eventSessionAccessUpdateInputs: EventSessionAccessUpdateInputs; //
|
|
214
|
+
|
|
215
|
+
const { status, data } = await apiInstance.updateEventSessionAccess(
|
|
216
|
+
eventId,
|
|
217
|
+
sessionId,
|
|
218
|
+
passId,
|
|
219
|
+
eventSessionAccessUpdateInputs
|
|
220
|
+
);
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
|Name | Type | Description | Notes|
|
|
226
|
+
|------------- | ------------- | ------------- | -------------|
|
|
227
|
+
| **eventSessionAccessUpdateInputs** | **EventSessionAccessUpdateInputs**| | |
|
|
228
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
229
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
230
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
### Return type
|
|
234
|
+
|
|
235
|
+
**GetEventSessionAccess200Response**
|
|
236
|
+
|
|
237
|
+
### Authorization
|
|
238
|
+
|
|
239
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
240
|
+
|
|
241
|
+
### HTTP request headers
|
|
242
|
+
|
|
243
|
+
- **Content-Type**: application/json
|
|
244
|
+
- **Accept**: application/json
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
### HTTP response details
|
|
248
|
+
| Status code | Description | Response headers |
|
|
249
|
+
|-------------|-------------|------------------|
|
|
250
|
+
|**200** | Successful response | - |
|
|
251
|
+
|
|
252
|
+
[[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)
|
|
253
|
+
|
|
254
|
+
# **updateEventSessionAccessResponses**
|
|
255
|
+
> CreateAccountInvitations200Response updateEventSessionAccessResponses(requestBody)
|
|
256
|
+
|
|
257
|
+
Update Event Session Access Responses endpoint
|
|
258
|
+
|
|
259
|
+
### Example
|
|
260
|
+
|
|
261
|
+
```typescript
|
|
262
|
+
import {
|
|
263
|
+
EventsPassesAccessesApi,
|
|
264
|
+
Configuration
|
|
265
|
+
} from '@connectedxm/admin-sdk';
|
|
266
|
+
|
|
267
|
+
const configuration = new Configuration();
|
|
268
|
+
const apiInstance = new EventsPassesAccessesApi(configuration);
|
|
269
|
+
|
|
270
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
271
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
272
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
273
|
+
let requestBody: Array<object>; //
|
|
274
|
+
|
|
275
|
+
const { status, data } = await apiInstance.updateEventSessionAccessResponses(
|
|
276
|
+
eventId,
|
|
277
|
+
sessionId,
|
|
278
|
+
passId,
|
|
279
|
+
requestBody
|
|
280
|
+
);
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Parameters
|
|
284
|
+
|
|
285
|
+
|Name | Type | Description | Notes|
|
|
286
|
+
|------------- | ------------- | ------------- | -------------|
|
|
287
|
+
| **requestBody** | **Array<object>**| | |
|
|
288
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
289
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
290
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
### Return type
|
|
294
|
+
|
|
295
|
+
**CreateAccountInvitations200Response**
|
|
296
|
+
|
|
297
|
+
### Authorization
|
|
298
|
+
|
|
299
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
300
|
+
|
|
301
|
+
### HTTP request headers
|
|
302
|
+
|
|
303
|
+
- **Content-Type**: application/json
|
|
304
|
+
- **Accept**: application/json
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
### HTTP response details
|
|
308
|
+
| Status code | Description | Response headers |
|
|
309
|
+
|-------------|-------------|------------------|
|
|
310
|
+
|**200** | Successful response | - |
|
|
311
|
+
|
|
312
|
+
[[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)
|
|
313
|
+
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
# EventsPassesAddonsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add Event Pass Add On|
|
|
8
|
+
|[**getEventPassAddOns**](#geteventpassaddons) | **GET** /events/{eventId}/passes/{passId}/addOns | Get Event Pass Add Ons|
|
|
9
|
+
|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove Event Pass Add On|
|
|
10
|
+
|
|
11
|
+
# **addEventPassAddOn**
|
|
12
|
+
> CreateEventPass200Response addEventPassAddOn()
|
|
13
|
+
|
|
14
|
+
Add Event Pass Add On endpoint
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
EventsPassesAddonsApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from '@connectedxm/admin-sdk';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new EventsPassesAddonsApi(configuration);
|
|
26
|
+
|
|
27
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
28
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
29
|
+
let addOnId: string; //The addOn identifier (default to undefined)
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.addEventPassAddOn(
|
|
32
|
+
eventId,
|
|
33
|
+
passId,
|
|
34
|
+
addOnId
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
43
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
44
|
+
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### Return type
|
|
48
|
+
|
|
49
|
+
**CreateEventPass200Response**
|
|
50
|
+
|
|
51
|
+
### Authorization
|
|
52
|
+
|
|
53
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
54
|
+
|
|
55
|
+
### HTTP request headers
|
|
56
|
+
|
|
57
|
+
- **Content-Type**: Not defined
|
|
58
|
+
- **Accept**: application/json
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### HTTP response details
|
|
62
|
+
| Status code | Description | Response headers |
|
|
63
|
+
|-------------|-------------|------------------|
|
|
64
|
+
|**200** | Successful response | - |
|
|
65
|
+
|
|
66
|
+
[[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)
|
|
67
|
+
|
|
68
|
+
# **getEventPassAddOns**
|
|
69
|
+
> GetEventAddOns200Response getEventPassAddOns()
|
|
70
|
+
|
|
71
|
+
Get Event Pass Add Ons endpoint
|
|
72
|
+
|
|
73
|
+
### Example
|
|
74
|
+
|
|
75
|
+
```typescript
|
|
76
|
+
import {
|
|
77
|
+
EventsPassesAddonsApi,
|
|
78
|
+
Configuration
|
|
79
|
+
} from '@connectedxm/admin-sdk';
|
|
80
|
+
|
|
81
|
+
const configuration = new Configuration();
|
|
82
|
+
const apiInstance = new EventsPassesAddonsApi(configuration);
|
|
83
|
+
|
|
84
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
85
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
86
|
+
let page: number; //Page number (optional) (default to 1)
|
|
87
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
88
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
89
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
90
|
+
|
|
91
|
+
const { status, data } = await apiInstance.getEventPassAddOns(
|
|
92
|
+
eventId,
|
|
93
|
+
passId,
|
|
94
|
+
page,
|
|
95
|
+
pageSize,
|
|
96
|
+
orderBy,
|
|
97
|
+
search
|
|
98
|
+
);
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Parameters
|
|
102
|
+
|
|
103
|
+
|Name | Type | Description | Notes|
|
|
104
|
+
|------------- | ------------- | ------------- | -------------|
|
|
105
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
106
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
107
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
108
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
109
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
110
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
### Return type
|
|
114
|
+
|
|
115
|
+
**GetEventAddOns200Response**
|
|
116
|
+
|
|
117
|
+
### Authorization
|
|
118
|
+
|
|
119
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
120
|
+
|
|
121
|
+
### HTTP request headers
|
|
122
|
+
|
|
123
|
+
- **Content-Type**: Not defined
|
|
124
|
+
- **Accept**: application/json
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
### HTTP response details
|
|
128
|
+
| Status code | Description | Response headers |
|
|
129
|
+
|-------------|-------------|------------------|
|
|
130
|
+
|**200** | Successful response | - |
|
|
131
|
+
|
|
132
|
+
[[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)
|
|
133
|
+
|
|
134
|
+
# **removeEventPassAddOn**
|
|
135
|
+
> CreateEventPass200Response removeEventPassAddOn()
|
|
136
|
+
|
|
137
|
+
Remove Event Pass Add On endpoint
|
|
138
|
+
|
|
139
|
+
### Example
|
|
140
|
+
|
|
141
|
+
```typescript
|
|
142
|
+
import {
|
|
143
|
+
EventsPassesAddonsApi,
|
|
144
|
+
Configuration
|
|
145
|
+
} from '@connectedxm/admin-sdk';
|
|
146
|
+
|
|
147
|
+
const configuration = new Configuration();
|
|
148
|
+
const apiInstance = new EventsPassesAddonsApi(configuration);
|
|
149
|
+
|
|
150
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
151
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
152
|
+
let addOnId: string; //The addOn identifier (default to undefined)
|
|
153
|
+
|
|
154
|
+
const { status, data } = await apiInstance.removeEventPassAddOn(
|
|
155
|
+
eventId,
|
|
156
|
+
passId,
|
|
157
|
+
addOnId
|
|
158
|
+
);
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Parameters
|
|
162
|
+
|
|
163
|
+
|Name | Type | Description | Notes|
|
|
164
|
+
|------------- | ------------- | ------------- | -------------|
|
|
165
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
166
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
167
|
+
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
### Return type
|
|
171
|
+
|
|
172
|
+
**CreateEventPass200Response**
|
|
173
|
+
|
|
174
|
+
### Authorization
|
|
175
|
+
|
|
176
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
177
|
+
|
|
178
|
+
### HTTP request headers
|
|
179
|
+
|
|
180
|
+
- **Content-Type**: Not defined
|
|
181
|
+
- **Accept**: application/json
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
### HTTP response details
|
|
185
|
+
| Status code | Description | Response headers |
|
|
186
|
+
|-------------|-------------|------------------|
|
|
187
|
+
|**200** | Successful response | - |
|
|
188
|
+
|
|
189
|
+
[[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)
|
|
190
|
+
|