@connectedxm/admin-sdk 7.13.1 → 8.1.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/.openapi-generator/FILES +19 -20
- package/AdminApi.ts +9 -9
- package/README.md +49 -50
- package/api.ts +17309 -17308
- package/dist/AdminApi.d.ts +4 -4
- package/dist/AdminApi.js +3 -3
- package/dist/api.d.ts +9526 -9525
- package/dist/api.js +13576 -13575
- package/dist/esm/AdminApi.d.ts +4 -4
- package/dist/esm/AdminApi.js +4 -4
- package/dist/esm/api.d.ts +9526 -9525
- package/dist/esm/api.js +13603 -13602
- package/docs/BaseEventPass.md +1 -1
- package/docs/{BaseEventAttendee.md → BaseEventRegistration.md} +3 -3
- package/docs/BaseMatchPass.md +1 -1
- package/docs/BasePassAddOnPass.md +2 -2
- package/docs/{BaseAttendeePackage.md → BaseRegistrationPackage.md} +3 -3
- package/docs/BaseSideEffect.md +2 -0
- 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/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/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/SideEffect.md +4 -0
- package/docs/SideEffectTriggerType.md +2 -0
- package/docs/TransferLog.md +2 -2
- package/package.json +2 -2
- package/docs/BasePassAddOnPassAttendee.md +0 -20
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventsRegistrationsPackagesApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**
|
|
9
|
-
|[**
|
|
10
|
-
|[**
|
|
11
|
-
|[**
|
|
7
|
+
|[**createEventRegistrationPackage**](#createeventregistrationpackage) | **POST** /events/{eventId}/registrations/{registrationId}/packages | Create a package for an event registration|
|
|
8
|
+
|[**deleteEventRegistrationPackage**](#deleteeventregistrationpackage) | **DELETE** /events/{eventId}/registrations/{registrationId}/packages/{packageId} | Delete an event registration\'s package|
|
|
9
|
+
|[**getEventRegistrationPackage**](#geteventregistrationpackage) | **GET** /events/{eventId}/registrations/{registrationId}/packages/{packageId} | Get a registration\'s event package|
|
|
10
|
+
|[**getEventRegistrationPackages**](#geteventregistrationpackages) | **GET** /events/{eventId}/registrations/{registrationId}/packages | List a registration\'s event packages|
|
|
11
|
+
|[**updateEventRegistrationPackage**](#updateeventregistrationpackage) | **PUT** /events/{eventId}/registrations/{registrationId}/packages/{packageId} | Update an event registration\'s package|
|
|
12
12
|
|
|
13
|
-
# **
|
|
14
|
-
>
|
|
13
|
+
# **createEventRegistrationPackage**
|
|
14
|
+
> CreateEventRegistrationPackage200Response createEventRegistrationPackage()
|
|
15
15
|
|
|
16
|
-
Creates a new attendee package (e.g. a bundled add-on/room package purchase) for the given
|
|
16
|
+
Creates a new attendee package (e.g. a bundled add-on/room package purchase) for the given registration at an event, requiring read and update permission on attendees.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
21
|
import {
|
|
22
|
-
|
|
22
|
+
EventsRegistrationsPackagesApi,
|
|
23
23
|
Configuration,
|
|
24
|
-
|
|
24
|
+
EventRegistrationPackageCreateInputs
|
|
25
25
|
} from '@connectedxm/admin-sdk';
|
|
26
26
|
|
|
27
27
|
const configuration = new Configuration();
|
|
28
|
-
const apiInstance = new
|
|
28
|
+
const apiInstance = new EventsRegistrationsPackagesApi(configuration);
|
|
29
29
|
|
|
30
30
|
let eventId: string; //The event identifier (default to undefined)
|
|
31
|
-
let
|
|
32
|
-
let _package:
|
|
31
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
32
|
+
let _package: EventRegistrationPackageCreateInputs; //Filter by package (default to undefined)
|
|
33
33
|
|
|
34
|
-
const { status, data } = await apiInstance.
|
|
34
|
+
const { status, data } = await apiInstance.createEventRegistrationPackage(
|
|
35
35
|
eventId,
|
|
36
|
-
|
|
36
|
+
registrationId,
|
|
37
37
|
_package
|
|
38
38
|
);
|
|
39
39
|
```
|
|
@@ -43,13 +43,13 @@ const { status, data } = await apiInstance.createEventAttendeePackage(
|
|
|
43
43
|
|Name | Type | Description | Notes|
|
|
44
44
|
|------------- | ------------- | ------------- | -------------|
|
|
45
45
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
46
|
-
| **
|
|
47
|
-
| **_package** | **
|
|
46
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
47
|
+
| **_package** | **EventRegistrationPackageCreateInputs** | Filter by package | defaults to undefined|
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### Return type
|
|
51
51
|
|
|
52
|
-
**
|
|
52
|
+
**CreateEventRegistrationPackage200Response**
|
|
53
53
|
|
|
54
54
|
### Authorization
|
|
55
55
|
|
|
@@ -68,29 +68,29 @@ const { status, data } = await apiInstance.createEventAttendeePackage(
|
|
|
68
68
|
|
|
69
69
|
[[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)
|
|
70
70
|
|
|
71
|
-
# **
|
|
72
|
-
> SyncAccounts200Response
|
|
71
|
+
# **deleteEventRegistrationPackage**
|
|
72
|
+
> SyncAccounts200Response deleteEventRegistrationPackage()
|
|
73
73
|
|
|
74
|
-
Permanently deletes a specific attendee package purchase belonging to
|
|
74
|
+
Permanently deletes a specific attendee package purchase belonging to the given registration at an event, requiring read and update permission on attendees.
|
|
75
75
|
|
|
76
76
|
### Example
|
|
77
77
|
|
|
78
78
|
```typescript
|
|
79
79
|
import {
|
|
80
|
-
|
|
80
|
+
EventsRegistrationsPackagesApi,
|
|
81
81
|
Configuration
|
|
82
82
|
} from '@connectedxm/admin-sdk';
|
|
83
83
|
|
|
84
84
|
const configuration = new Configuration();
|
|
85
|
-
const apiInstance = new
|
|
85
|
+
const apiInstance = new EventsRegistrationsPackagesApi(configuration);
|
|
86
86
|
|
|
87
87
|
let eventId: string; //The event identifier (default to undefined)
|
|
88
|
-
let
|
|
88
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
89
89
|
let packageId: string; //The package identifier (default to undefined)
|
|
90
90
|
|
|
91
|
-
const { status, data } = await apiInstance.
|
|
91
|
+
const { status, data } = await apiInstance.deleteEventRegistrationPackage(
|
|
92
92
|
eventId,
|
|
93
|
-
|
|
93
|
+
registrationId,
|
|
94
94
|
packageId
|
|
95
95
|
);
|
|
96
96
|
```
|
|
@@ -100,7 +100,7 @@ const { status, data } = await apiInstance.deleteEventAttendeePackage(
|
|
|
100
100
|
|Name | Type | Description | Notes|
|
|
101
101
|
|------------- | ------------- | ------------- | -------------|
|
|
102
102
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
103
|
-
| **
|
|
103
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
104
104
|
| **packageId** | [**string**] | The package identifier | defaults to undefined|
|
|
105
105
|
|
|
106
106
|
|
|
@@ -125,29 +125,29 @@ const { status, data } = await apiInstance.deleteEventAttendeePackage(
|
|
|
125
125
|
|
|
126
126
|
[[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)
|
|
127
127
|
|
|
128
|
-
# **
|
|
129
|
-
>
|
|
128
|
+
# **getEventRegistrationPackage**
|
|
129
|
+
> CreateEventRegistrationPackage200Response getEventRegistrationPackage()
|
|
130
130
|
|
|
131
|
-
Returns a single package purchased
|
|
131
|
+
Returns a single package purchased under the given registration for the specified event, identified by packageId; requires read permission on events and attendees.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
135
135
|
```typescript
|
|
136
136
|
import {
|
|
137
|
-
|
|
137
|
+
EventsRegistrationsPackagesApi,
|
|
138
138
|
Configuration
|
|
139
139
|
} from '@connectedxm/admin-sdk';
|
|
140
140
|
|
|
141
141
|
const configuration = new Configuration();
|
|
142
|
-
const apiInstance = new
|
|
142
|
+
const apiInstance = new EventsRegistrationsPackagesApi(configuration);
|
|
143
143
|
|
|
144
144
|
let eventId: string; //The event identifier (default to undefined)
|
|
145
|
-
let
|
|
145
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
146
146
|
let packageId: string; //The package identifier (default to undefined)
|
|
147
147
|
|
|
148
|
-
const { status, data } = await apiInstance.
|
|
148
|
+
const { status, data } = await apiInstance.getEventRegistrationPackage(
|
|
149
149
|
eventId,
|
|
150
|
-
|
|
150
|
+
registrationId,
|
|
151
151
|
packageId
|
|
152
152
|
);
|
|
153
153
|
```
|
|
@@ -157,13 +157,13 @@ const { status, data } = await apiInstance.getEventAttendeePackage(
|
|
|
157
157
|
|Name | Type | Description | Notes|
|
|
158
158
|
|------------- | ------------- | ------------- | -------------|
|
|
159
159
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
160
|
-
| **
|
|
160
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
161
161
|
| **packageId** | [**string**] | The package identifier | defaults to undefined|
|
|
162
162
|
|
|
163
163
|
|
|
164
164
|
### Return type
|
|
165
165
|
|
|
166
|
-
**
|
|
166
|
+
**CreateEventRegistrationPackage200Response**
|
|
167
167
|
|
|
168
168
|
### Authorization
|
|
169
169
|
|
|
@@ -182,33 +182,33 @@ const { status, data } = await apiInstance.getEventAttendeePackage(
|
|
|
182
182
|
|
|
183
183
|
[[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)
|
|
184
184
|
|
|
185
|
-
# **
|
|
186
|
-
>
|
|
185
|
+
# **getEventRegistrationPackages**
|
|
186
|
+
> GetEventRegistrationPackages200Response getEventRegistrationPackages()
|
|
187
187
|
|
|
188
|
-
Returns a paginated list of packages purchased
|
|
188
|
+
Returns a paginated list of packages purchased under the given registration for the specified event, optionally filtered by purchase status, with search and ordering support; requires read permission on events and attendees.
|
|
189
189
|
|
|
190
190
|
### Example
|
|
191
191
|
|
|
192
192
|
```typescript
|
|
193
193
|
import {
|
|
194
|
-
|
|
194
|
+
EventsRegistrationsPackagesApi,
|
|
195
195
|
Configuration
|
|
196
196
|
} from '@connectedxm/admin-sdk';
|
|
197
197
|
|
|
198
198
|
const configuration = new Configuration();
|
|
199
|
-
const apiInstance = new
|
|
199
|
+
const apiInstance = new EventsRegistrationsPackagesApi(configuration);
|
|
200
200
|
|
|
201
201
|
let eventId: string; //The event identifier (default to undefined)
|
|
202
|
-
let
|
|
202
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
203
203
|
let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
|
|
204
204
|
let page: number; //Page number (optional) (default to 1)
|
|
205
205
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
206
206
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
207
207
|
let search: string; //Search query (optional) (default to undefined)
|
|
208
208
|
|
|
209
|
-
const { status, data } = await apiInstance.
|
|
209
|
+
const { status, data } = await apiInstance.getEventRegistrationPackages(
|
|
210
210
|
eventId,
|
|
211
|
-
|
|
211
|
+
registrationId,
|
|
212
212
|
status,
|
|
213
213
|
page,
|
|
214
214
|
pageSize,
|
|
@@ -222,7 +222,7 @@ const { status, data } = await apiInstance.getEventAttendeePackages(
|
|
|
222
222
|
|Name | Type | Description | Notes|
|
|
223
223
|
|------------- | ------------- | ------------- | -------------|
|
|
224
224
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
225
|
-
| **
|
|
225
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
226
226
|
| **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
|
|
227
227
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
228
228
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
@@ -232,7 +232,7 @@ const { status, data } = await apiInstance.getEventAttendeePackages(
|
|
|
232
232
|
|
|
233
233
|
### Return type
|
|
234
234
|
|
|
235
|
-
**
|
|
235
|
+
**GetEventRegistrationPackages200Response**
|
|
236
236
|
|
|
237
237
|
### Authorization
|
|
238
238
|
|
|
@@ -251,31 +251,31 @@ const { status, data } = await apiInstance.getEventAttendeePackages(
|
|
|
251
251
|
|
|
252
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
253
|
|
|
254
|
-
# **
|
|
255
|
-
>
|
|
254
|
+
# **updateEventRegistrationPackage**
|
|
255
|
+
> CreateEventRegistrationPackage200Response updateEventRegistrationPackage()
|
|
256
256
|
|
|
257
|
-
Updates the details of an existing attendee package purchase for
|
|
257
|
+
Updates the details of an existing attendee package purchase for the given registration at an event, requiring read and update permission on attendees.
|
|
258
258
|
|
|
259
259
|
### Example
|
|
260
260
|
|
|
261
261
|
```typescript
|
|
262
262
|
import {
|
|
263
|
-
|
|
263
|
+
EventsRegistrationsPackagesApi,
|
|
264
264
|
Configuration,
|
|
265
|
-
|
|
265
|
+
EventRegistrationPackageUpdateInputs
|
|
266
266
|
} from '@connectedxm/admin-sdk';
|
|
267
267
|
|
|
268
268
|
const configuration = new Configuration();
|
|
269
|
-
const apiInstance = new
|
|
269
|
+
const apiInstance = new EventsRegistrationsPackagesApi(configuration);
|
|
270
270
|
|
|
271
271
|
let eventId: string; //The event identifier (default to undefined)
|
|
272
|
-
let
|
|
272
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
273
273
|
let packageId: string; //The package identifier (default to undefined)
|
|
274
|
-
let _package:
|
|
274
|
+
let _package: EventRegistrationPackageUpdateInputs; //Filter by package (default to undefined)
|
|
275
275
|
|
|
276
|
-
const { status, data } = await apiInstance.
|
|
276
|
+
const { status, data } = await apiInstance.updateEventRegistrationPackage(
|
|
277
277
|
eventId,
|
|
278
|
-
|
|
278
|
+
registrationId,
|
|
279
279
|
packageId,
|
|
280
280
|
_package
|
|
281
281
|
);
|
|
@@ -286,14 +286,14 @@ const { status, data } = await apiInstance.updateEventAttendeePackage(
|
|
|
286
286
|
|Name | Type | Description | Notes|
|
|
287
287
|
|------------- | ------------- | ------------- | -------------|
|
|
288
288
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
289
|
-
| **
|
|
289
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
290
290
|
| **packageId** | [**string**] | The package identifier | defaults to undefined|
|
|
291
|
-
| **_package** | **
|
|
291
|
+
| **_package** | **EventRegistrationPackageUpdateInputs** | Filter by package | defaults to undefined|
|
|
292
292
|
|
|
293
293
|
|
|
294
294
|
### Return type
|
|
295
295
|
|
|
296
|
-
**
|
|
296
|
+
**CreateEventRegistrationPackage200Response**
|
|
297
297
|
|
|
298
298
|
### Authorization
|
|
299
299
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventsRegistrationsReservationsApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
4
|
|
|
@@ -7,7 +7,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
7
7
|
|[**addEventReservationPass**](#addeventreservationpass) | **POST** /events/{eventId}/reservations/{reservationId}/passes/{passId} | Attach a pass to a room reservation|
|
|
8
8
|
|[**createEventReservation**](#createeventreservation) | **POST** /events/{eventId}/reservations | Create a room type reservation for an event|
|
|
9
9
|
|[**deleteEventReservation**](#deleteeventreservation) | **DELETE** /events/{eventId}/reservations/{reservationId} | Delete an event room reservation|
|
|
10
|
-
|[**
|
|
10
|
+
|[**getEventRegistrationReservations**](#geteventregistrationreservations) | **GET** /events/{eventId}/registrations/{registrationId}/reservations | List a registration\'s room reservations|
|
|
11
11
|
|[**getEventReservation**](#geteventreservation) | **GET** /events/{eventId}/reservations/{reservationId} | Get an event room reservation|
|
|
12
12
|
|[**getEventReservationPasses**](#geteventreservationpasses) | **GET** /events/{eventId}/reservations/{reservationId}/passes | List passes attached to a room reservation|
|
|
13
13
|
|[**getEventReservations**](#geteventreservations) | **GET** /events/{eventId}/reservations | List an event\'s room reservations|
|
|
@@ -23,23 +23,23 @@ Connects an existing event pass (purchase) to a room type reservation for an eve
|
|
|
23
23
|
|
|
24
24
|
```typescript
|
|
25
25
|
import {
|
|
26
|
-
|
|
26
|
+
EventsRegistrationsReservationsApi,
|
|
27
27
|
Configuration
|
|
28
28
|
} from '@connectedxm/admin-sdk';
|
|
29
29
|
|
|
30
30
|
const configuration = new Configuration();
|
|
31
|
-
const apiInstance = new
|
|
31
|
+
const apiInstance = new EventsRegistrationsReservationsApi(configuration);
|
|
32
32
|
|
|
33
33
|
let eventId: string; //The event identifier (default to undefined)
|
|
34
34
|
let reservationId: string; //The reservation identifier (default to undefined)
|
|
35
35
|
let passId: string; //The pass identifier (default to undefined)
|
|
36
|
-
let
|
|
36
|
+
let registrationId: string; //Filter by registrationId (optional) (default to undefined)
|
|
37
37
|
|
|
38
38
|
const { status, data } = await apiInstance.addEventReservationPass(
|
|
39
39
|
eventId,
|
|
40
40
|
reservationId,
|
|
41
41
|
passId,
|
|
42
|
-
|
|
42
|
+
registrationId
|
|
43
43
|
);
|
|
44
44
|
```
|
|
45
45
|
|
|
@@ -50,7 +50,7 @@ const { status, data } = await apiInstance.addEventReservationPass(
|
|
|
50
50
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
51
51
|
| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
|
|
52
52
|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
53
|
-
| **
|
|
53
|
+
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
### Return type
|
|
@@ -83,22 +83,22 @@ Creates a new room reservation for an event, linking it to an event room type an
|
|
|
83
83
|
|
|
84
84
|
```typescript
|
|
85
85
|
import {
|
|
86
|
-
|
|
86
|
+
EventsRegistrationsReservationsApi,
|
|
87
87
|
Configuration,
|
|
88
88
|
EventRoomTypeReservationCreateInputs
|
|
89
89
|
} from '@connectedxm/admin-sdk';
|
|
90
90
|
|
|
91
91
|
const configuration = new Configuration();
|
|
92
|
-
const apiInstance = new
|
|
92
|
+
const apiInstance = new EventsRegistrationsReservationsApi(configuration);
|
|
93
93
|
|
|
94
94
|
let eventId: string; //The event identifier (default to undefined)
|
|
95
95
|
let eventRoomTypeReservationCreateInputs: EventRoomTypeReservationCreateInputs; //
|
|
96
|
-
let
|
|
96
|
+
let registrationId: string; //Filter by registrationId (optional) (default to undefined)
|
|
97
97
|
|
|
98
98
|
const { status, data } = await apiInstance.createEventReservation(
|
|
99
99
|
eventId,
|
|
100
100
|
eventRoomTypeReservationCreateInputs,
|
|
101
|
-
|
|
101
|
+
registrationId
|
|
102
102
|
);
|
|
103
103
|
```
|
|
104
104
|
|
|
@@ -108,7 +108,7 @@ const { status, data } = await apiInstance.createEventReservation(
|
|
|
108
108
|
|------------- | ------------- | ------------- | -------------|
|
|
109
109
|
| **eventRoomTypeReservationCreateInputs** | **EventRoomTypeReservationCreateInputs**| | |
|
|
110
110
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
111
|
-
| **
|
|
111
|
+
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|
|
|
112
112
|
|
|
113
113
|
|
|
114
114
|
### Return type
|
|
@@ -141,21 +141,21 @@ Permanently deletes a room type reservation from an event, requiring read and up
|
|
|
141
141
|
|
|
142
142
|
```typescript
|
|
143
143
|
import {
|
|
144
|
-
|
|
144
|
+
EventsRegistrationsReservationsApi,
|
|
145
145
|
Configuration
|
|
146
146
|
} from '@connectedxm/admin-sdk';
|
|
147
147
|
|
|
148
148
|
const configuration = new Configuration();
|
|
149
|
-
const apiInstance = new
|
|
149
|
+
const apiInstance = new EventsRegistrationsReservationsApi(configuration);
|
|
150
150
|
|
|
151
151
|
let eventId: string; //The event identifier (default to undefined)
|
|
152
152
|
let reservationId: string; //The reservation identifier (default to undefined)
|
|
153
|
-
let
|
|
153
|
+
let registrationId: string; //Filter by registrationId (optional) (default to undefined)
|
|
154
154
|
|
|
155
155
|
const { status, data } = await apiInstance.deleteEventReservation(
|
|
156
156
|
eventId,
|
|
157
157
|
reservationId,
|
|
158
|
-
|
|
158
|
+
registrationId
|
|
159
159
|
);
|
|
160
160
|
```
|
|
161
161
|
|
|
@@ -165,7 +165,7 @@ const { status, data } = await apiInstance.deleteEventReservation(
|
|
|
165
165
|
|------------- | ------------- | ------------- | -------------|
|
|
166
166
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
167
167
|
| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
|
|
168
|
-
| **
|
|
168
|
+
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|
|
|
169
169
|
|
|
170
170
|
|
|
171
171
|
### Return type
|
|
@@ -189,32 +189,32 @@ const { status, data } = await apiInstance.deleteEventReservation(
|
|
|
189
189
|
|
|
190
190
|
[[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)
|
|
191
191
|
|
|
192
|
-
# **
|
|
193
|
-
>
|
|
192
|
+
# **getEventRegistrationReservations**
|
|
193
|
+
> GetEventRegistrationReservations200Response getEventRegistrationReservations()
|
|
194
194
|
|
|
195
|
-
Returns a paginated list of room-type reservations belonging to the given
|
|
195
|
+
Returns a paginated list of room-type reservations belonging to the given registration for the specified event, with search and ordering support; requires read permission on events and attendees.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
199
199
|
```typescript
|
|
200
200
|
import {
|
|
201
|
-
|
|
201
|
+
EventsRegistrationsReservationsApi,
|
|
202
202
|
Configuration
|
|
203
203
|
} from '@connectedxm/admin-sdk';
|
|
204
204
|
|
|
205
205
|
const configuration = new Configuration();
|
|
206
|
-
const apiInstance = new
|
|
206
|
+
const apiInstance = new EventsRegistrationsReservationsApi(configuration);
|
|
207
207
|
|
|
208
208
|
let eventId: string; //The event identifier (default to undefined)
|
|
209
|
-
let
|
|
209
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
210
210
|
let page: number; //Page number (optional) (default to 1)
|
|
211
211
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
212
212
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
213
213
|
let search: string; //Search query (optional) (default to undefined)
|
|
214
214
|
|
|
215
|
-
const { status, data } = await apiInstance.
|
|
215
|
+
const { status, data } = await apiInstance.getEventRegistrationReservations(
|
|
216
216
|
eventId,
|
|
217
|
-
|
|
217
|
+
registrationId,
|
|
218
218
|
page,
|
|
219
219
|
pageSize,
|
|
220
220
|
orderBy,
|
|
@@ -227,7 +227,7 @@ const { status, data } = await apiInstance.getEventAttendeeReservations(
|
|
|
227
227
|
|Name | Type | Description | Notes|
|
|
228
228
|
|------------- | ------------- | ------------- | -------------|
|
|
229
229
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
230
|
-
| **
|
|
230
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
231
231
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
232
232
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
233
233
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
@@ -236,7 +236,7 @@ const { status, data } = await apiInstance.getEventAttendeeReservations(
|
|
|
236
236
|
|
|
237
237
|
### Return type
|
|
238
238
|
|
|
239
|
-
**
|
|
239
|
+
**GetEventRegistrationReservations200Response**
|
|
240
240
|
|
|
241
241
|
### Authorization
|
|
242
242
|
|
|
@@ -264,12 +264,12 @@ Returns a single room-type reservation for the specified event, identified by re
|
|
|
264
264
|
|
|
265
265
|
```typescript
|
|
266
266
|
import {
|
|
267
|
-
|
|
267
|
+
EventsRegistrationsReservationsApi,
|
|
268
268
|
Configuration
|
|
269
269
|
} from '@connectedxm/admin-sdk';
|
|
270
270
|
|
|
271
271
|
const configuration = new Configuration();
|
|
272
|
-
const apiInstance = new
|
|
272
|
+
const apiInstance = new EventsRegistrationsReservationsApi(configuration);
|
|
273
273
|
|
|
274
274
|
let eventId: string; //The event identifier (default to undefined)
|
|
275
275
|
let reservationId: string; //The reservation identifier (default to undefined)
|
|
@@ -318,12 +318,12 @@ Returns a paginated list of attendee passes associated with the given room-type
|
|
|
318
318
|
|
|
319
319
|
```typescript
|
|
320
320
|
import {
|
|
321
|
-
|
|
321
|
+
EventsRegistrationsReservationsApi,
|
|
322
322
|
Configuration
|
|
323
323
|
} from '@connectedxm/admin-sdk';
|
|
324
324
|
|
|
325
325
|
const configuration = new Configuration();
|
|
326
|
-
const apiInstance = new
|
|
326
|
+
const apiInstance = new EventsRegistrationsReservationsApi(configuration);
|
|
327
327
|
|
|
328
328
|
let eventId: string; //The event identifier (default to undefined)
|
|
329
329
|
let reservationId: string; //The reservation identifier (default to undefined)
|
|
@@ -376,7 +376,7 @@ const { status, data } = await apiInstance.getEventReservationPasses(
|
|
|
376
376
|
[[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)
|
|
377
377
|
|
|
378
378
|
# **getEventReservations**
|
|
379
|
-
>
|
|
379
|
+
> GetEventRegistrationReservations200Response getEventReservations()
|
|
380
380
|
|
|
381
381
|
Returns a paginated list of room-type reservations for the specified event, with search and ordering support; requires read permission on events and attendees.
|
|
382
382
|
|
|
@@ -384,12 +384,12 @@ Returns a paginated list of room-type reservations for the specified event, with
|
|
|
384
384
|
|
|
385
385
|
```typescript
|
|
386
386
|
import {
|
|
387
|
-
|
|
387
|
+
EventsRegistrationsReservationsApi,
|
|
388
388
|
Configuration
|
|
389
389
|
} from '@connectedxm/admin-sdk';
|
|
390
390
|
|
|
391
391
|
const configuration = new Configuration();
|
|
392
|
-
const apiInstance = new
|
|
392
|
+
const apiInstance = new EventsRegistrationsReservationsApi(configuration);
|
|
393
393
|
|
|
394
394
|
let eventId: string; //The event identifier (default to undefined)
|
|
395
395
|
let page: number; //Page number (optional) (default to 1)
|
|
@@ -419,7 +419,7 @@ const { status, data } = await apiInstance.getEventReservations(
|
|
|
419
419
|
|
|
420
420
|
### Return type
|
|
421
421
|
|
|
422
|
-
**
|
|
422
|
+
**GetEventRegistrationReservations200Response**
|
|
423
423
|
|
|
424
424
|
### Authorization
|
|
425
425
|
|
|
@@ -447,23 +447,23 @@ Disconnects an event pass (purchase) from a room type reservation for an event,
|
|
|
447
447
|
|
|
448
448
|
```typescript
|
|
449
449
|
import {
|
|
450
|
-
|
|
450
|
+
EventsRegistrationsReservationsApi,
|
|
451
451
|
Configuration
|
|
452
452
|
} from '@connectedxm/admin-sdk';
|
|
453
453
|
|
|
454
454
|
const configuration = new Configuration();
|
|
455
|
-
const apiInstance = new
|
|
455
|
+
const apiInstance = new EventsRegistrationsReservationsApi(configuration);
|
|
456
456
|
|
|
457
457
|
let eventId: string; //The event identifier (default to undefined)
|
|
458
458
|
let reservationId: string; //The reservation identifier (default to undefined)
|
|
459
459
|
let passId: string; //The pass identifier (default to undefined)
|
|
460
|
-
let
|
|
460
|
+
let registrationId: string; //Filter by registrationId (optional) (default to undefined)
|
|
461
461
|
|
|
462
462
|
const { status, data } = await apiInstance.removeEventReservationPass(
|
|
463
463
|
eventId,
|
|
464
464
|
reservationId,
|
|
465
465
|
passId,
|
|
466
|
-
|
|
466
|
+
registrationId
|
|
467
467
|
);
|
|
468
468
|
```
|
|
469
469
|
|
|
@@ -474,7 +474,7 @@ const { status, data } = await apiInstance.removeEventReservationPass(
|
|
|
474
474
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
475
475
|
| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
|
|
476
476
|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
477
|
-
| **
|
|
477
|
+
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|
|
|
478
478
|
|
|
479
479
|
|
|
480
480
|
### Return type
|
|
@@ -507,24 +507,24 @@ Updates an existing room type reservation for an event, such as its assigned roo
|
|
|
507
507
|
|
|
508
508
|
```typescript
|
|
509
509
|
import {
|
|
510
|
-
|
|
510
|
+
EventsRegistrationsReservationsApi,
|
|
511
511
|
Configuration,
|
|
512
512
|
EventRoomTypeReservationUpdateInputs
|
|
513
513
|
} from '@connectedxm/admin-sdk';
|
|
514
514
|
|
|
515
515
|
const configuration = new Configuration();
|
|
516
|
-
const apiInstance = new
|
|
516
|
+
const apiInstance = new EventsRegistrationsReservationsApi(configuration);
|
|
517
517
|
|
|
518
518
|
let eventId: string; //The event identifier (default to undefined)
|
|
519
519
|
let reservationId: string; //The reservation identifier (default to undefined)
|
|
520
520
|
let eventRoomTypeReservationUpdateInputs: EventRoomTypeReservationUpdateInputs; //
|
|
521
|
-
let
|
|
521
|
+
let registrationId: string; //Filter by registrationId (optional) (default to undefined)
|
|
522
522
|
|
|
523
523
|
const { status, data } = await apiInstance.updateEventReservation(
|
|
524
524
|
eventId,
|
|
525
525
|
reservationId,
|
|
526
526
|
eventRoomTypeReservationUpdateInputs,
|
|
527
|
-
|
|
527
|
+
registrationId
|
|
528
528
|
);
|
|
529
529
|
```
|
|
530
530
|
|
|
@@ -535,7 +535,7 @@ const { status, data } = await apiInstance.updateEventReservation(
|
|
|
535
535
|
| **eventRoomTypeReservationUpdateInputs** | **EventRoomTypeReservationUpdateInputs**| | |
|
|
536
536
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
537
537
|
| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
|
|
538
|
-
| **
|
|
538
|
+
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|
|
|
539
539
|
|
|
540
540
|
|
|
541
541
|
### Return type
|
|
@@ -307,7 +307,7 @@ const { status, data } = await apiInstance.getEventRoomTypePasses(
|
|
|
307
307
|
[[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)
|
|
308
308
|
|
|
309
309
|
# **getEventRoomTypeReservations**
|
|
310
|
-
>
|
|
310
|
+
> GetEventRegistrationReservations200Response getEventRoomTypeReservations()
|
|
311
311
|
|
|
312
312
|
Returns a paginated list of room reservations made for the specified event room type, searchable by pass name or attendee name/email; requires read permission on events and attendees.
|
|
313
313
|
|
|
@@ -353,7 +353,7 @@ const { status, data } = await apiInstance.getEventRoomTypeReservations(
|
|
|
353
353
|
|
|
354
354
|
### Return type
|
|
355
355
|
|
|
356
|
-
**
|
|
356
|
+
**GetEventRegistrationReservations200Response**
|
|
357
357
|
|
|
358
358
|
### Authorization
|
|
359
359
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**status** | **string** | | [default to undefined]
|
|
9
9
|
**message** | **string** | | [default to undefined]
|
|
10
|
-
**data** | [**Array<
|
|
10
|
+
**data** | [**Array<EventRegistration>**](EventRegistration.md) | | [default to undefined]
|
|
11
11
|
**count** | **number** | | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# GetEventCoupons200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { GetEventCoupons200Response } from '@connectedxm/admin-sdk';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: GetEventCoupons200Response = {
|
|
19
19
|
status,
|
|
20
20
|
message,
|
|
21
21
|
data,
|