@connectedxm/admin-sdk 7.13.1 → 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 +49 -49
- package/api.ts +17304 -17304
- package/dist/AdminApi.d.ts +4 -4
- package/dist/AdminApi.js +3 -3
- package/dist/api.d.ts +9777 -9777
- package/dist/api.js +13575 -13575
- package/dist/esm/AdminApi.d.ts +4 -4
- package/dist/esm/AdminApi.js +4 -4
- package/dist/esm/api.d.ts +9777 -9777
- package/dist/esm/api.js +13602 -13602
- 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/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/TransferLog.md +2 -2
- package/package.json +1 -1
package/docs/BaseEventPass.md
CHANGED
|
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**couponId** | **string** | | [default to undefined]
|
|
24
24
|
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
25
25
|
**packageId** | **string** | | [default to undefined]
|
|
26
|
-
**_package** | [**
|
|
26
|
+
**_package** | [**BaseRegistrationPackage**](BaseRegistrationPackage.md) | | [default to undefined]
|
|
27
27
|
**seriesRegistrationId** | **string** | | [default to undefined]
|
|
28
28
|
**createdAt** | **string** | | [default to undefined]
|
|
29
29
|
**updatedAt** | **string** | | [default to undefined]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BaseEventRegistration
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import {
|
|
18
|
+
import { BaseEventRegistration } from '@connectedxm/admin-sdk';
|
|
19
19
|
|
|
20
|
-
const instance:
|
|
20
|
+
const instance: BaseEventRegistration = {
|
|
21
21
|
id,
|
|
22
22
|
alternateId,
|
|
23
23
|
accountId,
|
package/docs/BaseMatchPass.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**alternateId** | **number** | | [default to undefined]
|
|
10
10
|
**ticket** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
11
|
-
**attendee** | [**
|
|
11
|
+
**attendee** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
12
12
|
**responses** | [**Array<BaseRegistrationQuestionResponse>**](BaseRegistrationQuestionResponse.md) | | [optional] [default to undefined]
|
|
13
13
|
**accesses** | [**Array<BaseMatchPassAccessesInner>**](BaseMatchPassAccessesInner.md) | | [optional] [default to undefined]
|
|
14
14
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BaseRegistrationPackage
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import {
|
|
18
|
+
import { BaseRegistrationPackage } from '@connectedxm/admin-sdk';
|
|
19
19
|
|
|
20
|
-
const instance:
|
|
20
|
+
const instance: BaseRegistrationPackage = {
|
|
21
21
|
id,
|
|
22
22
|
attendeeId,
|
|
23
23
|
packageId,
|
package/docs/BaseTransferLog.md
CHANGED
|
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **number** | | [default to undefined]
|
|
9
9
|
**fromRegistrationId** | **string** | | [default to undefined]
|
|
10
|
-
**fromRegistration** | [**
|
|
10
|
+
**fromRegistration** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
11
11
|
**toRegistrationId** | **string** | | [default to undefined]
|
|
12
|
-
**toRegistration** | [**
|
|
12
|
+
**toRegistration** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/Coupon.md
CHANGED
|
@@ -28,7 +28,7 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**applyToReservation** | **boolean** | | [default to undefined]
|
|
29
29
|
**applyToSessions** | **boolean** | | [default to undefined]
|
|
30
30
|
**registrationId** | **string** | | [default to undefined]
|
|
31
|
-
**registration** | [**
|
|
31
|
+
**registration** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
32
32
|
**allowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
33
33
|
**disallowedTiers** | [**Array<BaseTier>**](BaseTier.md) | | [default to undefined]
|
|
34
34
|
**lineItem** | [**PaymentLineItem**](PaymentLineItem.md) | | [default to undefined]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreateEventRegistration200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,14 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**status** | **string** | | [default to undefined]
|
|
9
9
|
**message** | **string** | | [default to undefined]
|
|
10
|
-
**data** | [**
|
|
10
|
+
**data** | [**EventRegistration**](EventRegistration.md) | | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { CreateEventRegistration200Response } from '@connectedxm/admin-sdk';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: CreateEventRegistration200Response = {
|
|
18
18
|
status,
|
|
19
19
|
message,
|
|
20
20
|
data,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreateEventRegistrationPackage200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,14 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**status** | **string** | | [default to undefined]
|
|
9
9
|
**message** | **string** | | [default to undefined]
|
|
10
|
-
**data** | [**
|
|
10
|
+
**data** | [**RegistrationPackage**](RegistrationPackage.md) | | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { CreateEventRegistrationPackage200Response } from '@connectedxm/admin-sdk';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: CreateEventRegistrationPackage200Response = {
|
|
18
18
|
status,
|
|
19
19
|
message,
|
|
20
20
|
data,
|
package/docs/EventPass.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**eventId** | **string** | | [default to undefined]
|
|
10
10
|
**attendeeId** | **string** | | [default to undefined]
|
|
11
|
-
**attendee** | [**
|
|
11
|
+
**attendee** | [**BaseEventRegistration**](BaseEventRegistration.md) | | [default to undefined]
|
|
12
12
|
**alternateId** | **number** | | [default to undefined]
|
|
13
13
|
**ticketId** | **string** | | [default to undefined]
|
|
14
14
|
**ticket** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**couponId** | **string** | | [default to undefined]
|
|
24
24
|
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
25
25
|
**packageId** | **string** | | [default to undefined]
|
|
26
|
-
**_package** | [**
|
|
26
|
+
**_package** | [**BaseRegistrationPackage**](BaseRegistrationPackage.md) | | [default to undefined]
|
|
27
27
|
**seriesRegistrationId** | **string** | | [default to undefined]
|
|
28
28
|
**createdAt** | **string** | | [default to undefined]
|
|
29
29
|
**updatedAt** | **string** | | [default to undefined]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistration
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -12,17 +12,17 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**eventId** | **string** | | [default to undefined]
|
|
13
13
|
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
14
14
|
**passes** | [**Array<BaseEventPass>**](BaseEventPass.md) | | [default to undefined]
|
|
15
|
-
**packages** | [**Array<
|
|
15
|
+
**packages** | [**Array<BaseRegistrationPackage>**](BaseRegistrationPackage.md) | | [default to undefined]
|
|
16
16
|
**createdAt** | **string** | | [default to undefined]
|
|
17
17
|
**updatedAt** | **string** | | [default to undefined]
|
|
18
|
-
**_count** | [**
|
|
18
|
+
**_count** | [**EventRegistrationAllOfCount**](EventRegistrationAllOfCount.md) | | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
22
22
|
```typescript
|
|
23
|
-
import {
|
|
23
|
+
import { EventRegistration } from '@connectedxm/admin-sdk';
|
|
24
24
|
|
|
25
|
-
const instance:
|
|
25
|
+
const instance: EventRegistration = {
|
|
26
26
|
id,
|
|
27
27
|
alternateId,
|
|
28
28
|
accountId,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistrationAllOfCount
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { EventRegistrationAllOfCount } from '@connectedxm/admin-sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: EventRegistrationAllOfCount = {
|
|
17
17
|
payments,
|
|
18
18
|
coupons,
|
|
19
19
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistrationCreateInputs
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { EventRegistrationCreateInputs } from '@connectedxm/admin-sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: EventRegistrationCreateInputs = {
|
|
16
16
|
accountId,
|
|
17
17
|
};
|
|
18
18
|
```
|
package/docs/{EventAttendeePackageCreateInputs.md → EventRegistrationPackageCreateInputs.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistrationPackageCreateInputs
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { EventRegistrationPackageCreateInputs } from '@connectedxm/admin-sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: EventRegistrationPackageCreateInputs = {
|
|
17
17
|
packageId,
|
|
18
18
|
status,
|
|
19
19
|
};
|
package/docs/{EventAttendeePackageUpdateInputs.md → EventRegistrationPackageUpdateInputs.md}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventRegistrationPackageUpdateInputs
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { EventRegistrationPackageUpdateInputs } from '@connectedxm/admin-sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: EventRegistrationPackageUpdateInputs = {
|
|
17
17
|
packageId,
|
|
18
18
|
status,
|
|
19
19
|
};
|
package/docs/EventsCouponsApi.md
CHANGED
|
@@ -556,7 +556,7 @@ const { status, data } = await apiInstance.getEventCouponTiers(
|
|
|
556
556
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
557
557
|
|
|
558
558
|
# **getEventCouponVariants**
|
|
559
|
-
>
|
|
559
|
+
> GetEventCoupons200Response getEventCouponVariants()
|
|
560
560
|
|
|
561
561
|
Returns a paginated list of the child coupon variants belonging to the given parent coupon on the event, supporting search and `orderBy` sorting; requires \"read\" permission on events.
|
|
562
562
|
|
|
@@ -602,7 +602,7 @@ const { status, data } = await apiInstance.getEventCouponVariants(
|
|
|
602
602
|
|
|
603
603
|
### Return type
|
|
604
604
|
|
|
605
|
-
**
|
|
605
|
+
**GetEventCoupons200Response**
|
|
606
606
|
|
|
607
607
|
### Authorization
|
|
608
608
|
|
|
@@ -622,7 +622,7 @@ const { status, data } = await apiInstance.getEventCouponVariants(
|
|
|
622
622
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
623
623
|
|
|
624
624
|
# **getEventCoupons**
|
|
625
|
-
>
|
|
625
|
+
> GetEventCoupons200Response getEventCoupons()
|
|
626
626
|
|
|
627
627
|
Returns a paginated list of coupons for the given event, filterable by `prePaid` (group-paid vs. standard coupons) and by `includeVariants` to include child coupon variants, with search and `orderBy` sorting; requires \"read\" permission on events.
|
|
628
628
|
|
|
@@ -671,7 +671,7 @@ const { status, data } = await apiInstance.getEventCoupons(
|
|
|
671
671
|
|
|
672
672
|
### Return type
|
|
673
673
|
|
|
674
|
-
**
|
|
674
|
+
**GetEventCoupons200Response**
|
|
675
675
|
|
|
676
676
|
### Authorization
|
|
677
677
|
|
|
@@ -686,7 +686,7 @@ const { status, data } = await apiInstance.getEventFollowupTiers(
|
|
|
686
686
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
687
687
|
|
|
688
688
|
# **getEventFollowups**
|
|
689
|
-
>
|
|
689
|
+
> GetEventFollowups200Response getEventFollowups()
|
|
690
690
|
|
|
691
691
|
Returns a paginated list of registration followups configured for the given event, supporting search and ordering; requires read permission on events.
|
|
692
692
|
|
|
@@ -729,7 +729,7 @@ const { status, data } = await apiInstance.getEventFollowups(
|
|
|
729
729
|
|
|
730
730
|
### Return type
|
|
731
731
|
|
|
732
|
-
**
|
|
732
|
+
**GetEventFollowups200Response**
|
|
733
733
|
|
|
734
734
|
### Authorization
|
|
735
735
|
|
|
@@ -11,7 +11,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
11
11
|
|[**unfulfillEventPassAddOn**](#unfulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/undo | Undo an add-on fulfillment|
|
|
12
12
|
|
|
13
13
|
# **addEventPassAddOn**
|
|
14
|
-
>
|
|
14
|
+
> GetEventPass200Response addEventPassAddOn()
|
|
15
15
|
|
|
16
16
|
Attaches an event add-on purchase to the specified pass, requires read permission on events and read/update permission on attendees.
|
|
17
17
|
|
|
@@ -48,7 +48,7 @@ const { status, data } = await apiInstance.addEventPassAddOn(
|
|
|
48
48
|
|
|
49
49
|
### Return type
|
|
50
50
|
|
|
51
|
-
**
|
|
51
|
+
**GetEventPass200Response**
|
|
52
52
|
|
|
53
53
|
### Authorization
|
|
54
54
|
|
|
@@ -191,7 +191,7 @@ const { status, data } = await apiInstance.getEventPassAddOns(
|
|
|
191
191
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
192
192
|
|
|
193
193
|
# **removeEventPassAddOn**
|
|
194
|
-
>
|
|
194
|
+
> GetEventPass200Response removeEventPassAddOn()
|
|
195
195
|
|
|
196
196
|
Detaches a previously added event add-on purchase from the specified pass, requires read permission on events and read/update permission on attendees.
|
|
197
197
|
|
|
@@ -228,7 +228,7 @@ const { status, data } = await apiInstance.removeEventPassAddOn(
|
|
|
228
228
|
|
|
229
229
|
### Return type
|
|
230
230
|
|
|
231
|
-
**
|
|
231
|
+
**GetEventPass200Response**
|
|
232
232
|
|
|
233
233
|
### Authorization
|
|
234
234
|
|
package/docs/EventsPassesApi.md
CHANGED
|
@@ -7,7 +7,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
7
7
|
|[**approveEventPass**](#approveeventpass) | **PUT** /events/{eventId}/passes/{passId}/approve | Approve a pending event pass|
|
|
8
8
|
|[**cancelEventPass**](#canceleventpass) | **PUT** /events/{eventId}/passes/{passId}/cancel | Cancel an event pass|
|
|
9
9
|
|[**checkinEventPass**](#checkineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin | Check in an event pass|
|
|
10
|
-
|[**createEventPass**](#createeventpass) | **POST** /events/{eventId}/
|
|
10
|
+
|[**createEventPass**](#createeventpass) | **POST** /events/{eventId}/registrations/{registrationId}/passes | Create a pass for an event attendee|
|
|
11
11
|
|[**deleteEventPass**](#deleteeventpass) | **DELETE** /events/{eventId}/passes/{passId} | Delete an event pass|
|
|
12
12
|
|[**denyEventPass**](#denyeventpass) | **PUT** /events/{eventId}/passes/{passId}/deny | Deny a pending event pass|
|
|
13
13
|
|[**getEventPass**](#geteventpass) | **GET** /events/{eventId}/passes/{passId} | Get a single event pass|
|
|
@@ -17,13 +17,13 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
17
17
|
|[**getEventPasses**](#geteventpasses) | **GET** /events/{eventId}/passes | List an event\'s passes|
|
|
18
18
|
|[**getEventPendingPasses**](#geteventpendingpasses) | **GET** /events/{eventId}/passes/pending | List an event\'s pending passes|
|
|
19
19
|
|[**indexEventPasses**](#indexeventpasses) | **POST** /events/{eventId}/index-passes | Reindex an event\'s passes for search|
|
|
20
|
-
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/
|
|
20
|
+
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/registrations/{registrationId}/passes/{passId}/transfers | Transfer an event pass to another account|
|
|
21
21
|
|[**undoCheckinEventPass**](#undocheckineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin/undo | Undo an event pass check-in|
|
|
22
22
|
|[**updateEventPass**](#updateeventpass) | **PUT** /events/{eventId}/passes/{passId} | Update an event pass|
|
|
23
23
|
|[**updateEventPassesReady**](#updateeventpassesready) | **POST** /events/{eventId}/passes/ready | Mark all needs-info passes as ready|
|
|
24
24
|
|
|
25
25
|
# **approveEventPass**
|
|
26
|
-
>
|
|
26
|
+
> GetEventPass200Response approveEventPass()
|
|
27
27
|
|
|
28
28
|
Moves a pending event pass to the ready status so the attendee\'s registration is confirmed, optionally sending the approval email, requires read permission on events and read/update permission on attendees.
|
|
29
29
|
|
|
@@ -60,7 +60,7 @@ const { status, data } = await apiInstance.approveEventPass(
|
|
|
60
60
|
|
|
61
61
|
### Return type
|
|
62
62
|
|
|
63
|
-
**
|
|
63
|
+
**GetEventPass200Response**
|
|
64
64
|
|
|
65
65
|
### Authorization
|
|
66
66
|
|
|
@@ -80,7 +80,7 @@ const { status, data } = await apiInstance.approveEventPass(
|
|
|
80
80
|
[[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)
|
|
81
81
|
|
|
82
82
|
# **cancelEventPass**
|
|
83
|
-
>
|
|
83
|
+
> GetEventPass200Response cancelEventPass()
|
|
84
84
|
|
|
85
85
|
Cancels an approved or active event pass/registration, requires the update permission on attendees, blocks the cancellation if the pass has active session accesses, and optionally sends a cancellation email to the attendee.
|
|
86
86
|
|
|
@@ -117,7 +117,7 @@ const { status, data } = await apiInstance.cancelEventPass(
|
|
|
117
117
|
|
|
118
118
|
### Return type
|
|
119
119
|
|
|
120
|
-
**
|
|
120
|
+
**GetEventPass200Response**
|
|
121
121
|
|
|
122
122
|
### Authorization
|
|
123
123
|
|
|
@@ -137,7 +137,7 @@ const { status, data } = await apiInstance.cancelEventPass(
|
|
|
137
137
|
[[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)
|
|
138
138
|
|
|
139
139
|
# **checkinEventPass**
|
|
140
|
-
>
|
|
140
|
+
> GetEventPass200Response checkinEventPass()
|
|
141
141
|
|
|
142
142
|
Marks the given event pass as checked in, resolving an alternate pass ID to its underlying record first, and requires read permission on events and attendees.
|
|
143
143
|
|
|
@@ -171,7 +171,7 @@ const { status, data } = await apiInstance.checkinEventPass(
|
|
|
171
171
|
|
|
172
172
|
### Return type
|
|
173
173
|
|
|
174
|
-
**
|
|
174
|
+
**GetEventPass200Response**
|
|
175
175
|
|
|
176
176
|
### Authorization
|
|
177
177
|
|
|
@@ -191,7 +191,7 @@ const { status, data } = await apiInstance.checkinEventPass(
|
|
|
191
191
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
192
192
|
|
|
193
193
|
# **createEventPass**
|
|
194
|
-
>
|
|
194
|
+
> GetEventPass200Response createEventPass(eventPassCreateInputs)
|
|
195
195
|
|
|
196
196
|
Creates a new pass/registration purchase for the specified attendee on the given event using the provided pass details, and requires update permission on attendees.
|
|
197
197
|
|
|
@@ -208,12 +208,12 @@ const configuration = new Configuration();
|
|
|
208
208
|
const apiInstance = new EventsPassesApi(configuration);
|
|
209
209
|
|
|
210
210
|
let eventId: string; //The event identifier (default to undefined)
|
|
211
|
-
let
|
|
211
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
212
212
|
let eventPassCreateInputs: EventPassCreateInputs; //
|
|
213
213
|
|
|
214
214
|
const { status, data } = await apiInstance.createEventPass(
|
|
215
215
|
eventId,
|
|
216
|
-
|
|
216
|
+
registrationId,
|
|
217
217
|
eventPassCreateInputs
|
|
218
218
|
);
|
|
219
219
|
```
|
|
@@ -224,12 +224,12 @@ const { status, data } = await apiInstance.createEventPass(
|
|
|
224
224
|
|------------- | ------------- | ------------- | -------------|
|
|
225
225
|
| **eventPassCreateInputs** | **EventPassCreateInputs**| | |
|
|
226
226
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
227
|
-
| **
|
|
227
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
228
228
|
|
|
229
229
|
|
|
230
230
|
### Return type
|
|
231
231
|
|
|
232
|
-
**
|
|
232
|
+
**GetEventPass200Response**
|
|
233
233
|
|
|
234
234
|
### Authorization
|
|
235
235
|
|
|
@@ -266,12 +266,12 @@ const apiInstance = new EventsPassesApi(configuration);
|
|
|
266
266
|
|
|
267
267
|
let eventId: string; //The event identifier (default to undefined)
|
|
268
268
|
let passId: string; //The pass identifier (default to undefined)
|
|
269
|
-
let
|
|
269
|
+
let registrationId: string; //Filter by registrationId (optional) (default to undefined)
|
|
270
270
|
|
|
271
271
|
const { status, data } = await apiInstance.deleteEventPass(
|
|
272
272
|
eventId,
|
|
273
273
|
passId,
|
|
274
|
-
|
|
274
|
+
registrationId
|
|
275
275
|
);
|
|
276
276
|
```
|
|
277
277
|
|
|
@@ -281,7 +281,7 @@ const { status, data } = await apiInstance.deleteEventPass(
|
|
|
281
281
|
|------------- | ------------- | ------------- | -------------|
|
|
282
282
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
283
283
|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
284
|
-
| **
|
|
284
|
+
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|
|
|
285
285
|
|
|
286
286
|
|
|
287
287
|
### Return type
|
|
@@ -306,7 +306,7 @@ const { status, data } = await apiInstance.deleteEventPass(
|
|
|
306
306
|
[[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)
|
|
307
307
|
|
|
308
308
|
# **denyEventPass**
|
|
309
|
-
>
|
|
309
|
+
> GetEventPass200Response denyEventPass()
|
|
310
310
|
|
|
311
311
|
Denies a pass/registration that is in pending status by canceling it, optionally issuing a refund for its payment and sending a denial email, and requires update permission on attendees.
|
|
312
312
|
|
|
@@ -346,7 +346,7 @@ const { status, data } = await apiInstance.denyEventPass(
|
|
|
346
346
|
|
|
347
347
|
### Return type
|
|
348
348
|
|
|
349
|
-
**
|
|
349
|
+
**GetEventPass200Response**
|
|
350
350
|
|
|
351
351
|
### Authorization
|
|
352
352
|
|
|
@@ -366,7 +366,7 @@ const { status, data } = await apiInstance.denyEventPass(
|
|
|
366
366
|
[[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)
|
|
367
367
|
|
|
368
368
|
# **getEventPass**
|
|
369
|
-
>
|
|
369
|
+
> GetEventPass200Response getEventPass()
|
|
370
370
|
|
|
371
371
|
Returns a single event pass (registration purchase) by ID for the given event, including its attendee and ticket details, and requires the read events and read attendees permissions.
|
|
372
372
|
|
|
@@ -400,7 +400,7 @@ const { status, data } = await apiInstance.getEventPass(
|
|
|
400
400
|
|
|
401
401
|
### Return type
|
|
402
402
|
|
|
403
|
-
**
|
|
403
|
+
**GetEventPass200Response**
|
|
404
404
|
|
|
405
405
|
### Authorization
|
|
406
406
|
|
|
@@ -546,7 +546,7 @@ const { status, data } = await apiInstance.getEventPassPayments(
|
|
|
546
546
|
[[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)
|
|
547
547
|
|
|
548
548
|
# **getEventPassTransferLogs**
|
|
549
|
-
>
|
|
549
|
+
> GetEventPassTransferLogs200Response getEventPassTransferLogs()
|
|
550
550
|
|
|
551
551
|
Returns a paginated history of ownership transfers for a specific event pass, and requires the read events and read attendees permissions.
|
|
552
552
|
|
|
@@ -592,7 +592,7 @@ const { status, data } = await apiInstance.getEventPassTransferLogs(
|
|
|
592
592
|
|
|
593
593
|
### Return type
|
|
594
594
|
|
|
595
|
-
**
|
|
595
|
+
**GetEventPassTransferLogs200Response**
|
|
596
596
|
|
|
597
597
|
### Authorization
|
|
598
598
|
|
|
@@ -808,13 +808,13 @@ const configuration = new Configuration();
|
|
|
808
808
|
const apiInstance = new EventsPassesApi(configuration);
|
|
809
809
|
|
|
810
810
|
let eventId: string; //The event identifier (default to undefined)
|
|
811
|
-
let
|
|
811
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
812
812
|
let passId: string; //The pass identifier (default to undefined)
|
|
813
813
|
let receiverId: string; //Filter by receiverId (default to undefined)
|
|
814
814
|
|
|
815
815
|
const { status, data } = await apiInstance.transferEventPass(
|
|
816
816
|
eventId,
|
|
817
|
-
|
|
817
|
+
registrationId,
|
|
818
818
|
passId,
|
|
819
819
|
receiverId
|
|
820
820
|
);
|
|
@@ -825,7 +825,7 @@ const { status, data } = await apiInstance.transferEventPass(
|
|
|
825
825
|
|Name | Type | Description | Notes|
|
|
826
826
|
|------------- | ------------- | ------------- | -------------|
|
|
827
827
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
828
|
-
| **
|
|
828
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
829
829
|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
830
830
|
| **receiverId** | [**string**] | Filter by receiverId | defaults to undefined|
|
|
831
831
|
|
|
@@ -852,7 +852,7 @@ const { status, data } = await apiInstance.transferEventPass(
|
|
|
852
852
|
[[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)
|
|
853
853
|
|
|
854
854
|
# **undoCheckinEventPass**
|
|
855
|
-
>
|
|
855
|
+
> GetEventPass200Response undoCheckinEventPass()
|
|
856
856
|
|
|
857
857
|
Reverses a previous check-in on the given event pass, marking it as not checked in, and requires read permission on events and attendees.
|
|
858
858
|
|
|
@@ -886,7 +886,7 @@ const { status, data } = await apiInstance.undoCheckinEventPass(
|
|
|
886
886
|
|
|
887
887
|
### Return type
|
|
888
888
|
|
|
889
|
-
**
|
|
889
|
+
**GetEventPass200Response**
|
|
890
890
|
|
|
891
891
|
### Authorization
|
|
892
892
|
|
|
@@ -906,7 +906,7 @@ const { status, data } = await apiInstance.undoCheckinEventPass(
|
|
|
906
906
|
[[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)
|
|
907
907
|
|
|
908
908
|
# **updateEventPass**
|
|
909
|
-
>
|
|
909
|
+
> GetEventPass200Response updateEventPass(eventPassUpdateInputs)
|
|
910
910
|
|
|
911
911
|
Updates fields on an existing event pass/registration purchase, such as its ticket, coupon, or status, and requires update permission on attendees.
|
|
912
912
|
|
|
@@ -944,7 +944,7 @@ const { status, data } = await apiInstance.updateEventPass(
|
|
|
944
944
|
|
|
945
945
|
### Return type
|
|
946
946
|
|
|
947
|
-
**
|
|
947
|
+
**GetEventPass200Response**
|
|
948
948
|
|
|
949
949
|
### Authorization
|
|
950
950
|
|