@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
|
@@ -1,45 +1,45 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventsRegistrationsApi
|
|
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
|
-
|[**
|
|
12
|
-
|[**
|
|
13
|
-
|[**
|
|
14
|
-
|[**
|
|
15
|
-
|[**
|
|
16
|
-
|[**resendRegistrationConfirmationEmail**](#resendregistrationconfirmationemail) | **POST** /events/{eventId}/
|
|
17
|
-
|[**
|
|
18
|
-
|[**
|
|
19
|
-
|
|
20
|
-
# **
|
|
21
|
-
>
|
|
22
|
-
|
|
23
|
-
Creates a new registration
|
|
7
|
+
|[**createEventRegistration**](#createeventregistration) | **POST** /events/{eventId}/registrations | Create an event registration|
|
|
8
|
+
|[**deleteEventRegistration**](#deleteeventregistration) | **DELETE** /events/{eventId}/registrations/{registrationId} | Delete an event registration|
|
|
9
|
+
|[**getEventPassRegistrationPasses**](#geteventpassregistrationpasses) | **GET** /events/{eventId}/passes/{passId}/attendee/passes | List every pass on the registration that owns a given pass|
|
|
10
|
+
|[**getEventRegistration**](#geteventregistration) | **GET** /events/{eventId}/registrations/{registrationId} | Get an event registration|
|
|
11
|
+
|[**getEventRegistrationCoupons**](#geteventregistrationcoupons) | **GET** /events/{eventId}/registrations/{registrationId}/coupons | List an event registration\'s coupons|
|
|
12
|
+
|[**getEventRegistrationPasses**](#geteventregistrationpasses) | **GET** /events/{eventId}/registrations/{registrationId}/passes | List an event registration\'s pass purchases|
|
|
13
|
+
|[**getEventRegistrationPayments**](#geteventregistrationpayments) | **GET** /events/{eventId}/registrations/{registrationId}/payments | List an event registration\'s payments|
|
|
14
|
+
|[**getEventRegistrationTransfersLogs**](#geteventregistrationtransferslogs) | **GET** /events/{eventId}/registrations/{registrationId}/transfers/logs | List a registration\'s pass transfer logs|
|
|
15
|
+
|[**getEventRegistrations**](#geteventregistrations) | **GET** /events/{eventId}/registrations | List an event\'s registrations|
|
|
16
|
+
|[**resendRegistrationConfirmationEmail**](#resendregistrationconfirmationemail) | **POST** /events/{eventId}/registrations/{registrationId}/resendEmail | Resend registration confirmation email|
|
|
17
|
+
|[**syncEventRegistrations**](#synceventregistrations) | **POST** /events/{eventId}/registrations/sync | Sync an event\'s registrations to accounts|
|
|
18
|
+
|[**updateEventRegistration**](#updateeventregistration) | **PUT** /events/{eventId}/registrations/{registrationId} | Update an event registration|
|
|
19
|
+
|
|
20
|
+
# **createEventRegistration**
|
|
21
|
+
> CreateEventRegistration200Response createEventRegistration(eventRegistrationCreateInputs)
|
|
22
|
+
|
|
23
|
+
Creates a new registration on an event, optionally linked to an existing account; requires read and create permission on attendees.
|
|
24
24
|
|
|
25
25
|
### Example
|
|
26
26
|
|
|
27
27
|
```typescript
|
|
28
28
|
import {
|
|
29
|
-
|
|
29
|
+
EventsRegistrationsApi,
|
|
30
30
|
Configuration,
|
|
31
|
-
|
|
31
|
+
EventRegistrationCreateInputs
|
|
32
32
|
} from '@connectedxm/admin-sdk';
|
|
33
33
|
|
|
34
34
|
const configuration = new Configuration();
|
|
35
|
-
const apiInstance = new
|
|
35
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
36
36
|
|
|
37
37
|
let eventId: string; //The event identifier (default to undefined)
|
|
38
|
-
let
|
|
38
|
+
let eventRegistrationCreateInputs: EventRegistrationCreateInputs; //
|
|
39
39
|
|
|
40
|
-
const { status, data } = await apiInstance.
|
|
40
|
+
const { status, data } = await apiInstance.createEventRegistration(
|
|
41
41
|
eventId,
|
|
42
|
-
|
|
42
|
+
eventRegistrationCreateInputs
|
|
43
43
|
);
|
|
44
44
|
```
|
|
45
45
|
|
|
@@ -47,13 +47,13 @@ const { status, data } = await apiInstance.createEventAttendee(
|
|
|
47
47
|
|
|
48
48
|
|Name | Type | Description | Notes|
|
|
49
49
|
|------------- | ------------- | ------------- | -------------|
|
|
50
|
-
| **
|
|
50
|
+
| **eventRegistrationCreateInputs** | **EventRegistrationCreateInputs**| | |
|
|
51
51
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
### Return type
|
|
55
55
|
|
|
56
|
-
**
|
|
56
|
+
**CreateEventRegistration200Response**
|
|
57
57
|
|
|
58
58
|
### Authorization
|
|
59
59
|
|
|
@@ -72,28 +72,28 @@ const { status, data } = await apiInstance.createEventAttendee(
|
|
|
72
72
|
|
|
73
73
|
[[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)
|
|
74
74
|
|
|
75
|
-
# **
|
|
76
|
-
>
|
|
75
|
+
# **deleteEventRegistration**
|
|
76
|
+
> CreateEventRegistration200Response deleteEventRegistration()
|
|
77
77
|
|
|
78
|
-
Permanently deletes the registration record
|
|
78
|
+
Permanently deletes the registration record identified by its registration ID on the given event, removing it from the registration list; requires the \"del\" permission on attendees.
|
|
79
79
|
|
|
80
80
|
### Example
|
|
81
81
|
|
|
82
82
|
```typescript
|
|
83
83
|
import {
|
|
84
|
-
|
|
84
|
+
EventsRegistrationsApi,
|
|
85
85
|
Configuration
|
|
86
86
|
} from '@connectedxm/admin-sdk';
|
|
87
87
|
|
|
88
88
|
const configuration = new Configuration();
|
|
89
|
-
const apiInstance = new
|
|
89
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
90
90
|
|
|
91
91
|
let eventId: string; //The event identifier (default to undefined)
|
|
92
|
-
let
|
|
92
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
93
93
|
|
|
94
|
-
const { status, data } = await apiInstance.
|
|
94
|
+
const { status, data } = await apiInstance.deleteEventRegistration(
|
|
95
95
|
eventId,
|
|
96
|
-
|
|
96
|
+
registrationId
|
|
97
97
|
);
|
|
98
98
|
```
|
|
99
99
|
|
|
@@ -102,12 +102,12 @@ const { status, data } = await apiInstance.deleteEventAttendee(
|
|
|
102
102
|
|Name | Type | Description | Notes|
|
|
103
103
|
|------------- | ------------- | ------------- | -------------|
|
|
104
104
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
105
|
-
| **
|
|
105
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
### Return type
|
|
109
109
|
|
|
110
|
-
**
|
|
110
|
+
**CreateEventRegistration200Response**
|
|
111
111
|
|
|
112
112
|
### Authorization
|
|
113
113
|
|
|
@@ -126,28 +126,38 @@ const { status, data } = await apiInstance.deleteEventAttendee(
|
|
|
126
126
|
|
|
127
127
|
[[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)
|
|
128
128
|
|
|
129
|
-
# **
|
|
130
|
-
>
|
|
129
|
+
# **getEventPassRegistrationPasses**
|
|
130
|
+
> GetEventAddOnPasses200Response getEventPassRegistrationPasses()
|
|
131
131
|
|
|
132
|
-
|
|
132
|
+
Resolves the registration that owns the given pass, then returns a paginated list of every pass on that registration — including the one identified by passId — optionally filtered by purchase status and search term; requires \"read\" permission on events and attendees.
|
|
133
133
|
|
|
134
134
|
### Example
|
|
135
135
|
|
|
136
136
|
```typescript
|
|
137
137
|
import {
|
|
138
|
-
|
|
138
|
+
EventsRegistrationsApi,
|
|
139
139
|
Configuration
|
|
140
140
|
} from '@connectedxm/admin-sdk';
|
|
141
141
|
|
|
142
142
|
const configuration = new Configuration();
|
|
143
|
-
const apiInstance = new
|
|
143
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
144
144
|
|
|
145
145
|
let eventId: string; //The event identifier (default to undefined)
|
|
146
|
-
let
|
|
146
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
147
|
+
let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
|
|
148
|
+
let page: number; //Page number (optional) (default to 1)
|
|
149
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
150
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
151
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
147
152
|
|
|
148
|
-
const { status, data } = await apiInstance.
|
|
153
|
+
const { status, data } = await apiInstance.getEventPassRegistrationPasses(
|
|
149
154
|
eventId,
|
|
150
|
-
|
|
155
|
+
passId,
|
|
156
|
+
status,
|
|
157
|
+
page,
|
|
158
|
+
pageSize,
|
|
159
|
+
orderBy,
|
|
160
|
+
search
|
|
151
161
|
);
|
|
152
162
|
```
|
|
153
163
|
|
|
@@ -156,12 +166,17 @@ const { status, data } = await apiInstance.getEventAttendee(
|
|
|
156
166
|
|Name | Type | Description | Notes|
|
|
157
167
|
|------------- | ------------- | ------------- | -------------|
|
|
158
168
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
159
|
-
| **
|
|
169
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
170
|
+
| **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
|
|
171
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
172
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
173
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
174
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
160
175
|
|
|
161
176
|
|
|
162
177
|
### Return type
|
|
163
178
|
|
|
164
|
-
**
|
|
179
|
+
**GetEventAddOnPasses200Response**
|
|
165
180
|
|
|
166
181
|
### Authorization
|
|
167
182
|
|
|
@@ -180,38 +195,28 @@ const { status, data } = await apiInstance.getEventAttendee(
|
|
|
180
195
|
|
|
181
196
|
[[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)
|
|
182
197
|
|
|
183
|
-
# **
|
|
184
|
-
>
|
|
198
|
+
# **getEventRegistration**
|
|
199
|
+
> CreateEventRegistration200Response getEventRegistration()
|
|
185
200
|
|
|
186
|
-
Returns
|
|
201
|
+
Returns the details for a single registration on the given event, identified by its registration ID, including its pass/purchase history; requires \"read\" permission on events and attendees.
|
|
187
202
|
|
|
188
203
|
### Example
|
|
189
204
|
|
|
190
205
|
```typescript
|
|
191
206
|
import {
|
|
192
|
-
|
|
207
|
+
EventsRegistrationsApi,
|
|
193
208
|
Configuration
|
|
194
209
|
} from '@connectedxm/admin-sdk';
|
|
195
210
|
|
|
196
211
|
const configuration = new Configuration();
|
|
197
|
-
const apiInstance = new
|
|
212
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
198
213
|
|
|
199
214
|
let eventId: string; //The event identifier (default to undefined)
|
|
200
|
-
let
|
|
201
|
-
let prePaid: boolean; //Filter by prePaid (optional) (default to undefined)
|
|
202
|
-
let page: number; //Page number (optional) (default to 1)
|
|
203
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
204
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
205
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
215
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
206
216
|
|
|
207
|
-
const { status, data } = await apiInstance.
|
|
217
|
+
const { status, data } = await apiInstance.getEventRegistration(
|
|
208
218
|
eventId,
|
|
209
|
-
|
|
210
|
-
prePaid,
|
|
211
|
-
page,
|
|
212
|
-
pageSize,
|
|
213
|
-
orderBy,
|
|
214
|
-
search
|
|
219
|
+
registrationId
|
|
215
220
|
);
|
|
216
221
|
```
|
|
217
222
|
|
|
@@ -220,17 +225,12 @@ const { status, data } = await apiInstance.getEventAttendeeCoupons(
|
|
|
220
225
|
|Name | Type | Description | Notes|
|
|
221
226
|
|------------- | ------------- | ------------- | -------------|
|
|
222
227
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
223
|
-
| **
|
|
224
|
-
| **prePaid** | [**boolean**] | Filter by prePaid | (optional) defaults to undefined|
|
|
225
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
226
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
227
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
228
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
228
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
229
229
|
|
|
230
230
|
|
|
231
231
|
### Return type
|
|
232
232
|
|
|
233
|
-
**
|
|
233
|
+
**CreateEventRegistration200Response**
|
|
234
234
|
|
|
235
235
|
### Authorization
|
|
236
236
|
|
|
@@ -249,34 +249,34 @@ const { status, data } = await apiInstance.getEventAttendeeCoupons(
|
|
|
249
249
|
|
|
250
250
|
[[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)
|
|
251
251
|
|
|
252
|
-
# **
|
|
253
|
-
>
|
|
252
|
+
# **getEventRegistrationCoupons**
|
|
253
|
+
> GetEventCoupons200Response getEventRegistrationCoupons()
|
|
254
254
|
|
|
255
|
-
Returns a paginated list of
|
|
255
|
+
Returns a paginated list of coupons associated with a specific registration on an event, identified by its registration ID, optionally filtered by paid/prePaid status, search term, and sort order; requires \"read\" permission on events and attendees.
|
|
256
256
|
|
|
257
257
|
### Example
|
|
258
258
|
|
|
259
259
|
```typescript
|
|
260
260
|
import {
|
|
261
|
-
|
|
261
|
+
EventsRegistrationsApi,
|
|
262
262
|
Configuration
|
|
263
263
|
} from '@connectedxm/admin-sdk';
|
|
264
264
|
|
|
265
265
|
const configuration = new Configuration();
|
|
266
|
-
const apiInstance = new
|
|
266
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
267
267
|
|
|
268
268
|
let eventId: string; //The event identifier (default to undefined)
|
|
269
|
-
let
|
|
270
|
-
let
|
|
269
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
270
|
+
let prePaid: boolean; //Filter by prePaid (optional) (default to undefined)
|
|
271
271
|
let page: number; //Page number (optional) (default to 1)
|
|
272
272
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
273
273
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
274
274
|
let search: string; //Search query (optional) (default to undefined)
|
|
275
275
|
|
|
276
|
-
const { status, data } = await apiInstance.
|
|
276
|
+
const { status, data } = await apiInstance.getEventRegistrationCoupons(
|
|
277
277
|
eventId,
|
|
278
|
-
|
|
279
|
-
|
|
278
|
+
registrationId,
|
|
279
|
+
prePaid,
|
|
280
280
|
page,
|
|
281
281
|
pageSize,
|
|
282
282
|
orderBy,
|
|
@@ -289,8 +289,8 @@ const { status, data } = await apiInstance.getEventAttendeePasses(
|
|
|
289
289
|
|Name | Type | Description | Notes|
|
|
290
290
|
|------------- | ------------- | ------------- | -------------|
|
|
291
291
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
292
|
-
| **
|
|
293
|
-
| **
|
|
292
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
293
|
+
| **prePaid** | [**boolean**] | Filter by prePaid | (optional) defaults to undefined|
|
|
294
294
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
295
295
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
296
296
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
@@ -299,7 +299,7 @@ const { status, data } = await apiInstance.getEventAttendeePasses(
|
|
|
299
299
|
|
|
300
300
|
### Return type
|
|
301
301
|
|
|
302
|
-
**
|
|
302
|
+
**GetEventCoupons200Response**
|
|
303
303
|
|
|
304
304
|
### Authorization
|
|
305
305
|
|
|
@@ -318,32 +318,34 @@ const { status, data } = await apiInstance.getEventAttendeePasses(
|
|
|
318
318
|
|
|
319
319
|
[[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)
|
|
320
320
|
|
|
321
|
-
# **
|
|
322
|
-
>
|
|
321
|
+
# **getEventRegistrationPasses**
|
|
322
|
+
> GetEventAddOnPasses200Response getEventRegistrationPasses()
|
|
323
323
|
|
|
324
|
-
Returns a paginated list of
|
|
324
|
+
Returns a paginated list of pass purchases belonging to a specific registration on an event, identified by its registration ID, optionally filtered by purchase status, search term, and sort order; requires \"read\" permission on events and attendees.
|
|
325
325
|
|
|
326
326
|
### Example
|
|
327
327
|
|
|
328
328
|
```typescript
|
|
329
329
|
import {
|
|
330
|
-
|
|
330
|
+
EventsRegistrationsApi,
|
|
331
331
|
Configuration
|
|
332
332
|
} from '@connectedxm/admin-sdk';
|
|
333
333
|
|
|
334
334
|
const configuration = new Configuration();
|
|
335
|
-
const apiInstance = new
|
|
335
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
336
336
|
|
|
337
337
|
let eventId: string; //The event identifier (default to undefined)
|
|
338
|
-
let
|
|
338
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
339
|
+
let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
|
|
339
340
|
let page: number; //Page number (optional) (default to 1)
|
|
340
341
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
341
342
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
342
343
|
let search: string; //Search query (optional) (default to undefined)
|
|
343
344
|
|
|
344
|
-
const { status, data } = await apiInstance.
|
|
345
|
+
const { status, data } = await apiInstance.getEventRegistrationPasses(
|
|
345
346
|
eventId,
|
|
346
|
-
|
|
347
|
+
registrationId,
|
|
348
|
+
status,
|
|
347
349
|
page,
|
|
348
350
|
pageSize,
|
|
349
351
|
orderBy,
|
|
@@ -356,7 +358,8 @@ const { status, data } = await apiInstance.getEventAttendeePayments(
|
|
|
356
358
|
|Name | Type | Description | Notes|
|
|
357
359
|
|------------- | ------------- | ------------- | -------------|
|
|
358
360
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
359
|
-
| **
|
|
361
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
362
|
+
| **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
|
|
360
363
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
361
364
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
362
365
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
@@ -365,7 +368,7 @@ const { status, data } = await apiInstance.getEventAttendeePayments(
|
|
|
365
368
|
|
|
366
369
|
### Return type
|
|
367
370
|
|
|
368
|
-
**
|
|
371
|
+
**GetEventAddOnPasses200Response**
|
|
369
372
|
|
|
370
373
|
### Authorization
|
|
371
374
|
|
|
@@ -384,32 +387,32 @@ const { status, data } = await apiInstance.getEventAttendeePayments(
|
|
|
384
387
|
|
|
385
388
|
[[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)
|
|
386
389
|
|
|
387
|
-
# **
|
|
388
|
-
>
|
|
390
|
+
# **getEventRegistrationPayments**
|
|
391
|
+
> GetAccountPayments200Response getEventRegistrationPayments()
|
|
389
392
|
|
|
390
|
-
Returns a paginated
|
|
393
|
+
Returns a paginated list of payments made against a specific event registration, identified by its registration ID, with optional search and sort order; requires \"read\" permission on events, attendees, and payments.
|
|
391
394
|
|
|
392
395
|
### Example
|
|
393
396
|
|
|
394
397
|
```typescript
|
|
395
398
|
import {
|
|
396
|
-
|
|
399
|
+
EventsRegistrationsApi,
|
|
397
400
|
Configuration
|
|
398
401
|
} from '@connectedxm/admin-sdk';
|
|
399
402
|
|
|
400
403
|
const configuration = new Configuration();
|
|
401
|
-
const apiInstance = new
|
|
404
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
402
405
|
|
|
403
406
|
let eventId: string; //The event identifier (default to undefined)
|
|
404
|
-
let
|
|
407
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
405
408
|
let page: number; //Page number (optional) (default to 1)
|
|
406
409
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
407
410
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
408
411
|
let search: string; //Search query (optional) (default to undefined)
|
|
409
412
|
|
|
410
|
-
const { status, data } = await apiInstance.
|
|
413
|
+
const { status, data } = await apiInstance.getEventRegistrationPayments(
|
|
411
414
|
eventId,
|
|
412
|
-
|
|
415
|
+
registrationId,
|
|
413
416
|
page,
|
|
414
417
|
pageSize,
|
|
415
418
|
orderBy,
|
|
@@ -422,7 +425,7 @@ const { status, data } = await apiInstance.getEventAttendeeTransfersLogs(
|
|
|
422
425
|
|Name | Type | Description | Notes|
|
|
423
426
|
|------------- | ------------- | ------------- | -------------|
|
|
424
427
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
425
|
-
| **
|
|
428
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
426
429
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
427
430
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
428
431
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
@@ -431,7 +434,7 @@ const { status, data } = await apiInstance.getEventAttendeeTransfersLogs(
|
|
|
431
434
|
|
|
432
435
|
### Return type
|
|
433
436
|
|
|
434
|
-
**
|
|
437
|
+
**GetAccountPayments200Response**
|
|
435
438
|
|
|
436
439
|
### Authorization
|
|
437
440
|
|
|
@@ -450,32 +453,32 @@ const { status, data } = await apiInstance.getEventAttendeeTransfersLogs(
|
|
|
450
453
|
|
|
451
454
|
[[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)
|
|
452
455
|
|
|
453
|
-
# **
|
|
454
|
-
>
|
|
456
|
+
# **getEventRegistrationTransfersLogs**
|
|
457
|
+
> GetEventPassTransferLogs200Response getEventRegistrationTransfersLogs()
|
|
455
458
|
|
|
456
|
-
Returns a paginated
|
|
459
|
+
Returns a paginated log of pass transfer activity (e.g. ownership changes) for a specific registration on an event, identified by its registration ID, with optional search and sort order; requires \"read\" permission on events and attendees.
|
|
457
460
|
|
|
458
461
|
### Example
|
|
459
462
|
|
|
460
463
|
```typescript
|
|
461
464
|
import {
|
|
462
|
-
|
|
465
|
+
EventsRegistrationsApi,
|
|
463
466
|
Configuration
|
|
464
467
|
} from '@connectedxm/admin-sdk';
|
|
465
468
|
|
|
466
469
|
const configuration = new Configuration();
|
|
467
|
-
const apiInstance = new
|
|
470
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
468
471
|
|
|
469
472
|
let eventId: string; //The event identifier (default to undefined)
|
|
470
|
-
let
|
|
473
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
471
474
|
let page: number; //Page number (optional) (default to 1)
|
|
472
475
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
473
476
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
474
477
|
let search: string; //Search query (optional) (default to undefined)
|
|
475
478
|
|
|
476
|
-
const { status, data } = await apiInstance.
|
|
479
|
+
const { status, data } = await apiInstance.getEventRegistrationTransfersLogs(
|
|
477
480
|
eventId,
|
|
478
|
-
|
|
481
|
+
registrationId,
|
|
479
482
|
page,
|
|
480
483
|
pageSize,
|
|
481
484
|
orderBy,
|
|
@@ -488,7 +491,7 @@ const { status, data } = await apiInstance.getEventAttendees(
|
|
|
488
491
|
|Name | Type | Description | Notes|
|
|
489
492
|
|------------- | ------------- | ------------- | -------------|
|
|
490
493
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
491
|
-
| **
|
|
494
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
492
495
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
493
496
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
494
497
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
@@ -497,7 +500,7 @@ const { status, data } = await apiInstance.getEventAttendees(
|
|
|
497
500
|
|
|
498
501
|
### Return type
|
|
499
502
|
|
|
500
|
-
**
|
|
503
|
+
**GetEventPassTransferLogs200Response**
|
|
501
504
|
|
|
502
505
|
### Authorization
|
|
503
506
|
|
|
@@ -516,33 +519,31 @@ const { status, data } = await apiInstance.getEventAttendees(
|
|
|
516
519
|
|
|
517
520
|
[[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)
|
|
518
521
|
|
|
519
|
-
# **
|
|
520
|
-
>
|
|
522
|
+
# **getEventRegistrations**
|
|
523
|
+
> GetAccountRegistrations200Response getEventRegistrations()
|
|
521
524
|
|
|
522
|
-
Returns a paginated list of
|
|
525
|
+
Returns a paginated list of registrations for the given event, optionally filtered by purchase status and search term; requires \"read\" permission on events and attendees.
|
|
523
526
|
|
|
524
527
|
### Example
|
|
525
528
|
|
|
526
529
|
```typescript
|
|
527
530
|
import {
|
|
528
|
-
|
|
531
|
+
EventsRegistrationsApi,
|
|
529
532
|
Configuration
|
|
530
533
|
} from '@connectedxm/admin-sdk';
|
|
531
534
|
|
|
532
535
|
const configuration = new Configuration();
|
|
533
|
-
const apiInstance = new
|
|
536
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
534
537
|
|
|
535
538
|
let eventId: string; //The event identifier (default to undefined)
|
|
536
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
537
539
|
let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
|
|
538
540
|
let page: number; //Page number (optional) (default to 1)
|
|
539
541
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
540
542
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
541
543
|
let search: string; //Search query (optional) (default to undefined)
|
|
542
544
|
|
|
543
|
-
const { status, data } = await apiInstance.
|
|
545
|
+
const { status, data } = await apiInstance.getEventRegistrations(
|
|
544
546
|
eventId,
|
|
545
|
-
passId,
|
|
546
547
|
status,
|
|
547
548
|
page,
|
|
548
549
|
pageSize,
|
|
@@ -556,7 +557,6 @@ const { status, data } = await apiInstance.getEventPassAttendeePasses(
|
|
|
556
557
|
|Name | Type | Description | Notes|
|
|
557
558
|
|------------- | ------------- | ------------- | -------------|
|
|
558
559
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
559
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
560
560
|
| **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
|
|
561
561
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
562
562
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
@@ -566,7 +566,7 @@ const { status, data } = await apiInstance.getEventPassAttendeePasses(
|
|
|
566
566
|
|
|
567
567
|
### Return type
|
|
568
568
|
|
|
569
|
-
**
|
|
569
|
+
**GetAccountRegistrations200Response**
|
|
570
570
|
|
|
571
571
|
### Authorization
|
|
572
572
|
|
|
@@ -588,25 +588,25 @@ const { status, data } = await apiInstance.getEventPassAttendeePasses(
|
|
|
588
588
|
# **resendRegistrationConfirmationEmail**
|
|
589
589
|
> CreateAccountInvitations200Response resendRegistrationConfirmationEmail()
|
|
590
590
|
|
|
591
|
-
Re-triggers the registration confirmation email for the
|
|
591
|
+
Re-triggers the registration confirmation email for the registration identified by its registration ID on the given event by replaying the \"registration.submitted\" side effect; requires the \"update\" permission on attendees.
|
|
592
592
|
|
|
593
593
|
### Example
|
|
594
594
|
|
|
595
595
|
```typescript
|
|
596
596
|
import {
|
|
597
|
-
|
|
597
|
+
EventsRegistrationsApi,
|
|
598
598
|
Configuration
|
|
599
599
|
} from '@connectedxm/admin-sdk';
|
|
600
600
|
|
|
601
601
|
const configuration = new Configuration();
|
|
602
|
-
const apiInstance = new
|
|
602
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
603
603
|
|
|
604
604
|
let eventId: string; //The event identifier (default to undefined)
|
|
605
|
-
let
|
|
605
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
606
606
|
|
|
607
607
|
const { status, data } = await apiInstance.resendRegistrationConfirmationEmail(
|
|
608
608
|
eventId,
|
|
609
|
-
|
|
609
|
+
registrationId
|
|
610
610
|
);
|
|
611
611
|
```
|
|
612
612
|
|
|
@@ -615,7 +615,7 @@ const { status, data } = await apiInstance.resendRegistrationConfirmationEmail(
|
|
|
615
615
|
|Name | Type | Description | Notes|
|
|
616
616
|
|------------- | ------------- | ------------- | -------------|
|
|
617
617
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
618
|
-
| **
|
|
618
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
619
619
|
|
|
620
620
|
|
|
621
621
|
### Return type
|
|
@@ -639,25 +639,25 @@ const { status, data } = await apiInstance.resendRegistrationConfirmationEmail(
|
|
|
639
639
|
|
|
640
640
|
[[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)
|
|
641
641
|
|
|
642
|
-
# **
|
|
643
|
-
> SyncAccounts200Response
|
|
642
|
+
# **syncEventRegistrations**
|
|
643
|
+
> SyncAccounts200Response syncEventRegistrations()
|
|
644
644
|
|
|
645
|
-
Enqueues every
|
|
645
|
+
Enqueues every account registered for the given event for a background account-data sync job and returns the number of accounts enqueued; requires the \"read\" permission on attendees and \"update\" permission on accounts.
|
|
646
646
|
|
|
647
647
|
### Example
|
|
648
648
|
|
|
649
649
|
```typescript
|
|
650
650
|
import {
|
|
651
|
-
|
|
651
|
+
EventsRegistrationsApi,
|
|
652
652
|
Configuration
|
|
653
653
|
} from '@connectedxm/admin-sdk';
|
|
654
654
|
|
|
655
655
|
const configuration = new Configuration();
|
|
656
|
-
const apiInstance = new
|
|
656
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
657
657
|
|
|
658
658
|
let eventId: string; //The event identifier (default to undefined)
|
|
659
659
|
|
|
660
|
-
const { status, data } = await apiInstance.
|
|
660
|
+
const { status, data } = await apiInstance.syncEventRegistrations(
|
|
661
661
|
eventId
|
|
662
662
|
);
|
|
663
663
|
```
|
|
@@ -690,29 +690,29 @@ const { status, data } = await apiInstance.syncEventAttendees(
|
|
|
690
690
|
|
|
691
691
|
[[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)
|
|
692
692
|
|
|
693
|
-
# **
|
|
694
|
-
>
|
|
693
|
+
# **updateEventRegistration**
|
|
694
|
+
> CreateEventRegistration200Response updateEventRegistration(body)
|
|
695
695
|
|
|
696
|
-
Updates the registration record
|
|
696
|
+
Updates the registration record identified by its registration ID on the given event with the supplied fields, such as coupon or custom registration data; requires the \"update\" permission on attendees.
|
|
697
697
|
|
|
698
698
|
### Example
|
|
699
699
|
|
|
700
700
|
```typescript
|
|
701
701
|
import {
|
|
702
|
-
|
|
702
|
+
EventsRegistrationsApi,
|
|
703
703
|
Configuration
|
|
704
704
|
} from '@connectedxm/admin-sdk';
|
|
705
705
|
|
|
706
706
|
const configuration = new Configuration();
|
|
707
|
-
const apiInstance = new
|
|
707
|
+
const apiInstance = new EventsRegistrationsApi(configuration);
|
|
708
708
|
|
|
709
709
|
let eventId: string; //The event identifier (default to undefined)
|
|
710
|
-
let
|
|
710
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
711
711
|
let body: object; //
|
|
712
712
|
|
|
713
|
-
const { status, data } = await apiInstance.
|
|
713
|
+
const { status, data } = await apiInstance.updateEventRegistration(
|
|
714
714
|
eventId,
|
|
715
|
-
|
|
715
|
+
registrationId,
|
|
716
716
|
body
|
|
717
717
|
);
|
|
718
718
|
```
|
|
@@ -723,12 +723,12 @@ const { status, data } = await apiInstance.updateEventAttendee(
|
|
|
723
723
|
|------------- | ------------- | ------------- | -------------|
|
|
724
724
|
| **body** | **object**| | |
|
|
725
725
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
726
|
-
| **
|
|
726
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
727
727
|
|
|
728
728
|
|
|
729
729
|
### Return type
|
|
730
730
|
|
|
731
|
-
**
|
|
731
|
+
**CreateEventRegistration200Response**
|
|
732
732
|
|
|
733
733
|
### Authorization
|
|
734
734
|
|