@connectedxm/admin-sdk 6.20.0 → 6.24.2
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 +45 -0
- package/AdminApi.ts +18 -0
- package/README.md +78 -0
- package/api.ts +10608 -5445
- package/dist/AdminApi.d.ts +7 -1
- package/dist/AdminApi.js +6 -0
- package/dist/api.d.ts +3225 -410
- package/dist/api.js +8313 -4671
- package/dist/esm/AdminApi.d.ts +7 -1
- package/dist/esm/AdminApi.js +7 -1
- package/dist/esm/api.d.ts +3225 -410
- package/dist/esm/api.js +9638 -6020
- package/docs/BaseBookingQuestionResponse.md +26 -0
- package/docs/BaseBookingSpaceQuestion.md +58 -0
- package/docs/BaseBookingSpaceQuestionChoice.md +30 -0
- package/docs/BaseEvent.md +2 -0
- package/docs/BaseEventPassType.md +2 -0
- package/docs/BaseLogin.md +4 -4
- package/docs/BaseSurvey.md +2 -2
- package/docs/Booking.md +2 -0
- package/docs/BookingQuestionResponse.md +34 -0
- package/docs/BookingSpace.md +6 -0
- package/docs/BookingSpaceCreateInputs.md +4 -0
- package/docs/BookingSpaceQuestion.md +66 -0
- package/docs/BookingSpaceQuestionChoice.md +38 -0
- package/docs/BookingSpaceQuestionChoiceCreateInputs.md +28 -0
- package/docs/BookingSpaceQuestionChoiceTranslation.md +32 -0
- package/docs/BookingSpaceQuestionChoiceTranslationUpdateInputs.md +24 -0
- package/docs/BookingSpaceQuestionChoiceUpdateInputs.md +28 -0
- package/docs/BookingSpaceQuestionCreateInputs.md +56 -0
- package/docs/BookingSpaceQuestionTranslation.md +32 -0
- package/docs/BookingSpaceQuestionTranslationUpdateInputs.md +24 -0
- package/docs/BookingSpaceQuestionType.md +30 -0
- package/docs/BookingSpaceQuestionUpdateInputs.md +56 -0
- package/docs/BookingSpaceQuestionUpdateInputsChoices.md +18 -0
- package/docs/BookingSpaceUpdateInputs.md +4 -0
- package/docs/BookingsApi.md +52 -0
- package/docs/BookingsQuestionsApi.md +489 -0
- package/docs/BookingsQuestionsChoicesApi.md +387 -0
- package/docs/BookingsQuestionsChoicesTranslationsApi.md +264 -0
- package/docs/BookingsQuestionsTranslationsApi.md +252 -0
- package/docs/CreateBookingSpaceQuestion200Response.md +24 -0
- package/docs/CreateBookingSpaceQuestionChoice200Response.md +24 -0
- package/docs/CreateEventSessionTime200Response.md +24 -0
- package/docs/Event.md +2 -0
- package/docs/EventCreateInputs.md +2 -0
- package/docs/EventEmailType.md +4 -0
- package/docs/EventPassType.md +2 -0
- package/docs/EventSessionQuestionType.md +0 -2
- package/docs/EventSessionTime.md +34 -0
- package/docs/EventSessionTimeCreateInputs.md +24 -0
- package/docs/EventSessionTimeTranslation.md +30 -0
- package/docs/EventSessionTimeTranslationUpdateInputs.md +22 -0
- package/docs/EventSessionTimeUpdateInputs.md +24 -0
- package/docs/EventUpdateInputs.md +2 -0
- package/docs/EventsPassesApi.md +183 -0
- package/docs/EventsSessionsTimesApi.md +503 -0
- package/docs/EventsSessionsTimesTranslationsApi.md +264 -0
- package/docs/GetBookingResponses200Response.md +24 -0
- package/docs/GetBookingSpaceQuestionChoiceTranslation200Response.md +24 -0
- package/docs/GetBookingSpaceQuestionChoiceTranslations200Response.md +24 -0
- package/docs/GetBookingSpaceQuestionChoices200Response.md +26 -0
- package/docs/GetBookingSpaceQuestionTranslation200Response.md +24 -0
- package/docs/GetBookingSpaceQuestionTranslations200Response.md +24 -0
- package/docs/GetBookingSpaceQuestions200Response.md +26 -0
- package/docs/GetEventSessionTimeTranslation200Response.md +24 -0
- package/docs/GetEventSessionTimeTranslations200Response.md +26 -0
- package/docs/GetEventSessionTimes200Response.md +26 -0
- package/docs/Login.md +4 -0
- package/docs/Meeting.md +2 -0
- package/docs/MeetingCreateInputs.md +4 -0
- package/docs/MeetingUpdateInputs.md +4 -0
- package/docs/PassTypeCreateInputs.md +2 -0
- package/docs/PassTypeUpdateInputs.md +2 -0
- package/docs/PurchaseStatus.md +2 -0
- package/docs/ReorderBookingSpaceQuestionChoices200Response.md +24 -0
- package/docs/ReorderBookingSpaceQuestions200Response.md +24 -0
- package/docs/ReportsApi.md +52 -0
- package/docs/Survey.md +2 -2
- package/docs/SurveyCreateInputs.md +2 -2
- package/docs/SurveyStatus.md +12 -0
- package/docs/SurveyUpdateInputs.md +2 -2
- package/docs/SurveysApi.md +3 -0
- package/docs/UpdateBookingSpaceQuestionChoiceTranslation200Response.md +24 -0
- package/docs/UpdateBookingSpaceQuestionTranslation200Response.md +24 -0
- package/package.json +2 -2
package/docs/EventsPassesApi.md
CHANGED
|
@@ -4,21 +4,81 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**approveEventPass**](#approveeventpass) | **PUT** /events/{eventId}/passes/{passId}/approve | Approve Event Pass|
|
|
7
8
|
|[**cancelEventPass**](#canceleventpass) | **PUT** /events/{eventId}/passes/{passId}/cancel | Cancel Event Pass|
|
|
8
9
|
|[**checkinEventPass**](#checkineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin | Checkin Event Pass|
|
|
9
10
|
|[**createEventPass**](#createeventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes | Create Event Pass|
|
|
10
11
|
|[**deleteEventPass**](#deleteeventpass) | **DELETE** /events/{eventId}/passes/{passId} | Delete Event Pass|
|
|
12
|
+
|[**denyEventPass**](#denyeventpass) | **PUT** /events/{eventId}/passes/{passId}/deny | Deny Event Pass|
|
|
11
13
|
|[**getEventPass**](#geteventpass) | **GET** /events/{eventId}/passes/{passId} | Get Event Pass|
|
|
12
14
|
|[**getEventPassMatches**](#geteventpassmatches) | **GET** /events/{eventId}/passes/{passId}/matches | Get Event Pass Matches|
|
|
13
15
|
|[**getEventPassPayments**](#geteventpasspayments) | **GET** /events/{eventId}/passes/{passId}/payments | Get Event Pass Payments|
|
|
14
16
|
|[**getEventPassTransferLogs**](#geteventpasstransferlogs) | **GET** /events/{eventId}/passes/{passId}/transfers/logs | Get Event Pass Transfer Logs|
|
|
15
17
|
|[**getEventPasses**](#geteventpasses) | **GET** /events/{eventId}/passes | Get Event Passes|
|
|
18
|
+
|[**getEventPendingPasses**](#geteventpendingpasses) | **GET** /events/{eventId}/passes/pending | Get Event Pending Passes|
|
|
16
19
|
|[**indexEventPasses**](#indexeventpasses) | **POST** /events/{eventId}/index-passes | Index Event Passes|
|
|
17
20
|
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes/{passId}/transfers | Transfer Event Pass|
|
|
18
21
|
|[**undoCheckinEventPass**](#undocheckineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin/undo | Undo Checkin Event Pass|
|
|
19
22
|
|[**updateEventPass**](#updateeventpass) | **PUT** /events/{eventId}/passes/{passId} | Update Event Pass|
|
|
20
23
|
|[**updateEventPassesReady**](#updateeventpassesready) | **POST** /events/{eventId}/passes/ready | Update Event Passes Ready|
|
|
21
24
|
|
|
25
|
+
# **approveEventPass**
|
|
26
|
+
> CreateEventPass200Response approveEventPass()
|
|
27
|
+
|
|
28
|
+
Approve Event Pass endpoint
|
|
29
|
+
|
|
30
|
+
### Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import {
|
|
34
|
+
EventsPassesApi,
|
|
35
|
+
Configuration
|
|
36
|
+
} from '@connectedxm/admin-sdk';
|
|
37
|
+
|
|
38
|
+
const configuration = new Configuration();
|
|
39
|
+
const apiInstance = new EventsPassesApi(configuration);
|
|
40
|
+
|
|
41
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
42
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
43
|
+
let sendEmail: boolean; //Filter by sendEmail (optional) (default to undefined)
|
|
44
|
+
|
|
45
|
+
const { status, data } = await apiInstance.approveEventPass(
|
|
46
|
+
eventId,
|
|
47
|
+
passId,
|
|
48
|
+
sendEmail
|
|
49
|
+
);
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Parameters
|
|
53
|
+
|
|
54
|
+
|Name | Type | Description | Notes|
|
|
55
|
+
|------------- | ------------- | ------------- | -------------|
|
|
56
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
57
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
58
|
+
| **sendEmail** | [**boolean**] | Filter by sendEmail | (optional) defaults to undefined|
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
**CreateEventPass200Response**
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: Not defined
|
|
72
|
+
- **Accept**: application/json
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### HTTP response details
|
|
76
|
+
| Status code | Description | Response headers |
|
|
77
|
+
|-------------|-------------|------------------|
|
|
78
|
+
|**200** | Successful response | - |
|
|
79
|
+
|
|
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
|
+
|
|
22
82
|
# **cancelEventPass**
|
|
23
83
|
> CreateEventPass200Response cancelEventPass()
|
|
24
84
|
|
|
@@ -238,6 +298,66 @@ const { status, data } = await apiInstance.deleteEventPass(
|
|
|
238
298
|
- **Accept**: application/json
|
|
239
299
|
|
|
240
300
|
|
|
301
|
+
### HTTP response details
|
|
302
|
+
| Status code | Description | Response headers |
|
|
303
|
+
|-------------|-------------|------------------|
|
|
304
|
+
|**200** | Successful response | - |
|
|
305
|
+
|
|
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
|
+
|
|
308
|
+
# **denyEventPass**
|
|
309
|
+
> CreateEventPass200Response denyEventPass()
|
|
310
|
+
|
|
311
|
+
Deny Event Pass endpoint
|
|
312
|
+
|
|
313
|
+
### Example
|
|
314
|
+
|
|
315
|
+
```typescript
|
|
316
|
+
import {
|
|
317
|
+
EventsPassesApi,
|
|
318
|
+
Configuration
|
|
319
|
+
} from '@connectedxm/admin-sdk';
|
|
320
|
+
|
|
321
|
+
const configuration = new Configuration();
|
|
322
|
+
const apiInstance = new EventsPassesApi(configuration);
|
|
323
|
+
|
|
324
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
325
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
326
|
+
let sendEmail: boolean; //Filter by sendEmail (optional) (default to undefined)
|
|
327
|
+
let refund: boolean; //Filter by refund (optional) (default to undefined)
|
|
328
|
+
|
|
329
|
+
const { status, data } = await apiInstance.denyEventPass(
|
|
330
|
+
eventId,
|
|
331
|
+
passId,
|
|
332
|
+
sendEmail,
|
|
333
|
+
refund
|
|
334
|
+
);
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
### Parameters
|
|
338
|
+
|
|
339
|
+
|Name | Type | Description | Notes|
|
|
340
|
+
|------------- | ------------- | ------------- | -------------|
|
|
341
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
342
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
343
|
+
| **sendEmail** | [**boolean**] | Filter by sendEmail | (optional) defaults to undefined|
|
|
344
|
+
| **refund** | [**boolean**] | Filter by refund | (optional) defaults to undefined|
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
### Return type
|
|
348
|
+
|
|
349
|
+
**CreateEventPass200Response**
|
|
350
|
+
|
|
351
|
+
### Authorization
|
|
352
|
+
|
|
353
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
354
|
+
|
|
355
|
+
### HTTP request headers
|
|
356
|
+
|
|
357
|
+
- **Content-Type**: Not defined
|
|
358
|
+
- **Accept**: application/json
|
|
359
|
+
|
|
360
|
+
|
|
241
361
|
### HTTP response details
|
|
242
362
|
| Status code | Description | Response headers |
|
|
243
363
|
|-------------|-------------|------------------|
|
|
@@ -536,6 +656,69 @@ const { status, data } = await apiInstance.getEventPasses(
|
|
|
536
656
|
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
537
657
|
|
|
538
658
|
|
|
659
|
+
### Return type
|
|
660
|
+
|
|
661
|
+
**GetEventAddOnPasses200Response**
|
|
662
|
+
|
|
663
|
+
### Authorization
|
|
664
|
+
|
|
665
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
666
|
+
|
|
667
|
+
### HTTP request headers
|
|
668
|
+
|
|
669
|
+
- **Content-Type**: Not defined
|
|
670
|
+
- **Accept**: application/json
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
### HTTP response details
|
|
674
|
+
| Status code | Description | Response headers |
|
|
675
|
+
|-------------|-------------|------------------|
|
|
676
|
+
|**200** | Successful response | - |
|
|
677
|
+
|
|
678
|
+
[[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)
|
|
679
|
+
|
|
680
|
+
# **getEventPendingPasses**
|
|
681
|
+
> GetEventAddOnPasses200Response getEventPendingPasses()
|
|
682
|
+
|
|
683
|
+
Get Event Pending Passes endpoint
|
|
684
|
+
|
|
685
|
+
### Example
|
|
686
|
+
|
|
687
|
+
```typescript
|
|
688
|
+
import {
|
|
689
|
+
EventsPassesApi,
|
|
690
|
+
Configuration
|
|
691
|
+
} from '@connectedxm/admin-sdk';
|
|
692
|
+
|
|
693
|
+
const configuration = new Configuration();
|
|
694
|
+
const apiInstance = new EventsPassesApi(configuration);
|
|
695
|
+
|
|
696
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
697
|
+
let page: number; //Page number (optional) (default to 1)
|
|
698
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
699
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
700
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
701
|
+
|
|
702
|
+
const { status, data } = await apiInstance.getEventPendingPasses(
|
|
703
|
+
eventId,
|
|
704
|
+
page,
|
|
705
|
+
pageSize,
|
|
706
|
+
orderBy,
|
|
707
|
+
search
|
|
708
|
+
);
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
### Parameters
|
|
712
|
+
|
|
713
|
+
|Name | Type | Description | Notes|
|
|
714
|
+
|------------- | ------------- | ------------- | -------------|
|
|
715
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
716
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
717
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
718
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
719
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
720
|
+
|
|
721
|
+
|
|
539
722
|
### Return type
|
|
540
723
|
|
|
541
724
|
**GetEventAddOnPasses200Response**
|