@connectedxm/admin-sdk 8.1.3 → 8.2.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 +30 -1
- package/README.md +2 -2
- package/api.ts +1388 -2111
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +647 -959
- package/dist/api.js +1182 -1491
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +647 -959
- package/dist/esm/api.js +1167 -1476
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/APILog.md +4 -0
- package/docs/ActivitiesApi.md +6 -12
- package/docs/AddChannelSubscriberRequest.md +20 -0
- package/docs/AddCustomReportUserRequest.md +20 -0
- package/docs/{ImportCreateInputsValuesInner.md → AddEventAccessUserRequest.md} +3 -3
- package/docs/AddEventAddOnTierRequest.md +20 -0
- package/docs/AddRoomToRoomTypeRequest.md +20 -0
- package/docs/ApproveEventPassRequest.md +20 -0
- package/docs/BaseAPILog.md +4 -0
- package/docs/BenefitsApi.md +5 -5
- package/docs/BookingsAvailabilitiesApi.md +5 -5
- package/docs/BookingsBlackoutsApi.md +5 -5
- package/docs/BookingsPlacesApi.md +5 -5
- package/docs/BookingsQuestionsApi.md +7 -6
- package/docs/BookingsQuestionsChoicesApi.md +7 -6
- package/docs/BookingsSpacesApi.md +5 -5
- package/docs/BulkUploadSearchListValuesRequest.md +20 -0
- package/docs/ChannelsApi.md +22 -21
- package/docs/CreateActivityRequest.md +24 -0
- package/docs/CreateEventSessionPriceRequest.md +22 -0
- package/docs/CreateGroupInvitationsRequest.md +22 -0
- package/docs/CreateOrganizationSideEffectRequest.md +26 -0
- package/docs/CreateThreadMessageReactionRequest.md +22 -0
- package/docs/DenyEventPassRequest.md +22 -0
- package/docs/EventsAccessApi.md +7 -6
- package/docs/EventsAddonsApi.md +12 -11
- package/docs/EventsBypassApi.md +5 -5
- package/docs/EventsCouponsApi.md +7 -6
- package/docs/EventsFaqsApi.md +17 -16
- package/docs/EventsFollowupsApi.md +26 -23
- package/docs/EventsMatchesApi.md +7 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +5 -5
- package/docs/EventsPagesApi.md +5 -5
- package/docs/EventsPassesApi.md +25 -24
- package/docs/EventsPassesFollowupsApi.md +14 -12
- package/docs/EventsPasstypesApi.md +12 -11
- package/docs/EventsQuestionsApi.md +31 -28
- package/docs/EventsRegistrationsPackagesApi.md +10 -10
- package/docs/EventsRoomsApi.md +14 -15
- package/docs/EventsRoomtypesApi.md +12 -11
- package/docs/EventsSectionsApi.md +26 -23
- package/docs/EventsSessionsApi.md +5 -5
- package/docs/EventsSessionsLocationsApi.md +5 -5
- package/docs/EventsSessionsMatchesApi.md +7 -6
- package/docs/EventsSessionsPricesApi.md +13 -17
- package/docs/EventsSessionsQuestionsApi.md +31 -28
- package/docs/EventsSessionsSectionsApi.md +19 -17
- package/docs/EventsSpeakersApi.md +5 -5
- package/docs/EventsSponsorshiplevelsApi.md +12 -11
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +5 -5
- package/docs/EventsSponsorshipsApi.md +12 -11
- package/docs/EventsSponsorshipsTranslationsApi.md +5 -5
- package/docs/GroupsInvitationsApi.md +7 -9
- package/docs/ImportCreateInputs.md +1 -1
- package/docs/ImportRoomsRequest.md +22 -0
- package/docs/InterestsApi.md +5 -5
- package/docs/InvoicesApi.md +5 -5
- package/docs/InvoicesLineitemsApi.md +5 -5
- package/docs/LoginsApi.md +14 -12
- package/docs/MarkNotificationsReadRequest.md +20 -0
- package/docs/NotificationsApi.md +7 -6
- package/docs/OrganizationApi.md +14 -21
- package/docs/OrganizationDomainsApi.md +7 -6
- package/docs/OrganizationSideeffectsApi.md +7 -15
- package/docs/OrganizationTeammembersApi.md +5 -5
- package/docs/OrganizationUsersApi.md +7 -6
- package/docs/ReorderBookingSpaceQuestionChoicesRequest.md +20 -0
- package/docs/ReorderBookingSpaceQuestionsRequest.md +20 -0
- package/docs/ReorderEventFaqSectionQuestionsRequest.md +20 -0
- package/docs/ReorderEventSponsorshipLevelsRequest.md +20 -0
- package/docs/ReorderEventSponsorshipsRequest.md +20 -0
- package/docs/ReportsApi.md +5 -5
- package/docs/ReportsUsersApi.md +7 -6
- package/docs/SearchlistsValuesApi.md +7 -6
- package/docs/SeriesApi.md +5 -5
- package/docs/SeriesQuestionsApi.md +5 -5
- package/docs/SeriesQuestionsChoicesApi.md +12 -11
- package/docs/SponsorsApi.md +5 -5
- package/docs/StartEventRoundMatchmakingRequest.md +20 -0
- package/docs/StorageFilesApi.md +7 -12
- package/docs/StorageVideosCaptionsApi.md +7 -9
- package/docs/StreamsApi.md +5 -5
- package/docs/StreamsOutputsApi.md +5 -5
- package/docs/SurveysQuestionsApi.md +31 -28
- package/docs/SurveysSectionsApi.md +19 -17
- package/docs/ThreadsMessagesReactionsApi.md +6 -9
- package/docs/UpdateEventFollowupQuestionRequest.md +20 -0
- package/docs/UpdateEventPassFollowupResponsesRequest.md +20 -0
- package/docs/UpdateEventSessionPriceRequest.md +22 -0
- package/docs/UpdateLoginPasswordRequest.md +20 -0
- package/docs/UpdateOrganizationDomainRequest.md +20 -0
- package/docs/UpdateOrganizationIntegrationsRequest.md +26 -0
- package/docs/UploadFileRequest.md +24 -0
- package/docs/UploadVideoCaptionsRequest.md +22 -0
- package/docs/UpsertLinkPreviewRequest.md +20 -0
- package/package.json +1 -1
|
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.deleteSeriesQuestionChoice(
|
|
|
125
125
|
[[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)
|
|
126
126
|
|
|
127
127
|
# **reorderSeriesQuestionChoices**
|
|
128
|
-
> ReorderSeriesQuestionChoices200Response reorderSeriesQuestionChoices()
|
|
128
|
+
> ReorderSeriesQuestionChoices200Response reorderSeriesQuestionChoices(reorderBookingSpaceQuestionChoicesRequest)
|
|
129
129
|
|
|
130
130
|
Sets the display order of a series question\'s answer choices from a complete, ordered array of choice IDs; all existing choice IDs must be included or the request is rejected, and update permission on events is required.
|
|
131
131
|
|
|
@@ -134,7 +134,8 @@ Sets the display order of a series question\'s answer choices from a complete, o
|
|
|
134
134
|
```typescript
|
|
135
135
|
import {
|
|
136
136
|
SeriesQuestionsChoicesApi,
|
|
137
|
-
Configuration
|
|
137
|
+
Configuration,
|
|
138
|
+
ReorderBookingSpaceQuestionChoicesRequest
|
|
138
139
|
} from '@connectedxm/admin-sdk';
|
|
139
140
|
|
|
140
141
|
const configuration = new Configuration();
|
|
@@ -142,12 +143,12 @@ const apiInstance = new SeriesQuestionsChoicesApi(configuration);
|
|
|
142
143
|
|
|
143
144
|
let seriesId: string; //The series identifier (default to undefined)
|
|
144
145
|
let questionId: string; //The question identifier (default to undefined)
|
|
145
|
-
let
|
|
146
|
+
let reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest; //
|
|
146
147
|
|
|
147
148
|
const { status, data } = await apiInstance.reorderSeriesQuestionChoices(
|
|
148
149
|
seriesId,
|
|
149
150
|
questionId,
|
|
150
|
-
|
|
151
|
+
reorderBookingSpaceQuestionChoicesRequest
|
|
151
152
|
);
|
|
152
153
|
```
|
|
153
154
|
|
|
@@ -155,9 +156,9 @@ const { status, data } = await apiInstance.reorderSeriesQuestionChoices(
|
|
|
155
156
|
|
|
156
157
|
|Name | Type | Description | Notes|
|
|
157
158
|
|------------- | ------------- | ------------- | -------------|
|
|
159
|
+
| **reorderBookingSpaceQuestionChoicesRequest** | **ReorderBookingSpaceQuestionChoicesRequest**| | |
|
|
158
160
|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
|
|
159
161
|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
160
|
-
| **choicesIds** | **Array<string>** | Filter by choicesIds | defaults to undefined|
|
|
161
162
|
|
|
162
163
|
|
|
163
164
|
### Return type
|
|
@@ -170,7 +171,7 @@ const { status, data } = await apiInstance.reorderSeriesQuestionChoices(
|
|
|
170
171
|
|
|
171
172
|
### HTTP request headers
|
|
172
173
|
|
|
173
|
-
- **Content-Type**:
|
|
174
|
+
- **Content-Type**: application/json
|
|
174
175
|
- **Accept**: application/json
|
|
175
176
|
|
|
176
177
|
|
|
@@ -182,7 +183,7 @@ const { status, data } = await apiInstance.reorderSeriesQuestionChoices(
|
|
|
182
183
|
[[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)
|
|
183
184
|
|
|
184
185
|
# **updateSeriesQuestionChoice**
|
|
185
|
-
> CreateSeriesQuestionChoice200Response updateSeriesQuestionChoice()
|
|
186
|
+
> CreateSeriesQuestionChoice200Response updateSeriesQuestionChoice(seriesQuestionChoiceUpdateInputs)
|
|
186
187
|
|
|
187
188
|
Updates the properties (such as label or value) of an existing answer choice on a series question, identified by seriesId, questionId, and choiceId; requires update permission on events.
|
|
188
189
|
|
|
@@ -201,13 +202,13 @@ const apiInstance = new SeriesQuestionsChoicesApi(configuration);
|
|
|
201
202
|
let seriesId: string; //The series identifier (default to undefined)
|
|
202
203
|
let questionId: string; //The question identifier (default to undefined)
|
|
203
204
|
let choiceId: string; //The choice identifier (default to undefined)
|
|
204
|
-
let
|
|
205
|
+
let seriesQuestionChoiceUpdateInputs: SeriesQuestionChoiceUpdateInputs; //
|
|
205
206
|
|
|
206
207
|
const { status, data } = await apiInstance.updateSeriesQuestionChoice(
|
|
207
208
|
seriesId,
|
|
208
209
|
questionId,
|
|
209
210
|
choiceId,
|
|
210
|
-
|
|
211
|
+
seriesQuestionChoiceUpdateInputs
|
|
211
212
|
);
|
|
212
213
|
```
|
|
213
214
|
|
|
@@ -215,10 +216,10 @@ const { status, data } = await apiInstance.updateSeriesQuestionChoice(
|
|
|
215
216
|
|
|
216
217
|
|Name | Type | Description | Notes|
|
|
217
218
|
|------------- | ------------- | ------------- | -------------|
|
|
219
|
+
| **seriesQuestionChoiceUpdateInputs** | **SeriesQuestionChoiceUpdateInputs**| | |
|
|
218
220
|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
|
|
219
221
|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
220
222
|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
|
|
221
|
-
| **choice** | **SeriesQuestionChoiceUpdateInputs** | Filter by choice | defaults to undefined|
|
|
222
223
|
|
|
223
224
|
|
|
224
225
|
### Return type
|
|
@@ -231,7 +232,7 @@ const { status, data } = await apiInstance.updateSeriesQuestionChoice(
|
|
|
231
232
|
|
|
232
233
|
### HTTP request headers
|
|
233
234
|
|
|
234
|
-
- **Content-Type**:
|
|
235
|
+
- **Content-Type**: application/json
|
|
235
236
|
- **Accept**: application/json
|
|
236
237
|
|
|
237
238
|
|
package/docs/SponsorsApi.md
CHANGED
|
@@ -225,7 +225,7 @@ const { status, data } = await apiInstance.getLevels(
|
|
|
225
225
|
[[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)
|
|
226
226
|
|
|
227
227
|
# **updateLevel**
|
|
228
|
-
> CreateLevel200Response updateLevel()
|
|
228
|
+
> CreateLevel200Response updateLevel(levelUpdateInputs)
|
|
229
229
|
|
|
230
230
|
Updates the details of an existing sponsorship level, such as its name, pricing, or benefits, requiring update permission on sponsors.
|
|
231
231
|
|
|
@@ -242,11 +242,11 @@ const configuration = new Configuration();
|
|
|
242
242
|
const apiInstance = new SponsorsApi(configuration);
|
|
243
243
|
|
|
244
244
|
let levelId: string; //The level identifier (default to undefined)
|
|
245
|
-
let
|
|
245
|
+
let levelUpdateInputs: LevelUpdateInputs; //
|
|
246
246
|
|
|
247
247
|
const { status, data } = await apiInstance.updateLevel(
|
|
248
248
|
levelId,
|
|
249
|
-
|
|
249
|
+
levelUpdateInputs
|
|
250
250
|
);
|
|
251
251
|
```
|
|
252
252
|
|
|
@@ -254,8 +254,8 @@ const { status, data } = await apiInstance.updateLevel(
|
|
|
254
254
|
|
|
255
255
|
|Name | Type | Description | Notes|
|
|
256
256
|
|------------- | ------------- | ------------- | -------------|
|
|
257
|
+
| **levelUpdateInputs** | **LevelUpdateInputs**| | |
|
|
257
258
|
| **levelId** | [**string**] | The level identifier | defaults to undefined|
|
|
258
|
-
| **level** | **LevelUpdateInputs** | Filter by level | defaults to undefined|
|
|
259
259
|
|
|
260
260
|
|
|
261
261
|
### Return type
|
|
@@ -268,7 +268,7 @@ const { status, data } = await apiInstance.updateLevel(
|
|
|
268
268
|
|
|
269
269
|
### HTTP request headers
|
|
270
270
|
|
|
271
|
-
- **Content-Type**:
|
|
271
|
+
- **Content-Type**: application/json
|
|
272
272
|
- **Accept**: application/json
|
|
273
273
|
|
|
274
274
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# StartEventRoundMatchmakingRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**targetMatchSize** | **number** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { StartEventRoundMatchmakingRequest } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: StartEventRoundMatchmakingRequest = {
|
|
16
|
+
targetMatchSize,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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/StorageFilesApi.md
CHANGED
|
@@ -123,7 +123,7 @@ const { status, data } = await apiInstance.getFiles(
|
|
|
123
123
|
[[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)
|
|
124
124
|
|
|
125
125
|
# **uploadFile**
|
|
126
|
-
> UploadFile200Response uploadFile()
|
|
126
|
+
> UploadFile200Response uploadFile(uploadFileRequest)
|
|
127
127
|
|
|
128
128
|
Uploads a file encoded as a base64 data URI directly to storage and records it, tagging it with the given source (\"admin\" or \"response\") and optional name, requiring create permission on storage.
|
|
129
129
|
|
|
@@ -132,20 +132,17 @@ Uploads a file encoded as a base64 data URI directly to storage and records it,
|
|
|
132
132
|
```typescript
|
|
133
133
|
import {
|
|
134
134
|
StorageFilesApi,
|
|
135
|
-
Configuration
|
|
135
|
+
Configuration,
|
|
136
|
+
UploadFileRequest
|
|
136
137
|
} from '@connectedxm/admin-sdk';
|
|
137
138
|
|
|
138
139
|
const configuration = new Configuration();
|
|
139
140
|
const apiInstance = new StorageFilesApi(configuration);
|
|
140
141
|
|
|
141
|
-
let
|
|
142
|
-
let source: 'admin' | 'response'; //Filter by source (default to undefined)
|
|
143
|
-
let name: string; //Filter by name (optional) (default to undefined)
|
|
142
|
+
let uploadFileRequest: UploadFileRequest; //
|
|
144
143
|
|
|
145
144
|
const { status, data } = await apiInstance.uploadFile(
|
|
146
|
-
|
|
147
|
-
source,
|
|
148
|
-
name
|
|
145
|
+
uploadFileRequest
|
|
149
146
|
);
|
|
150
147
|
```
|
|
151
148
|
|
|
@@ -153,9 +150,7 @@ const { status, data } = await apiInstance.uploadFile(
|
|
|
153
150
|
|
|
154
151
|
|Name | Type | Description | Notes|
|
|
155
152
|
|------------- | ------------- | ------------- | -------------|
|
|
156
|
-
| **
|
|
157
|
-
| **source** | [**'admin' | 'response'**]**Array<'admin' | 'response'>** | Filter by source | defaults to undefined|
|
|
158
|
-
| **name** | [**string**] | Filter by name | (optional) defaults to undefined|
|
|
153
|
+
| **uploadFileRequest** | **UploadFileRequest**| | |
|
|
159
154
|
|
|
160
155
|
|
|
161
156
|
### Return type
|
|
@@ -168,7 +163,7 @@ const { status, data } = await apiInstance.uploadFile(
|
|
|
168
163
|
|
|
169
164
|
### HTTP request headers
|
|
170
165
|
|
|
171
|
-
- **Content-Type**:
|
|
166
|
+
- **Content-Type**: application/json
|
|
172
167
|
- **Accept**: application/json
|
|
173
168
|
|
|
174
169
|
|
|
@@ -236,7 +236,7 @@ const { status, data } = await apiInstance.getVideoCaptions(
|
|
|
236
236
|
[[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)
|
|
237
237
|
|
|
238
238
|
# **uploadVideoCaptions**
|
|
239
|
-
> UploadVideoCaptions200Response uploadVideoCaptions()
|
|
239
|
+
> UploadVideoCaptions200Response uploadVideoCaptions(uploadVideoCaptionsRequest)
|
|
240
240
|
|
|
241
241
|
Uploads a WebVTT caption file (as base64 or a data URI) for a video in the given language, creating or replacing the caption track on Cloudflare Stream; requires the update and read permissions on the storage module.
|
|
242
242
|
|
|
@@ -245,7 +245,8 @@ Uploads a WebVTT caption file (as base64 or a data URI) for a video in the given
|
|
|
245
245
|
```typescript
|
|
246
246
|
import {
|
|
247
247
|
StorageVideosCaptionsApi,
|
|
248
|
-
Configuration
|
|
248
|
+
Configuration,
|
|
249
|
+
UploadVideoCaptionsRequest
|
|
249
250
|
} from '@connectedxm/admin-sdk';
|
|
250
251
|
|
|
251
252
|
const configuration = new Configuration();
|
|
@@ -253,14 +254,12 @@ const apiInstance = new StorageVideosCaptionsApi(configuration);
|
|
|
253
254
|
|
|
254
255
|
let videoId: string; //The video identifier (default to undefined)
|
|
255
256
|
let language: string; //The language identifier (default to undefined)
|
|
256
|
-
let
|
|
257
|
-
let filename: string; //Filter by filename (optional) (default to undefined)
|
|
257
|
+
let uploadVideoCaptionsRequest: UploadVideoCaptionsRequest; //
|
|
258
258
|
|
|
259
259
|
const { status, data } = await apiInstance.uploadVideoCaptions(
|
|
260
260
|
videoId,
|
|
261
261
|
language,
|
|
262
|
-
|
|
263
|
-
filename
|
|
262
|
+
uploadVideoCaptionsRequest
|
|
264
263
|
);
|
|
265
264
|
```
|
|
266
265
|
|
|
@@ -268,10 +267,9 @@ const { status, data } = await apiInstance.uploadVideoCaptions(
|
|
|
268
267
|
|
|
269
268
|
|Name | Type | Description | Notes|
|
|
270
269
|
|------------- | ------------- | ------------- | -------------|
|
|
270
|
+
| **uploadVideoCaptionsRequest** | **UploadVideoCaptionsRequest**| | |
|
|
271
271
|
| **videoId** | [**string**] | The video identifier | defaults to undefined|
|
|
272
272
|
| **language** | [**string**] | The language identifier | defaults to undefined|
|
|
273
|
-
| **file** | [**string**] | Filter by file | defaults to undefined|
|
|
274
|
-
| **filename** | [**string**] | Filter by filename | (optional) defaults to undefined|
|
|
275
273
|
|
|
276
274
|
|
|
277
275
|
### Return type
|
|
@@ -284,7 +282,7 @@ const { status, data } = await apiInstance.uploadVideoCaptions(
|
|
|
284
282
|
|
|
285
283
|
### HTTP request headers
|
|
286
284
|
|
|
287
|
-
- **Content-Type**:
|
|
285
|
+
- **Content-Type**: application/json
|
|
288
286
|
- **Accept**: application/json
|
|
289
287
|
|
|
290
288
|
|
package/docs/StreamsApi.md
CHANGED
|
@@ -302,7 +302,7 @@ const { status, data } = await apiInstance.getStreamVideos(
|
|
|
302
302
|
[[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)
|
|
303
303
|
|
|
304
304
|
# **updateStream**
|
|
305
|
-
> CreateStreamInput200Response updateStream()
|
|
305
|
+
> CreateStreamInput200Response updateStream(streamInputUpdateInputs)
|
|
306
306
|
|
|
307
307
|
Updates the configurable fields (e.g. name, associated event/session/group, image) of an existing stream input (streamId); requires the read and update permissions on streams.
|
|
308
308
|
|
|
@@ -319,11 +319,11 @@ const configuration = new Configuration();
|
|
|
319
319
|
const apiInstance = new StreamsApi(configuration);
|
|
320
320
|
|
|
321
321
|
let streamId: string; //The stream identifier (default to undefined)
|
|
322
|
-
let
|
|
322
|
+
let streamInputUpdateInputs: StreamInputUpdateInputs; //
|
|
323
323
|
|
|
324
324
|
const { status, data } = await apiInstance.updateStream(
|
|
325
325
|
streamId,
|
|
326
|
-
|
|
326
|
+
streamInputUpdateInputs
|
|
327
327
|
);
|
|
328
328
|
```
|
|
329
329
|
|
|
@@ -331,8 +331,8 @@ const { status, data } = await apiInstance.updateStream(
|
|
|
331
331
|
|
|
332
332
|
|Name | Type | Description | Notes|
|
|
333
333
|
|------------- | ------------- | ------------- | -------------|
|
|
334
|
+
| **streamInputUpdateInputs** | **StreamInputUpdateInputs**| | |
|
|
334
335
|
| **streamId** | [**string**] | The stream identifier | defaults to undefined|
|
|
335
|
-
| **stream** | **StreamInputUpdateInputs** | Filter by stream | defaults to undefined|
|
|
336
336
|
|
|
337
337
|
|
|
338
338
|
### Return type
|
|
@@ -345,7 +345,7 @@ const { status, data } = await apiInstance.updateStream(
|
|
|
345
345
|
|
|
346
346
|
### HTTP request headers
|
|
347
347
|
|
|
348
|
-
- **Content-Type**:
|
|
348
|
+
- **Content-Type**: application/json
|
|
349
349
|
- **Accept**: application/json
|
|
350
350
|
|
|
351
351
|
|
|
@@ -237,7 +237,7 @@ const { status, data } = await apiInstance.getStreamInputOutputs(
|
|
|
237
237
|
[[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)
|
|
238
238
|
|
|
239
239
|
# **updateStreamInputOutput**
|
|
240
|
-
> CreateStreamInputOutput200Response updateStreamInputOutput()
|
|
240
|
+
> CreateStreamInputOutput200Response updateStreamInputOutput(streamInputOutputUpdateInputs)
|
|
241
241
|
|
|
242
242
|
Toggles the enabled state of the specified restream output (outputId) on a stream input\'s Cloudflare live input, starting or stopping that restream destination; requires the read and update permissions on streams.
|
|
243
243
|
|
|
@@ -255,12 +255,12 @@ const apiInstance = new StreamsOutputsApi(configuration);
|
|
|
255
255
|
|
|
256
256
|
let streamId: string; //The stream identifier (default to undefined)
|
|
257
257
|
let outputId: string; //The output identifier (default to undefined)
|
|
258
|
-
let
|
|
258
|
+
let streamInputOutputUpdateInputs: StreamInputOutputUpdateInputs; //
|
|
259
259
|
|
|
260
260
|
const { status, data } = await apiInstance.updateStreamInputOutput(
|
|
261
261
|
streamId,
|
|
262
262
|
outputId,
|
|
263
|
-
|
|
263
|
+
streamInputOutputUpdateInputs
|
|
264
264
|
);
|
|
265
265
|
```
|
|
266
266
|
|
|
@@ -268,9 +268,9 @@ const { status, data } = await apiInstance.updateStreamInputOutput(
|
|
|
268
268
|
|
|
269
269
|
|Name | Type | Description | Notes|
|
|
270
270
|
|------------- | ------------- | ------------- | -------------|
|
|
271
|
+
| **streamInputOutputUpdateInputs** | **StreamInputOutputUpdateInputs**| | |
|
|
271
272
|
| **streamId** | [**string**] | The stream identifier | defaults to undefined|
|
|
272
273
|
| **outputId** | [**string**] | The output identifier | defaults to undefined|
|
|
273
|
-
| **output** | **StreamInputOutputUpdateInputs** | Filter by output | defaults to undefined|
|
|
274
274
|
|
|
275
275
|
|
|
276
276
|
### Return type
|
|
@@ -283,7 +283,7 @@ const { status, data } = await apiInstance.updateStreamInputOutput(
|
|
|
283
283
|
|
|
284
284
|
### HTTP request headers
|
|
285
285
|
|
|
286
|
-
- **Content-Type**:
|
|
286
|
+
- **Content-Type**: application/json
|
|
287
287
|
- **Accept**: application/json
|
|
288
288
|
|
|
289
289
|
|
|
@@ -859,7 +859,7 @@ const { status, data } = await apiInstance.removeSurveyQuestionChoiceSubQuestion
|
|
|
859
859
|
[[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)
|
|
860
860
|
|
|
861
861
|
# **reorderSurveyQuestionChoiceSubQuestions**
|
|
862
|
-
> ReorderSurveyQuestionChoiceSubQuestions200Response reorderSurveyQuestionChoiceSubQuestions()
|
|
862
|
+
> ReorderSurveyQuestionChoiceSubQuestions200Response reorderSurveyQuestionChoiceSubQuestions(reorderEventFaqSectionQuestionsRequest)
|
|
863
863
|
|
|
864
864
|
Sets the display order of the follow-up sub-questions attached to a survey question choice to match the given full list of question IDs, rejecting the request if any sub-question is missing or unknown, and requires update permission on surveys.
|
|
865
865
|
|
|
@@ -868,7 +868,8 @@ Sets the display order of the follow-up sub-questions attached to a survey quest
|
|
|
868
868
|
```typescript
|
|
869
869
|
import {
|
|
870
870
|
SurveysQuestionsApi,
|
|
871
|
-
Configuration
|
|
871
|
+
Configuration,
|
|
872
|
+
ReorderEventFaqSectionQuestionsRequest
|
|
872
873
|
} from '@connectedxm/admin-sdk';
|
|
873
874
|
|
|
874
875
|
const configuration = new Configuration();
|
|
@@ -877,13 +878,13 @@ const apiInstance = new SurveysQuestionsApi(configuration);
|
|
|
877
878
|
let surveyId: string; //The survey identifier (default to undefined)
|
|
878
879
|
let questionId: string; //The question identifier (default to undefined)
|
|
879
880
|
let choiceId: string; //The choice identifier (default to undefined)
|
|
880
|
-
let
|
|
881
|
+
let reorderEventFaqSectionQuestionsRequest: ReorderEventFaqSectionQuestionsRequest; //
|
|
881
882
|
|
|
882
883
|
const { status, data } = await apiInstance.reorderSurveyQuestionChoiceSubQuestions(
|
|
883
884
|
surveyId,
|
|
884
885
|
questionId,
|
|
885
886
|
choiceId,
|
|
886
|
-
|
|
887
|
+
reorderEventFaqSectionQuestionsRequest
|
|
887
888
|
);
|
|
888
889
|
```
|
|
889
890
|
|
|
@@ -891,10 +892,10 @@ const { status, data } = await apiInstance.reorderSurveyQuestionChoiceSubQuestio
|
|
|
891
892
|
|
|
892
893
|
|Name | Type | Description | Notes|
|
|
893
894
|
|------------- | ------------- | ------------- | -------------|
|
|
895
|
+
| **reorderEventFaqSectionQuestionsRequest** | **ReorderEventFaqSectionQuestionsRequest**| | |
|
|
894
896
|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
895
897
|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
896
898
|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
|
|
897
|
-
| **questionIds** | **Array<string>** | Filter by questionIds | defaults to undefined|
|
|
898
899
|
|
|
899
900
|
|
|
900
901
|
### Return type
|
|
@@ -907,7 +908,7 @@ const { status, data } = await apiInstance.reorderSurveyQuestionChoiceSubQuestio
|
|
|
907
908
|
|
|
908
909
|
### HTTP request headers
|
|
909
910
|
|
|
910
|
-
- **Content-Type**:
|
|
911
|
+
- **Content-Type**: application/json
|
|
911
912
|
- **Accept**: application/json
|
|
912
913
|
|
|
913
914
|
|
|
@@ -919,7 +920,7 @@ const { status, data } = await apiInstance.reorderSurveyQuestionChoiceSubQuestio
|
|
|
919
920
|
[[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)
|
|
920
921
|
|
|
921
922
|
# **reorderSurveyQuestionChoices**
|
|
922
|
-
> ReorderSurveyQuestionChoices200Response reorderSurveyQuestionChoices()
|
|
923
|
+
> ReorderSurveyQuestionChoices200Response reorderSurveyQuestionChoices(reorderBookingSpaceQuestionChoicesRequest)
|
|
923
924
|
|
|
924
925
|
Sets the display order of a survey question\'s answer choices to match the given full list of choice IDs, rejecting the request if any choice is missing or unknown, and requires update permission on surveys.
|
|
925
926
|
|
|
@@ -928,7 +929,8 @@ Sets the display order of a survey question\'s answer choices to match the given
|
|
|
928
929
|
```typescript
|
|
929
930
|
import {
|
|
930
931
|
SurveysQuestionsApi,
|
|
931
|
-
Configuration
|
|
932
|
+
Configuration,
|
|
933
|
+
ReorderBookingSpaceQuestionChoicesRequest
|
|
932
934
|
} from '@connectedxm/admin-sdk';
|
|
933
935
|
|
|
934
936
|
const configuration = new Configuration();
|
|
@@ -936,12 +938,12 @@ const apiInstance = new SurveysQuestionsApi(configuration);
|
|
|
936
938
|
|
|
937
939
|
let surveyId: string; //The survey identifier (default to undefined)
|
|
938
940
|
let questionId: string; //The question identifier (default to undefined)
|
|
939
|
-
let
|
|
941
|
+
let reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest; //
|
|
940
942
|
|
|
941
943
|
const { status, data } = await apiInstance.reorderSurveyQuestionChoices(
|
|
942
944
|
surveyId,
|
|
943
945
|
questionId,
|
|
944
|
-
|
|
946
|
+
reorderBookingSpaceQuestionChoicesRequest
|
|
945
947
|
);
|
|
946
948
|
```
|
|
947
949
|
|
|
@@ -949,9 +951,9 @@ const { status, data } = await apiInstance.reorderSurveyQuestionChoices(
|
|
|
949
951
|
|
|
950
952
|
|Name | Type | Description | Notes|
|
|
951
953
|
|------------- | ------------- | ------------- | -------------|
|
|
954
|
+
| **reorderBookingSpaceQuestionChoicesRequest** | **ReorderBookingSpaceQuestionChoicesRequest**| | |
|
|
952
955
|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
953
956
|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
954
|
-
| **choicesIds** | **Array<string>** | Filter by choicesIds | defaults to undefined|
|
|
955
957
|
|
|
956
958
|
|
|
957
959
|
### Return type
|
|
@@ -964,7 +966,7 @@ const { status, data } = await apiInstance.reorderSurveyQuestionChoices(
|
|
|
964
966
|
|
|
965
967
|
### HTTP request headers
|
|
966
968
|
|
|
967
|
-
- **Content-Type**:
|
|
969
|
+
- **Content-Type**: application/json
|
|
968
970
|
- **Accept**: application/json
|
|
969
971
|
|
|
970
972
|
|
|
@@ -976,7 +978,7 @@ const { status, data } = await apiInstance.reorderSurveyQuestionChoices(
|
|
|
976
978
|
[[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)
|
|
977
979
|
|
|
978
980
|
# **updateSurveyQuestion**
|
|
979
|
-
> CreateSurveyQuestion200Response updateSurveyQuestion()
|
|
981
|
+
> CreateSurveyQuestion200Response updateSurveyQuestion(surveyQuestionUpdateInputs)
|
|
980
982
|
|
|
981
983
|
Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
|
|
982
984
|
|
|
@@ -994,12 +996,12 @@ const apiInstance = new SurveysQuestionsApi(configuration);
|
|
|
994
996
|
|
|
995
997
|
let surveyId: string; //The survey identifier (default to undefined)
|
|
996
998
|
let questionId: string; //The question identifier (default to undefined)
|
|
997
|
-
let
|
|
999
|
+
let surveyQuestionUpdateInputs: SurveyQuestionUpdateInputs; //
|
|
998
1000
|
|
|
999
1001
|
const { status, data } = await apiInstance.updateSurveyQuestion(
|
|
1000
1002
|
surveyId,
|
|
1001
1003
|
questionId,
|
|
1002
|
-
|
|
1004
|
+
surveyQuestionUpdateInputs
|
|
1003
1005
|
);
|
|
1004
1006
|
```
|
|
1005
1007
|
|
|
@@ -1007,9 +1009,9 @@ const { status, data } = await apiInstance.updateSurveyQuestion(
|
|
|
1007
1009
|
|
|
1008
1010
|
|Name | Type | Description | Notes|
|
|
1009
1011
|
|------------- | ------------- | ------------- | -------------|
|
|
1012
|
+
| **surveyQuestionUpdateInputs** | **SurveyQuestionUpdateInputs**| | |
|
|
1010
1013
|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
1011
1014
|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
1012
|
-
| **question** | **SurveyQuestionUpdateInputs** | Filter by question | defaults to undefined|
|
|
1013
1015
|
|
|
1014
1016
|
|
|
1015
1017
|
### Return type
|
|
@@ -1022,7 +1024,7 @@ const { status, data } = await apiInstance.updateSurveyQuestion(
|
|
|
1022
1024
|
|
|
1023
1025
|
### HTTP request headers
|
|
1024
1026
|
|
|
1025
|
-
- **Content-Type**:
|
|
1027
|
+
- **Content-Type**: application/json
|
|
1026
1028
|
- **Accept**: application/json
|
|
1027
1029
|
|
|
1028
1030
|
|
|
@@ -1034,7 +1036,7 @@ const { status, data } = await apiInstance.updateSurveyQuestion(
|
|
|
1034
1036
|
[[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)
|
|
1035
1037
|
|
|
1036
1038
|
# **updateSurveyQuestionChoice**
|
|
1037
|
-
> SyncAccounts200Response updateSurveyQuestionChoice()
|
|
1039
|
+
> SyncAccounts200Response updateSurveyQuestionChoice(surveyQuestionChoiceUpdateInputs)
|
|
1038
1040
|
|
|
1039
1041
|
Updates a choice (such as its label or value) belonging to a survey question, and reorders it among the question\'s other choices when a new sortOrder is provided; requires the update surveys permission.
|
|
1040
1042
|
|
|
@@ -1053,13 +1055,13 @@ const apiInstance = new SurveysQuestionsApi(configuration);
|
|
|
1053
1055
|
let surveyId: string; //The survey identifier (default to undefined)
|
|
1054
1056
|
let questionId: string; //The question identifier (default to undefined)
|
|
1055
1057
|
let choiceId: string; //The choice identifier (default to undefined)
|
|
1056
|
-
let
|
|
1058
|
+
let surveyQuestionChoiceUpdateInputs: SurveyQuestionChoiceUpdateInputs; //
|
|
1057
1059
|
|
|
1058
1060
|
const { status, data } = await apiInstance.updateSurveyQuestionChoice(
|
|
1059
1061
|
surveyId,
|
|
1060
1062
|
questionId,
|
|
1061
1063
|
choiceId,
|
|
1062
|
-
|
|
1064
|
+
surveyQuestionChoiceUpdateInputs
|
|
1063
1065
|
);
|
|
1064
1066
|
```
|
|
1065
1067
|
|
|
@@ -1067,10 +1069,10 @@ const { status, data } = await apiInstance.updateSurveyQuestionChoice(
|
|
|
1067
1069
|
|
|
1068
1070
|
|Name | Type | Description | Notes|
|
|
1069
1071
|
|------------- | ------------- | ------------- | -------------|
|
|
1072
|
+
| **surveyQuestionChoiceUpdateInputs** | **SurveyQuestionChoiceUpdateInputs**| | |
|
|
1070
1073
|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
1071
1074
|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
1072
1075
|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
|
|
1073
|
-
| **choice** | **SurveyQuestionChoiceUpdateInputs** | Filter by choice | defaults to undefined|
|
|
1074
1076
|
|
|
1075
1077
|
|
|
1076
1078
|
### Return type
|
|
@@ -1083,7 +1085,7 @@ const { status, data } = await apiInstance.updateSurveyQuestionChoice(
|
|
|
1083
1085
|
|
|
1084
1086
|
### HTTP request headers
|
|
1085
1087
|
|
|
1086
|
-
- **Content-Type**:
|
|
1088
|
+
- **Content-Type**: application/json
|
|
1087
1089
|
- **Accept**: application/json
|
|
1088
1090
|
|
|
1089
1091
|
|
|
@@ -1095,7 +1097,7 @@ const { status, data } = await apiInstance.updateSurveyQuestionChoice(
|
|
|
1095
1097
|
[[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)
|
|
1096
1098
|
|
|
1097
1099
|
# **updateSurveyQuestionChoiceSubQuestion**
|
|
1098
|
-
> CreateSurveyQuestionChoice200Response updateSurveyQuestionChoiceSubQuestion()
|
|
1100
|
+
> CreateSurveyQuestionChoice200Response updateSurveyQuestionChoiceSubQuestion(updateEventFollowupQuestionRequest)
|
|
1099
1101
|
|
|
1100
1102
|
Changes the sort order of a sub-question linked to a survey question choice, shifting the other sub-questions attached to that choice to keep ordering consistent; requires the update surveys permission.
|
|
1101
1103
|
|
|
@@ -1104,7 +1106,8 @@ Changes the sort order of a sub-question linked to a survey question choice, shi
|
|
|
1104
1106
|
```typescript
|
|
1105
1107
|
import {
|
|
1106
1108
|
SurveysQuestionsApi,
|
|
1107
|
-
Configuration
|
|
1109
|
+
Configuration,
|
|
1110
|
+
UpdateEventFollowupQuestionRequest
|
|
1108
1111
|
} from '@connectedxm/admin-sdk';
|
|
1109
1112
|
|
|
1110
1113
|
const configuration = new Configuration();
|
|
@@ -1114,14 +1117,14 @@ let surveyId: string; //The survey identifier (default to undefined)
|
|
|
1114
1117
|
let questionId: string; //The question identifier (default to undefined)
|
|
1115
1118
|
let choiceId: string; //The choice identifier (default to undefined)
|
|
1116
1119
|
let subQuestionId: string; //The subQuestion identifier (default to undefined)
|
|
1117
|
-
let
|
|
1120
|
+
let updateEventFollowupQuestionRequest: UpdateEventFollowupQuestionRequest; //
|
|
1118
1121
|
|
|
1119
1122
|
const { status, data } = await apiInstance.updateSurveyQuestionChoiceSubQuestion(
|
|
1120
1123
|
surveyId,
|
|
1121
1124
|
questionId,
|
|
1122
1125
|
choiceId,
|
|
1123
1126
|
subQuestionId,
|
|
1124
|
-
|
|
1127
|
+
updateEventFollowupQuestionRequest
|
|
1125
1128
|
);
|
|
1126
1129
|
```
|
|
1127
1130
|
|
|
@@ -1129,11 +1132,11 @@ const { status, data } = await apiInstance.updateSurveyQuestionChoiceSubQuestion
|
|
|
1129
1132
|
|
|
1130
1133
|
|Name | Type | Description | Notes|
|
|
1131
1134
|
|------------- | ------------- | ------------- | -------------|
|
|
1135
|
+
| **updateEventFollowupQuestionRequest** | **UpdateEventFollowupQuestionRequest**| | |
|
|
1132
1136
|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
1133
1137
|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
1134
1138
|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
|
|
1135
1139
|
| **subQuestionId** | [**string**] | The subQuestion identifier | defaults to undefined|
|
|
1136
|
-
| **sortOrder** | [**number**] | Filter by sortOrder | defaults to undefined|
|
|
1137
1140
|
|
|
1138
1141
|
|
|
1139
1142
|
### Return type
|
|
@@ -1146,7 +1149,7 @@ const { status, data } = await apiInstance.updateSurveyQuestionChoiceSubQuestion
|
|
|
1146
1149
|
|
|
1147
1150
|
### HTTP request headers
|
|
1148
1151
|
|
|
1149
|
-
- **Content-Type**:
|
|
1152
|
+
- **Content-Type**: application/json
|
|
1150
1153
|
- **Accept**: application/json
|
|
1151
1154
|
|
|
1152
1155
|
|