@connectedxm/admin-sdk 6.7.7 → 6.8.6
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 +8 -0
- package/AdminApi.ts +3 -0
- package/README.md +18 -0
- package/api.ts +1666 -321
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +720 -4
- package/dist/api.js +992 -28
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +720 -4
- package/dist/esm/api.js +970 -10
- package/docs/BaseEventActivation.md +2 -0
- package/docs/BaseEventBlock.md +24 -0
- package/docs/BaseSurvey.md +2 -0
- package/docs/BaseSurveySubmission.md +6 -0
- package/docs/CreateEventBlock200Response.md +24 -0
- package/docs/EventActivation.md +2 -0
- package/docs/EventBlock.md +32 -0
- package/docs/EventBlockCreateInputs.md +22 -0
- package/docs/EventBlockUpdateInputs.md +22 -0
- package/docs/EventSession.md +2 -0
- package/docs/EventsBlocksApi.md +479 -0
- package/docs/EventsCouponsApi.md +3 -0
- package/docs/EventsSessionsApi.md +183 -0
- package/docs/GetEventBlocks200Response.md +26 -0
- package/docs/Survey.md +18 -0
- package/docs/SurveyAllOfCount.md +20 -0
- package/docs/SurveyCreateInputs.md +8 -0
- package/docs/SurveySubmission.md +6 -0
- package/docs/SurveySubmissionUpdateInputs.md +4 -0
- package/docs/SurveyUpdateInputs.md +8 -0
- package/docs/SurveysApi.md +6 -0
- package/package.json +1 -1
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**startAfter** | **string** | | [default to undefined]
|
|
15
15
|
**type** | [**EventActivationType**](EventActivationType.md) | | [default to undefined]
|
|
16
16
|
**accessLevel** | [**PassTypeAccessLevel**](PassTypeAccessLevel.md) | | [default to undefined]
|
|
17
|
+
**survey** | [**BaseSurvey**](BaseSurvey.md) | | [default to undefined]
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -30,6 +31,7 @@ const instance: BaseEventActivation = {
|
|
|
30
31
|
startAfter,
|
|
31
32
|
type,
|
|
32
33
|
accessLevel,
|
|
34
|
+
survey,
|
|
33
35
|
};
|
|
34
36
|
```
|
|
35
37
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# BaseEventBlock
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
**limit** | **number** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { BaseEventBlock } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: BaseEventBlock = {
|
|
18
|
+
id,
|
|
19
|
+
name,
|
|
20
|
+
limit,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/BaseSurvey.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**slug** | **string** | | [default to undefined]
|
|
10
10
|
**name** | **string** | | [default to undefined]
|
|
11
|
+
**active** | **boolean** | | [default to undefined]
|
|
11
12
|
**description** | **string** | | [default to undefined]
|
|
12
13
|
**image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
13
14
|
**requireAuth** | **boolean** | | [default to undefined]
|
|
@@ -22,6 +23,7 @@ const instance: BaseSurvey = {
|
|
|
22
23
|
id,
|
|
23
24
|
slug,
|
|
24
25
|
name,
|
|
26
|
+
active,
|
|
25
27
|
description,
|
|
26
28
|
image,
|
|
27
29
|
requireAuth,
|
|
@@ -6,7 +6,10 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
|
+
**accountId** | **string** | | [default to undefined]
|
|
9
10
|
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
11
|
+
**passId** | **string** | | [default to undefined]
|
|
12
|
+
**pass** | [**BaseEventPass**](BaseEventPass.md) | | [default to undefined]
|
|
10
13
|
**status** | [**PurchaseStatus**](PurchaseStatus.md) | | [default to undefined]
|
|
11
14
|
**responses** | [**Array<BaseSurveyQuestionResponse>**](BaseSurveyQuestionResponse.md) | | [default to undefined]
|
|
12
15
|
|
|
@@ -17,7 +20,10 @@ import { BaseSurveySubmission } from '@connectedxm/admin-sdk';
|
|
|
17
20
|
|
|
18
21
|
const instance: BaseSurveySubmission = {
|
|
19
22
|
id,
|
|
23
|
+
accountId,
|
|
20
24
|
account,
|
|
25
|
+
passId,
|
|
26
|
+
pass,
|
|
21
27
|
status,
|
|
22
28
|
responses,
|
|
23
29
|
};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreateEventBlock200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**EventBlock**](EventBlock.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateEventBlock200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CreateEventBlock200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/EventActivation.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**startAfter** | **string** | | [default to undefined]
|
|
15
15
|
**type** | [**EventActivationType**](EventActivationType.md) | | [default to undefined]
|
|
16
16
|
**accessLevel** | [**PassTypeAccessLevel**](PassTypeAccessLevel.md) | | [default to undefined]
|
|
17
|
+
**survey** | [**BaseSurvey**](BaseSurvey.md) | | [default to undefined]
|
|
17
18
|
**eventId** | **string** | | [default to undefined]
|
|
18
19
|
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
19
20
|
**imageId** | **string** | | [default to undefined]
|
|
@@ -38,6 +39,7 @@ const instance: EventActivation = {
|
|
|
38
39
|
startAfter,
|
|
39
40
|
type,
|
|
40
41
|
accessLevel,
|
|
42
|
+
survey,
|
|
41
43
|
eventId,
|
|
42
44
|
event,
|
|
43
45
|
imageId,
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# EventBlock
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
**limit** | **number** | | [default to undefined]
|
|
11
|
+
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
12
|
+
**sessions** | [**Array<BaseEventSession>**](BaseEventSession.md) | | [default to undefined]
|
|
13
|
+
**createdAt** | **string** | | [default to undefined]
|
|
14
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { EventBlock } from '@connectedxm/admin-sdk';
|
|
20
|
+
|
|
21
|
+
const instance: EventBlock = {
|
|
22
|
+
id,
|
|
23
|
+
name,
|
|
24
|
+
limit,
|
|
25
|
+
event,
|
|
26
|
+
sessions,
|
|
27
|
+
createdAt,
|
|
28
|
+
updatedAt,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EventBlockCreateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [default to undefined]
|
|
9
|
+
**limit** | **number** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EventBlockCreateInputs } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EventBlockCreateInputs = {
|
|
17
|
+
name,
|
|
18
|
+
limit,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# EventBlockUpdateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**limit** | **number** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EventBlockUpdateInputs } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: EventBlockUpdateInputs = {
|
|
17
|
+
name,
|
|
18
|
+
limit,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/EventSession.md
CHANGED
|
@@ -37,6 +37,7 @@ Name | Type | Description | Notes
|
|
|
37
37
|
**speakers** | [**Array<BaseEventSpeaker>**](BaseEventSpeaker.md) | | [default to undefined]
|
|
38
38
|
**meetingId** | **string** | | [default to undefined]
|
|
39
39
|
**meeting** | [**BaseMeeting**](BaseMeeting.md) | | [default to undefined]
|
|
40
|
+
**blocks** | [**Array<BaseEventBlock>**](BaseEventBlock.md) | | [default to undefined]
|
|
40
41
|
|
|
41
42
|
## Example
|
|
42
43
|
|
|
@@ -76,6 +77,7 @@ const instance: EventSession = {
|
|
|
76
77
|
speakers,
|
|
77
78
|
meetingId,
|
|
78
79
|
meeting,
|
|
80
|
+
blocks,
|
|
79
81
|
};
|
|
80
82
|
```
|
|
81
83
|
|
|
@@ -0,0 +1,479 @@
|
|
|
1
|
+
# EventsBlocksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addEventBlockSession**](#addeventblocksession) | **POST** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Add Event Block Session|
|
|
8
|
+
|[**createEventBlock**](#createeventblock) | **POST** /events/{eventId}/blocks | Create Event Block|
|
|
9
|
+
|[**deleteEventBlock**](#deleteeventblock) | **DELETE** /events/{eventId}/blocks/{blockId} | Delete Event Block|
|
|
10
|
+
|[**getEventBlock**](#geteventblock) | **GET** /events/{eventId}/blocks/{blockId} | Get Event Block|
|
|
11
|
+
|[**getEventBlockSessions**](#geteventblocksessions) | **GET** /events/{eventId}/blocks/{blockId}/sessions | Get Event Block Sessions|
|
|
12
|
+
|[**getEventBlocks**](#geteventblocks) | **GET** /events/{eventId}/blocks | Get Event Blocks|
|
|
13
|
+
|[**removeEventBlockSession**](#removeeventblocksession) | **DELETE** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Remove Event Block Session|
|
|
14
|
+
|[**updateEventBlock**](#updateeventblock) | **PUT** /events/{eventId}/blocks/{blockId} | Update Event Block|
|
|
15
|
+
|
|
16
|
+
# **addEventBlockSession**
|
|
17
|
+
> CreateEventBlock200Response addEventBlockSession()
|
|
18
|
+
|
|
19
|
+
Add Event Block Session endpoint
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import {
|
|
25
|
+
EventsBlocksApi,
|
|
26
|
+
Configuration
|
|
27
|
+
} from '@connectedxm/admin-sdk';
|
|
28
|
+
|
|
29
|
+
const configuration = new Configuration();
|
|
30
|
+
const apiInstance = new EventsBlocksApi(configuration);
|
|
31
|
+
|
|
32
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
33
|
+
let blockId: string; //The block identifier (default to undefined)
|
|
34
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
35
|
+
|
|
36
|
+
const { status, data } = await apiInstance.addEventBlockSession(
|
|
37
|
+
eventId,
|
|
38
|
+
blockId,
|
|
39
|
+
sessionId
|
|
40
|
+
);
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
|Name | Type | Description | Notes|
|
|
46
|
+
|------------- | ------------- | ------------- | -------------|
|
|
47
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
48
|
+
| **blockId** | [**string**] | The block identifier | defaults to undefined|
|
|
49
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
**CreateEventBlock200Response**
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
|
|
58
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
59
|
+
|
|
60
|
+
### HTTP request headers
|
|
61
|
+
|
|
62
|
+
- **Content-Type**: Not defined
|
|
63
|
+
- **Accept**: application/json
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
### HTTP response details
|
|
67
|
+
| Status code | Description | Response headers |
|
|
68
|
+
|-------------|-------------|------------------|
|
|
69
|
+
|**200** | Successful response | - |
|
|
70
|
+
|
|
71
|
+
[[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)
|
|
72
|
+
|
|
73
|
+
# **createEventBlock**
|
|
74
|
+
> CreateEventBlock200Response createEventBlock(eventBlockCreateInputs)
|
|
75
|
+
|
|
76
|
+
Create Event Block endpoint
|
|
77
|
+
|
|
78
|
+
### Example
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
import {
|
|
82
|
+
EventsBlocksApi,
|
|
83
|
+
Configuration,
|
|
84
|
+
EventBlockCreateInputs
|
|
85
|
+
} from '@connectedxm/admin-sdk';
|
|
86
|
+
|
|
87
|
+
const configuration = new Configuration();
|
|
88
|
+
const apiInstance = new EventsBlocksApi(configuration);
|
|
89
|
+
|
|
90
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
91
|
+
let eventBlockCreateInputs: EventBlockCreateInputs; //
|
|
92
|
+
|
|
93
|
+
const { status, data } = await apiInstance.createEventBlock(
|
|
94
|
+
eventId,
|
|
95
|
+
eventBlockCreateInputs
|
|
96
|
+
);
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Parameters
|
|
100
|
+
|
|
101
|
+
|Name | Type | Description | Notes|
|
|
102
|
+
|------------- | ------------- | ------------- | -------------|
|
|
103
|
+
| **eventBlockCreateInputs** | **EventBlockCreateInputs**| | |
|
|
104
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
### Return type
|
|
108
|
+
|
|
109
|
+
**CreateEventBlock200Response**
|
|
110
|
+
|
|
111
|
+
### Authorization
|
|
112
|
+
|
|
113
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
114
|
+
|
|
115
|
+
### HTTP request headers
|
|
116
|
+
|
|
117
|
+
- **Content-Type**: application/json
|
|
118
|
+
- **Accept**: application/json
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
### HTTP response details
|
|
122
|
+
| Status code | Description | Response headers |
|
|
123
|
+
|-------------|-------------|------------------|
|
|
124
|
+
|**200** | Successful response | - |
|
|
125
|
+
|
|
126
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
127
|
+
|
|
128
|
+
# **deleteEventBlock**
|
|
129
|
+
> CreateAccountInvitations200Response deleteEventBlock()
|
|
130
|
+
|
|
131
|
+
Delete Event Block endpoint
|
|
132
|
+
|
|
133
|
+
### Example
|
|
134
|
+
|
|
135
|
+
```typescript
|
|
136
|
+
import {
|
|
137
|
+
EventsBlocksApi,
|
|
138
|
+
Configuration
|
|
139
|
+
} from '@connectedxm/admin-sdk';
|
|
140
|
+
|
|
141
|
+
const configuration = new Configuration();
|
|
142
|
+
const apiInstance = new EventsBlocksApi(configuration);
|
|
143
|
+
|
|
144
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
145
|
+
let blockId: string; //The block identifier (default to undefined)
|
|
146
|
+
|
|
147
|
+
const { status, data } = await apiInstance.deleteEventBlock(
|
|
148
|
+
eventId,
|
|
149
|
+
blockId
|
|
150
|
+
);
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Parameters
|
|
154
|
+
|
|
155
|
+
|Name | Type | Description | Notes|
|
|
156
|
+
|------------- | ------------- | ------------- | -------------|
|
|
157
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
158
|
+
| **blockId** | [**string**] | The block identifier | defaults to undefined|
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### Return type
|
|
162
|
+
|
|
163
|
+
**CreateAccountInvitations200Response**
|
|
164
|
+
|
|
165
|
+
### Authorization
|
|
166
|
+
|
|
167
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
168
|
+
|
|
169
|
+
### HTTP request headers
|
|
170
|
+
|
|
171
|
+
- **Content-Type**: Not defined
|
|
172
|
+
- **Accept**: application/json
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
### HTTP response details
|
|
176
|
+
| Status code | Description | Response headers |
|
|
177
|
+
|-------------|-------------|------------------|
|
|
178
|
+
|**200** | Successful response | - |
|
|
179
|
+
|
|
180
|
+
[[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)
|
|
181
|
+
|
|
182
|
+
# **getEventBlock**
|
|
183
|
+
> CreateEventBlock200Response getEventBlock()
|
|
184
|
+
|
|
185
|
+
Get Event Block endpoint
|
|
186
|
+
|
|
187
|
+
### Example
|
|
188
|
+
|
|
189
|
+
```typescript
|
|
190
|
+
import {
|
|
191
|
+
EventsBlocksApi,
|
|
192
|
+
Configuration
|
|
193
|
+
} from '@connectedxm/admin-sdk';
|
|
194
|
+
|
|
195
|
+
const configuration = new Configuration();
|
|
196
|
+
const apiInstance = new EventsBlocksApi(configuration);
|
|
197
|
+
|
|
198
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
199
|
+
let blockId: string; //The block identifier (default to undefined)
|
|
200
|
+
|
|
201
|
+
const { status, data } = await apiInstance.getEventBlock(
|
|
202
|
+
eventId,
|
|
203
|
+
blockId
|
|
204
|
+
);
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Parameters
|
|
208
|
+
|
|
209
|
+
|Name | Type | Description | Notes|
|
|
210
|
+
|------------- | ------------- | ------------- | -------------|
|
|
211
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
212
|
+
| **blockId** | [**string**] | The block identifier | defaults to undefined|
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
### Return type
|
|
216
|
+
|
|
217
|
+
**CreateEventBlock200Response**
|
|
218
|
+
|
|
219
|
+
### Authorization
|
|
220
|
+
|
|
221
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
222
|
+
|
|
223
|
+
### HTTP request headers
|
|
224
|
+
|
|
225
|
+
- **Content-Type**: Not defined
|
|
226
|
+
- **Accept**: application/json
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
### HTTP response details
|
|
230
|
+
| Status code | Description | Response headers |
|
|
231
|
+
|-------------|-------------|------------------|
|
|
232
|
+
|**200** | Successful response | - |
|
|
233
|
+
|
|
234
|
+
[[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)
|
|
235
|
+
|
|
236
|
+
# **getEventBlockSessions**
|
|
237
|
+
> GetAccountInvitations200Response getEventBlockSessions()
|
|
238
|
+
|
|
239
|
+
Get Event Block Sessions endpoint
|
|
240
|
+
|
|
241
|
+
### Example
|
|
242
|
+
|
|
243
|
+
```typescript
|
|
244
|
+
import {
|
|
245
|
+
EventsBlocksApi,
|
|
246
|
+
Configuration
|
|
247
|
+
} from '@connectedxm/admin-sdk';
|
|
248
|
+
|
|
249
|
+
const configuration = new Configuration();
|
|
250
|
+
const apiInstance = new EventsBlocksApi(configuration);
|
|
251
|
+
|
|
252
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
253
|
+
let blockId: string; //The block identifier (default to undefined)
|
|
254
|
+
let page: number; //Page number (optional) (default to 1)
|
|
255
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
256
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
257
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
258
|
+
|
|
259
|
+
const { status, data } = await apiInstance.getEventBlockSessions(
|
|
260
|
+
eventId,
|
|
261
|
+
blockId,
|
|
262
|
+
page,
|
|
263
|
+
pageSize,
|
|
264
|
+
orderBy,
|
|
265
|
+
search
|
|
266
|
+
);
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Parameters
|
|
270
|
+
|
|
271
|
+
|Name | Type | Description | Notes|
|
|
272
|
+
|------------- | ------------- | ------------- | -------------|
|
|
273
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
274
|
+
| **blockId** | [**string**] | The block identifier | defaults to undefined|
|
|
275
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
276
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
277
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
278
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
### Return type
|
|
282
|
+
|
|
283
|
+
**GetAccountInvitations200Response**
|
|
284
|
+
|
|
285
|
+
### Authorization
|
|
286
|
+
|
|
287
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
288
|
+
|
|
289
|
+
### HTTP request headers
|
|
290
|
+
|
|
291
|
+
- **Content-Type**: Not defined
|
|
292
|
+
- **Accept**: application/json
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
### HTTP response details
|
|
296
|
+
| Status code | Description | Response headers |
|
|
297
|
+
|-------------|-------------|------------------|
|
|
298
|
+
|**200** | Successful response | - |
|
|
299
|
+
|
|
300
|
+
[[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)
|
|
301
|
+
|
|
302
|
+
# **getEventBlocks**
|
|
303
|
+
> GetEventBlocks200Response getEventBlocks()
|
|
304
|
+
|
|
305
|
+
Get Event Blocks endpoint
|
|
306
|
+
|
|
307
|
+
### Example
|
|
308
|
+
|
|
309
|
+
```typescript
|
|
310
|
+
import {
|
|
311
|
+
EventsBlocksApi,
|
|
312
|
+
Configuration
|
|
313
|
+
} from '@connectedxm/admin-sdk';
|
|
314
|
+
|
|
315
|
+
const configuration = new Configuration();
|
|
316
|
+
const apiInstance = new EventsBlocksApi(configuration);
|
|
317
|
+
|
|
318
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
319
|
+
let page: number; //Page number (optional) (default to 1)
|
|
320
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
321
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
322
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
323
|
+
|
|
324
|
+
const { status, data } = await apiInstance.getEventBlocks(
|
|
325
|
+
eventId,
|
|
326
|
+
page,
|
|
327
|
+
pageSize,
|
|
328
|
+
orderBy,
|
|
329
|
+
search
|
|
330
|
+
);
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
### Parameters
|
|
334
|
+
|
|
335
|
+
|Name | Type | Description | Notes|
|
|
336
|
+
|------------- | ------------- | ------------- | -------------|
|
|
337
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
338
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
339
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
340
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
341
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
### Return type
|
|
345
|
+
|
|
346
|
+
**GetEventBlocks200Response**
|
|
347
|
+
|
|
348
|
+
### Authorization
|
|
349
|
+
|
|
350
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
351
|
+
|
|
352
|
+
### HTTP request headers
|
|
353
|
+
|
|
354
|
+
- **Content-Type**: Not defined
|
|
355
|
+
- **Accept**: application/json
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
### HTTP response details
|
|
359
|
+
| Status code | Description | Response headers |
|
|
360
|
+
|-------------|-------------|------------------|
|
|
361
|
+
|**200** | Successful response | - |
|
|
362
|
+
|
|
363
|
+
[[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)
|
|
364
|
+
|
|
365
|
+
# **removeEventBlockSession**
|
|
366
|
+
> CreateEventBlock200Response removeEventBlockSession()
|
|
367
|
+
|
|
368
|
+
Remove Event Block Session endpoint
|
|
369
|
+
|
|
370
|
+
### Example
|
|
371
|
+
|
|
372
|
+
```typescript
|
|
373
|
+
import {
|
|
374
|
+
EventsBlocksApi,
|
|
375
|
+
Configuration
|
|
376
|
+
} from '@connectedxm/admin-sdk';
|
|
377
|
+
|
|
378
|
+
const configuration = new Configuration();
|
|
379
|
+
const apiInstance = new EventsBlocksApi(configuration);
|
|
380
|
+
|
|
381
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
382
|
+
let blockId: string; //The block identifier (default to undefined)
|
|
383
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
384
|
+
|
|
385
|
+
const { status, data } = await apiInstance.removeEventBlockSession(
|
|
386
|
+
eventId,
|
|
387
|
+
blockId,
|
|
388
|
+
sessionId
|
|
389
|
+
);
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
### Parameters
|
|
393
|
+
|
|
394
|
+
|Name | Type | Description | Notes|
|
|
395
|
+
|------------- | ------------- | ------------- | -------------|
|
|
396
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
397
|
+
| **blockId** | [**string**] | The block identifier | defaults to undefined|
|
|
398
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
### Return type
|
|
402
|
+
|
|
403
|
+
**CreateEventBlock200Response**
|
|
404
|
+
|
|
405
|
+
### Authorization
|
|
406
|
+
|
|
407
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
408
|
+
|
|
409
|
+
### HTTP request headers
|
|
410
|
+
|
|
411
|
+
- **Content-Type**: Not defined
|
|
412
|
+
- **Accept**: application/json
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
### HTTP response details
|
|
416
|
+
| Status code | Description | Response headers |
|
|
417
|
+
|-------------|-------------|------------------|
|
|
418
|
+
|**200** | Successful response | - |
|
|
419
|
+
|
|
420
|
+
[[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)
|
|
421
|
+
|
|
422
|
+
# **updateEventBlock**
|
|
423
|
+
> CreateEventBlock200Response updateEventBlock(eventBlockUpdateInputs)
|
|
424
|
+
|
|
425
|
+
Update Event Block endpoint
|
|
426
|
+
|
|
427
|
+
### Example
|
|
428
|
+
|
|
429
|
+
```typescript
|
|
430
|
+
import {
|
|
431
|
+
EventsBlocksApi,
|
|
432
|
+
Configuration,
|
|
433
|
+
EventBlockUpdateInputs
|
|
434
|
+
} from '@connectedxm/admin-sdk';
|
|
435
|
+
|
|
436
|
+
const configuration = new Configuration();
|
|
437
|
+
const apiInstance = new EventsBlocksApi(configuration);
|
|
438
|
+
|
|
439
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
440
|
+
let blockId: string; //The block identifier (default to undefined)
|
|
441
|
+
let eventBlockUpdateInputs: EventBlockUpdateInputs; //
|
|
442
|
+
|
|
443
|
+
const { status, data } = await apiInstance.updateEventBlock(
|
|
444
|
+
eventId,
|
|
445
|
+
blockId,
|
|
446
|
+
eventBlockUpdateInputs
|
|
447
|
+
);
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
### Parameters
|
|
451
|
+
|
|
452
|
+
|Name | Type | Description | Notes|
|
|
453
|
+
|------------- | ------------- | ------------- | -------------|
|
|
454
|
+
| **eventBlockUpdateInputs** | **EventBlockUpdateInputs**| | |
|
|
455
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
456
|
+
| **blockId** | [**string**] | The block identifier | defaults to undefined|
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
### Return type
|
|
460
|
+
|
|
461
|
+
**CreateEventBlock200Response**
|
|
462
|
+
|
|
463
|
+
### Authorization
|
|
464
|
+
|
|
465
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
466
|
+
|
|
467
|
+
### HTTP request headers
|
|
468
|
+
|
|
469
|
+
- **Content-Type**: application/json
|
|
470
|
+
- **Accept**: application/json
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
### HTTP response details
|
|
474
|
+
| Status code | Description | Response headers |
|
|
475
|
+
|-------------|-------------|------------------|
|
|
476
|
+
|**200** | Successful response | - |
|
|
477
|
+
|
|
478
|
+
[[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)
|
|
479
|
+
|