@connectedxm/admin-sdk 6.7.5 → 6.7.7
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 +2 -0
- package/README.md +4 -0
- package/api.ts +218 -34
- package/dist/api.d.ts +110 -16
- package/dist/api.js +172 -24
- package/dist/esm/api.d.ts +110 -16
- package/dist/esm/api.js +172 -24
- package/docs/DeleteManyImagesInput.md +20 -0
- package/docs/DeleteManyVideosInput.md +20 -0
- package/docs/EventsPassesApi.md +110 -0
- package/docs/StorageImagesApi.md +7 -6
- package/docs/StorageVideosApi.md +7 -6
- package/package.json +1 -1
package/docs/EventsPassesApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add Event Pass Add On|
|
|
8
8
|
|[**cancelEventPass**](#canceleventpass) | **PUT** /events/{eventId}/passes/{passId}/cancel | Cancel Event Pass|
|
|
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
|
|[**createEventSessionAccess**](#createeventsessionaccess) | **POST** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Create Event Session Access|
|
|
11
12
|
|[**deleteEventPass**](#deleteeventpass) | **DELETE** /events/{eventId}/passes/{passId} | Delete Event Pass|
|
|
@@ -25,6 +26,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
25
26
|
|[**indexEventPasses**](#indexeventpasses) | **POST** /events/{eventId}/index-passes | Index Event Passes|
|
|
26
27
|
|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove Event Pass Add On|
|
|
27
28
|
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes/{passId}/transfers | Transfer Event Pass|
|
|
29
|
+
|[**undoCheckinEventPass**](#undocheckineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin/undo | Undo Checkin Event Pass|
|
|
28
30
|
|[**updateEventPass**](#updateeventpass) | **PUT** /events/{eventId}/passes/{passId} | Update Event Pass|
|
|
29
31
|
|[**updateEventPassFollowupResponses**](#updateeventpassfollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups | Update Event Pass Followup Responses|
|
|
30
32
|
|[**updateEventPassResponse**](#updateeventpassresponse) | **PUT** /events/{eventId}/passes/{passId}/responses/{questionId} | Update Event Pass Response|
|
|
@@ -126,6 +128,60 @@ const { status, data } = await apiInstance.cancelEventPass(
|
|
|
126
128
|
| **sendEmail** | [**boolean**] | Filter by sendEmail | (optional) defaults to undefined|
|
|
127
129
|
|
|
128
130
|
|
|
131
|
+
### Return type
|
|
132
|
+
|
|
133
|
+
**CreateEventPass200Response**
|
|
134
|
+
|
|
135
|
+
### Authorization
|
|
136
|
+
|
|
137
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
138
|
+
|
|
139
|
+
### HTTP request headers
|
|
140
|
+
|
|
141
|
+
- **Content-Type**: Not defined
|
|
142
|
+
- **Accept**: application/json
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
### HTTP response details
|
|
146
|
+
| Status code | Description | Response headers |
|
|
147
|
+
|-------------|-------------|------------------|
|
|
148
|
+
|**200** | Successful response | - |
|
|
149
|
+
|
|
150
|
+
[[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)
|
|
151
|
+
|
|
152
|
+
# **checkinEventPass**
|
|
153
|
+
> CreateEventPass200Response checkinEventPass()
|
|
154
|
+
|
|
155
|
+
Checkin Event Pass endpoint
|
|
156
|
+
|
|
157
|
+
### Example
|
|
158
|
+
|
|
159
|
+
```typescript
|
|
160
|
+
import {
|
|
161
|
+
EventsPassesApi,
|
|
162
|
+
Configuration
|
|
163
|
+
} from '@connectedxm/admin-sdk';
|
|
164
|
+
|
|
165
|
+
const configuration = new Configuration();
|
|
166
|
+
const apiInstance = new EventsPassesApi(configuration);
|
|
167
|
+
|
|
168
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
169
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
170
|
+
|
|
171
|
+
const { status, data } = await apiInstance.checkinEventPass(
|
|
172
|
+
eventId,
|
|
173
|
+
passId
|
|
174
|
+
);
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
|Name | Type | Description | Notes|
|
|
180
|
+
|------------- | ------------- | ------------- | -------------|
|
|
181
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
182
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
183
|
+
|
|
184
|
+
|
|
129
185
|
### Return type
|
|
130
186
|
|
|
131
187
|
**CreateEventPass200Response**
|
|
@@ -1311,6 +1367,60 @@ const { status, data } = await apiInstance.transferEventPass(
|
|
|
1311
1367
|
- **Accept**: application/json
|
|
1312
1368
|
|
|
1313
1369
|
|
|
1370
|
+
### HTTP response details
|
|
1371
|
+
| Status code | Description | Response headers |
|
|
1372
|
+
|-------------|-------------|------------------|
|
|
1373
|
+
|**200** | Successful response | - |
|
|
1374
|
+
|
|
1375
|
+
[[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)
|
|
1376
|
+
|
|
1377
|
+
# **undoCheckinEventPass**
|
|
1378
|
+
> CreateEventPass200Response undoCheckinEventPass()
|
|
1379
|
+
|
|
1380
|
+
Undo Checkin Event Pass endpoint
|
|
1381
|
+
|
|
1382
|
+
### Example
|
|
1383
|
+
|
|
1384
|
+
```typescript
|
|
1385
|
+
import {
|
|
1386
|
+
EventsPassesApi,
|
|
1387
|
+
Configuration
|
|
1388
|
+
} from '@connectedxm/admin-sdk';
|
|
1389
|
+
|
|
1390
|
+
const configuration = new Configuration();
|
|
1391
|
+
const apiInstance = new EventsPassesApi(configuration);
|
|
1392
|
+
|
|
1393
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
1394
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
1395
|
+
|
|
1396
|
+
const { status, data } = await apiInstance.undoCheckinEventPass(
|
|
1397
|
+
eventId,
|
|
1398
|
+
passId
|
|
1399
|
+
);
|
|
1400
|
+
```
|
|
1401
|
+
|
|
1402
|
+
### Parameters
|
|
1403
|
+
|
|
1404
|
+
|Name | Type | Description | Notes|
|
|
1405
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1406
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1407
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
### Return type
|
|
1411
|
+
|
|
1412
|
+
**CreateEventPass200Response**
|
|
1413
|
+
|
|
1414
|
+
### Authorization
|
|
1415
|
+
|
|
1416
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1417
|
+
|
|
1418
|
+
### HTTP request headers
|
|
1419
|
+
|
|
1420
|
+
- **Content-Type**: Not defined
|
|
1421
|
+
- **Accept**: application/json
|
|
1422
|
+
|
|
1423
|
+
|
|
1314
1424
|
### HTTP response details
|
|
1315
1425
|
| Status code | Description | Response headers |
|
|
1316
1426
|
|-------------|-------------|------------------|
|
package/docs/StorageImagesApi.md
CHANGED
|
@@ -117,7 +117,7 @@ const { status, data } = await apiInstance.deleteImage(
|
|
|
117
117
|
[[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)
|
|
118
118
|
|
|
119
119
|
# **deleteManyImages**
|
|
120
|
-
> CreateAccountInvitations200Response deleteManyImages()
|
|
120
|
+
> CreateAccountInvitations200Response deleteManyImages(deleteManyImagesInput)
|
|
121
121
|
|
|
122
122
|
Delete Many Images endpoint
|
|
123
123
|
|
|
@@ -126,16 +126,17 @@ Delete Many Images endpoint
|
|
|
126
126
|
```typescript
|
|
127
127
|
import {
|
|
128
128
|
StorageImagesApi,
|
|
129
|
-
Configuration
|
|
129
|
+
Configuration,
|
|
130
|
+
DeleteManyImagesInput
|
|
130
131
|
} from '@connectedxm/admin-sdk';
|
|
131
132
|
|
|
132
133
|
const configuration = new Configuration();
|
|
133
134
|
const apiInstance = new StorageImagesApi(configuration);
|
|
134
135
|
|
|
135
|
-
let
|
|
136
|
+
let deleteManyImagesInput: DeleteManyImagesInput; //
|
|
136
137
|
|
|
137
138
|
const { status, data } = await apiInstance.deleteManyImages(
|
|
138
|
-
|
|
139
|
+
deleteManyImagesInput
|
|
139
140
|
);
|
|
140
141
|
```
|
|
141
142
|
|
|
@@ -143,7 +144,7 @@ const { status, data } = await apiInstance.deleteManyImages(
|
|
|
143
144
|
|
|
144
145
|
|Name | Type | Description | Notes|
|
|
145
146
|
|------------- | ------------- | ------------- | -------------|
|
|
146
|
-
| **
|
|
147
|
+
| **deleteManyImagesInput** | **DeleteManyImagesInput**| | |
|
|
147
148
|
|
|
148
149
|
|
|
149
150
|
### Return type
|
|
@@ -156,7 +157,7 @@ const { status, data } = await apiInstance.deleteManyImages(
|
|
|
156
157
|
|
|
157
158
|
### HTTP request headers
|
|
158
159
|
|
|
159
|
-
- **Content-Type**:
|
|
160
|
+
- **Content-Type**: application/json
|
|
160
161
|
- **Accept**: application/json
|
|
161
162
|
|
|
162
163
|
|
package/docs/StorageVideosApi.md
CHANGED
|
@@ -13,7 +13,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
13
13
|
|[**updateVideo**](#updatevideo) | **PUT** /videos/{videoId} | Update Video|
|
|
14
14
|
|
|
15
15
|
# **deleteManyVideos**
|
|
16
|
-
> CreateAccountInvitations200Response deleteManyVideos()
|
|
16
|
+
> CreateAccountInvitations200Response deleteManyVideos(deleteManyVideosInput)
|
|
17
17
|
|
|
18
18
|
Delete Many Videos endpoint
|
|
19
19
|
|
|
@@ -22,16 +22,17 @@ Delete Many Videos endpoint
|
|
|
22
22
|
```typescript
|
|
23
23
|
import {
|
|
24
24
|
StorageVideosApi,
|
|
25
|
-
Configuration
|
|
25
|
+
Configuration,
|
|
26
|
+
DeleteManyVideosInput
|
|
26
27
|
} from '@connectedxm/admin-sdk';
|
|
27
28
|
|
|
28
29
|
const configuration = new Configuration();
|
|
29
30
|
const apiInstance = new StorageVideosApi(configuration);
|
|
30
31
|
|
|
31
|
-
let
|
|
32
|
+
let deleteManyVideosInput: DeleteManyVideosInput; //
|
|
32
33
|
|
|
33
34
|
const { status, data } = await apiInstance.deleteManyVideos(
|
|
34
|
-
|
|
35
|
+
deleteManyVideosInput
|
|
35
36
|
);
|
|
36
37
|
```
|
|
37
38
|
|
|
@@ -39,7 +40,7 @@ const { status, data } = await apiInstance.deleteManyVideos(
|
|
|
39
40
|
|
|
40
41
|
|Name | Type | Description | Notes|
|
|
41
42
|
|------------- | ------------- | ------------- | -------------|
|
|
42
|
-
| **
|
|
43
|
+
| **deleteManyVideosInput** | **DeleteManyVideosInput**| | |
|
|
43
44
|
|
|
44
45
|
|
|
45
46
|
### Return type
|
|
@@ -52,7 +53,7 @@ const { status, data } = await apiInstance.deleteManyVideos(
|
|
|
52
53
|
|
|
53
54
|
### HTTP request headers
|
|
54
55
|
|
|
55
|
-
- **Content-Type**:
|
|
56
|
+
- **Content-Type**: application/json
|
|
56
57
|
- **Accept**: application/json
|
|
57
58
|
|
|
58
59
|
|