@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
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 8.
|
|
5
|
+
* The version of the OpenAPI document: 8.2.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 8.
|
|
7
|
+
* The version of the OpenAPI document: 8.2.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 8.
|
|
5
|
+
* The version of the OpenAPI document: 8.2.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 8.
|
|
7
|
+
* The version of the OpenAPI document: 8.2.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 8.
|
|
5
|
+
* The version of the OpenAPI document: 8.2.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 8.
|
|
6
|
+
* The version of the OpenAPI document: 8.2.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/APILog.md
CHANGED
|
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
11
11
|
**user** | [**BaseUser**](BaseUser.md) | | [default to undefined]
|
|
12
12
|
**source** | **string** | | [default to undefined]
|
|
13
|
+
**clientSource** | **string** | | [default to undefined]
|
|
14
|
+
**clientVersion** | **string** | | [default to undefined]
|
|
13
15
|
**status** | **string** | | [default to undefined]
|
|
14
16
|
**statusCode** | **number** | | [default to undefined]
|
|
15
17
|
**response** | **string** | | [default to undefined]
|
|
@@ -45,6 +47,8 @@ const instance: APILog = {
|
|
|
45
47
|
account,
|
|
46
48
|
user,
|
|
47
49
|
source,
|
|
50
|
+
clientSource,
|
|
51
|
+
clientVersion,
|
|
48
52
|
status,
|
|
49
53
|
statusCode,
|
|
50
54
|
response,
|
package/docs/ActivitiesApi.md
CHANGED
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.archiveActivity(
|
|
|
66
66
|
[[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)
|
|
67
67
|
|
|
68
68
|
# **createActivity**
|
|
69
|
-
> CreateActivity200Response createActivity()
|
|
69
|
+
> CreateActivity200Response createActivity(createActivityRequest)
|
|
70
70
|
|
|
71
71
|
Creates a new activity feed post authored by the given account, optionally attaching an image via a base64 data URI; requires create permission on activities.
|
|
72
72
|
|
|
@@ -76,20 +76,16 @@ Creates a new activity feed post authored by the given account, optionally attac
|
|
|
76
76
|
import {
|
|
77
77
|
ActivitiesApi,
|
|
78
78
|
Configuration,
|
|
79
|
-
|
|
79
|
+
CreateActivityRequest
|
|
80
80
|
} from '@connectedxm/admin-sdk';
|
|
81
81
|
|
|
82
82
|
const configuration = new Configuration();
|
|
83
83
|
const apiInstance = new ActivitiesApi(configuration);
|
|
84
84
|
|
|
85
|
-
let
|
|
86
|
-
let activity: ActivityCreateInputs; //Filter by activity (default to undefined)
|
|
87
|
-
let imageDataUri: string; //Filter by imageDataUri (optional) (default to undefined)
|
|
85
|
+
let createActivityRequest: CreateActivityRequest; //
|
|
88
86
|
|
|
89
87
|
const { status, data } = await apiInstance.createActivity(
|
|
90
|
-
|
|
91
|
-
activity,
|
|
92
|
-
imageDataUri
|
|
88
|
+
createActivityRequest
|
|
93
89
|
);
|
|
94
90
|
```
|
|
95
91
|
|
|
@@ -97,9 +93,7 @@ const { status, data } = await apiInstance.createActivity(
|
|
|
97
93
|
|
|
98
94
|
|Name | Type | Description | Notes|
|
|
99
95
|
|------------- | ------------- | ------------- | -------------|
|
|
100
|
-
| **
|
|
101
|
-
| **activity** | **ActivityCreateInputs** | Filter by activity | defaults to undefined|
|
|
102
|
-
| **imageDataUri** | [**string**] | Filter by imageDataUri | (optional) defaults to undefined|
|
|
96
|
+
| **createActivityRequest** | **CreateActivityRequest**| | |
|
|
103
97
|
|
|
104
98
|
|
|
105
99
|
### Return type
|
|
@@ -112,7 +106,7 @@ const { status, data } = await apiInstance.createActivity(
|
|
|
112
106
|
|
|
113
107
|
### HTTP request headers
|
|
114
108
|
|
|
115
|
-
- **Content-Type**:
|
|
109
|
+
- **Content-Type**: application/json
|
|
116
110
|
- **Accept**: application/json
|
|
117
111
|
|
|
118
112
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AddChannelSubscriberRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**accountId** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AddChannelSubscriberRequest } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: AddChannelSubscriberRequest = {
|
|
16
|
+
accountId,
|
|
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)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AddCustomReportUserRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**userId** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AddCustomReportUserRequest } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: AddCustomReportUserRequest = {
|
|
16
|
+
userId,
|
|
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)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AddEventAccessUserRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { AddEventAccessUserRequest } from '@connectedxm/admin-sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: AddEventAccessUserRequest = {
|
|
16
16
|
email,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AddEventAddOnTierRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**allowed** | **boolean** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AddEventAddOnTierRequest } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: AddEventAddOnTierRequest = {
|
|
16
|
+
allowed,
|
|
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)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AddRoomToRoomTypeRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**roomId** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AddRoomToRoomTypeRequest } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: AddRoomToRoomTypeRequest = {
|
|
16
|
+
roomId,
|
|
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)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ApproveEventPassRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**sendEmail** | **boolean** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ApproveEventPassRequest } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: ApproveEventPassRequest = {
|
|
16
|
+
sendEmail,
|
|
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/BaseAPILog.md
CHANGED
|
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
11
11
|
**user** | [**BaseUser**](BaseUser.md) | | [default to undefined]
|
|
12
12
|
**source** | **string** | | [default to undefined]
|
|
13
|
+
**clientSource** | **string** | | [default to undefined]
|
|
14
|
+
**clientVersion** | **string** | | [default to undefined]
|
|
13
15
|
**status** | **string** | | [default to undefined]
|
|
14
16
|
**statusCode** | **number** | | [default to undefined]
|
|
15
17
|
**response** | **string** | | [default to undefined]
|
|
@@ -31,6 +33,8 @@ const instance: BaseAPILog = {
|
|
|
31
33
|
account,
|
|
32
34
|
user,
|
|
33
35
|
source,
|
|
36
|
+
clientSource,
|
|
37
|
+
clientVersion,
|
|
34
38
|
status,
|
|
35
39
|
statusCode,
|
|
36
40
|
response,
|
package/docs/BenefitsApi.md
CHANGED
|
@@ -292,7 +292,7 @@ const { status, data } = await apiInstance.getBenefits(
|
|
|
292
292
|
[[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)
|
|
293
293
|
|
|
294
294
|
# **updateBenefit**
|
|
295
|
-
> CreateBenefit200Response updateBenefit()
|
|
295
|
+
> CreateBenefit200Response updateBenefit(benefitTranslationUpdateInputs)
|
|
296
296
|
|
|
297
297
|
Updates the fields of the benefit identified by benefitId, requiring the \"update\" permission on benefits, and returns the updated benefit.
|
|
298
298
|
|
|
@@ -309,11 +309,11 @@ const configuration = new Configuration();
|
|
|
309
309
|
const apiInstance = new BenefitsApi(configuration);
|
|
310
310
|
|
|
311
311
|
let benefitId: string; //The benefit identifier (default to undefined)
|
|
312
|
-
let
|
|
312
|
+
let benefitTranslationUpdateInputs: BenefitTranslationUpdateInputs; //
|
|
313
313
|
|
|
314
314
|
const { status, data } = await apiInstance.updateBenefit(
|
|
315
315
|
benefitId,
|
|
316
|
-
|
|
316
|
+
benefitTranslationUpdateInputs
|
|
317
317
|
);
|
|
318
318
|
```
|
|
319
319
|
|
|
@@ -321,8 +321,8 @@ const { status, data } = await apiInstance.updateBenefit(
|
|
|
321
321
|
|
|
322
322
|
|Name | Type | Description | Notes|
|
|
323
323
|
|------------- | ------------- | ------------- | -------------|
|
|
324
|
+
| **benefitTranslationUpdateInputs** | **BenefitTranslationUpdateInputs**| | |
|
|
324
325
|
| **benefitId** | [**string**] | The benefit identifier | defaults to undefined|
|
|
325
|
-
| **benefit** | **BenefitTranslationUpdateInputs** | Filter by benefit | defaults to undefined|
|
|
326
326
|
|
|
327
327
|
|
|
328
328
|
### Return type
|
|
@@ -335,7 +335,7 @@ const { status, data } = await apiInstance.updateBenefit(
|
|
|
335
335
|
|
|
336
336
|
### HTTP request headers
|
|
337
337
|
|
|
338
|
-
- **Content-Type**:
|
|
338
|
+
- **Content-Type**: application/json
|
|
339
339
|
- **Accept**: application/json
|
|
340
340
|
|
|
341
341
|
|
|
@@ -124,7 +124,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceAvailability(
|
|
|
124
124
|
[[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)
|
|
125
125
|
|
|
126
126
|
# **updateBookingSpaceAvailability**
|
|
127
|
-
> CreateBookingSpaceAvailability200Response updateBookingSpaceAvailability()
|
|
127
|
+
> CreateBookingSpaceAvailability200Response updateBookingSpaceAvailability(bookingSpaceAvailabilityUpdateInputs)
|
|
128
128
|
|
|
129
129
|
Updates the day of week, start time, or end time of the availability window identified by availabilityId on the given booking space, requiring the \"update\" permission on bookings, and fails if the change conflicts with another existing availability.
|
|
130
130
|
|
|
@@ -143,13 +143,13 @@ const apiInstance = new BookingsAvailabilitiesApi(configuration);
|
|
|
143
143
|
let placeId: string; //The place identifier (default to undefined)
|
|
144
144
|
let spaceId: string; //The space identifier (default to undefined)
|
|
145
145
|
let availabilityId: string; //The availability identifier (default to undefined)
|
|
146
|
-
let
|
|
146
|
+
let bookingSpaceAvailabilityUpdateInputs: BookingSpaceAvailabilityUpdateInputs; //
|
|
147
147
|
|
|
148
148
|
const { status, data } = await apiInstance.updateBookingSpaceAvailability(
|
|
149
149
|
placeId,
|
|
150
150
|
spaceId,
|
|
151
151
|
availabilityId,
|
|
152
|
-
|
|
152
|
+
bookingSpaceAvailabilityUpdateInputs
|
|
153
153
|
);
|
|
154
154
|
```
|
|
155
155
|
|
|
@@ -157,10 +157,10 @@ const { status, data } = await apiInstance.updateBookingSpaceAvailability(
|
|
|
157
157
|
|
|
158
158
|
|Name | Type | Description | Notes|
|
|
159
159
|
|------------- | ------------- | ------------- | -------------|
|
|
160
|
+
| **bookingSpaceAvailabilityUpdateInputs** | **BookingSpaceAvailabilityUpdateInputs**| | |
|
|
160
161
|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
161
162
|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
162
163
|
| **availabilityId** | [**string**] | The availability identifier | defaults to undefined|
|
|
163
|
-
| **availability** | **BookingSpaceAvailabilityUpdateInputs** | Filter by availability | defaults to undefined|
|
|
164
164
|
|
|
165
165
|
|
|
166
166
|
### Return type
|
|
@@ -173,7 +173,7 @@ const { status, data } = await apiInstance.updateBookingSpaceAvailability(
|
|
|
173
173
|
|
|
174
174
|
### HTTP request headers
|
|
175
175
|
|
|
176
|
-
- **Content-Type**:
|
|
176
|
+
- **Content-Type**: application/json
|
|
177
177
|
- **Accept**: application/json
|
|
178
178
|
|
|
179
179
|
|
|
@@ -124,7 +124,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceBlackout(
|
|
|
124
124
|
[[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)
|
|
125
125
|
|
|
126
126
|
# **updateBookingSpaceBlackout**
|
|
127
|
-
> CreateBookingSpaceBlackout200Response updateBookingSpaceBlackout()
|
|
127
|
+
> CreateBookingSpaceBlackout200Response updateBookingSpaceBlackout(bookingSpaceBlackoutUpdateInputs)
|
|
128
128
|
|
|
129
129
|
Updates the start or end time of the blackout window identified by blackoutId on the given booking space, requiring the \"update\" permission on bookings, and fails if the change overlaps another existing blackout.
|
|
130
130
|
|
|
@@ -143,13 +143,13 @@ const apiInstance = new BookingsBlackoutsApi(configuration);
|
|
|
143
143
|
let placeId: string; //The place identifier (default to undefined)
|
|
144
144
|
let spaceId: string; //The space identifier (default to undefined)
|
|
145
145
|
let blackoutId: string; //The blackout identifier (default to undefined)
|
|
146
|
-
let
|
|
146
|
+
let bookingSpaceBlackoutUpdateInputs: BookingSpaceBlackoutUpdateInputs; //
|
|
147
147
|
|
|
148
148
|
const { status, data } = await apiInstance.updateBookingSpaceBlackout(
|
|
149
149
|
placeId,
|
|
150
150
|
spaceId,
|
|
151
151
|
blackoutId,
|
|
152
|
-
|
|
152
|
+
bookingSpaceBlackoutUpdateInputs
|
|
153
153
|
);
|
|
154
154
|
```
|
|
155
155
|
|
|
@@ -157,10 +157,10 @@ const { status, data } = await apiInstance.updateBookingSpaceBlackout(
|
|
|
157
157
|
|
|
158
158
|
|Name | Type | Description | Notes|
|
|
159
159
|
|------------- | ------------- | ------------- | -------------|
|
|
160
|
+
| **bookingSpaceBlackoutUpdateInputs** | **BookingSpaceBlackoutUpdateInputs**| | |
|
|
160
161
|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
161
162
|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
162
163
|
| **blackoutId** | [**string**] | The blackout identifier | defaults to undefined|
|
|
163
|
-
| **blackout** | **BookingSpaceBlackoutUpdateInputs** | Filter by blackout | defaults to undefined|
|
|
164
164
|
|
|
165
165
|
|
|
166
166
|
### Return type
|
|
@@ -173,7 +173,7 @@ const { status, data } = await apiInstance.updateBookingSpaceBlackout(
|
|
|
173
173
|
|
|
174
174
|
### HTTP request headers
|
|
175
175
|
|
|
176
|
-
- **Content-Type**:
|
|
176
|
+
- **Content-Type**: application/json
|
|
177
177
|
- **Accept**: application/json
|
|
178
178
|
|
|
179
179
|
|
|
@@ -112,7 +112,7 @@ const { status, data } = await apiInstance.deleteBookingPlace(
|
|
|
112
112
|
[[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)
|
|
113
113
|
|
|
114
114
|
# **updateBookingPlace**
|
|
115
|
-
> CreateBookingPlace200Response updateBookingPlace()
|
|
115
|
+
> CreateBookingPlace200Response updateBookingPlace(bookingPlaceUpdateInputs)
|
|
116
116
|
|
|
117
117
|
Updates the details of an existing booking place by its ID, excluding its image and identifying/audit fields, requires the update bookings permission.
|
|
118
118
|
|
|
@@ -129,11 +129,11 @@ const configuration = new Configuration();
|
|
|
129
129
|
const apiInstance = new BookingsPlacesApi(configuration);
|
|
130
130
|
|
|
131
131
|
let placeId: string; //The place identifier (default to undefined)
|
|
132
|
-
let
|
|
132
|
+
let bookingPlaceUpdateInputs: BookingPlaceUpdateInputs; //
|
|
133
133
|
|
|
134
134
|
const { status, data } = await apiInstance.updateBookingPlace(
|
|
135
135
|
placeId,
|
|
136
|
-
|
|
136
|
+
bookingPlaceUpdateInputs
|
|
137
137
|
);
|
|
138
138
|
```
|
|
139
139
|
|
|
@@ -141,8 +141,8 @@ const { status, data } = await apiInstance.updateBookingPlace(
|
|
|
141
141
|
|
|
142
142
|
|Name | Type | Description | Notes|
|
|
143
143
|
|------------- | ------------- | ------------- | -------------|
|
|
144
|
+
| **bookingPlaceUpdateInputs** | **BookingPlaceUpdateInputs**| | |
|
|
144
145
|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
145
|
-
| **bookingPlace** | **BookingPlaceUpdateInputs** | Filter by bookingPlace | defaults to undefined|
|
|
146
146
|
|
|
147
147
|
|
|
148
148
|
### Return type
|
|
@@ -155,7 +155,7 @@ const { status, data } = await apiInstance.updateBookingPlace(
|
|
|
155
155
|
|
|
156
156
|
### HTTP request headers
|
|
157
157
|
|
|
158
|
-
- **Content-Type**:
|
|
158
|
+
- **Content-Type**: application/json
|
|
159
159
|
- **Accept**: application/json
|
|
160
160
|
|
|
161
161
|
|
|
@@ -370,7 +370,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestions(
|
|
|
370
370
|
[[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)
|
|
371
371
|
|
|
372
372
|
# **reorderBookingSpaceQuestions**
|
|
373
|
-
> ReorderBookingSpaceQuestions200Response reorderBookingSpaceQuestions()
|
|
373
|
+
> ReorderBookingSpaceQuestions200Response reorderBookingSpaceQuestions(reorderBookingSpaceQuestionsRequest)
|
|
374
374
|
|
|
375
375
|
Sets the display order of all questions on a booking space by supplying the complete ordered list of question IDs; every existing question must be included or the request is rejected, and requires update permission on bookings.
|
|
376
376
|
|
|
@@ -379,7 +379,8 @@ Sets the display order of all questions on a booking space by supplying the comp
|
|
|
379
379
|
```typescript
|
|
380
380
|
import {
|
|
381
381
|
BookingsQuestionsApi,
|
|
382
|
-
Configuration
|
|
382
|
+
Configuration,
|
|
383
|
+
ReorderBookingSpaceQuestionsRequest
|
|
383
384
|
} from '@connectedxm/admin-sdk';
|
|
384
385
|
|
|
385
386
|
const configuration = new Configuration();
|
|
@@ -387,12 +388,12 @@ const apiInstance = new BookingsQuestionsApi(configuration);
|
|
|
387
388
|
|
|
388
389
|
let placeId: string; //The place identifier (default to undefined)
|
|
389
390
|
let spaceId: string; //The space identifier (default to undefined)
|
|
390
|
-
let
|
|
391
|
+
let reorderBookingSpaceQuestionsRequest: ReorderBookingSpaceQuestionsRequest; //
|
|
391
392
|
|
|
392
393
|
const { status, data } = await apiInstance.reorderBookingSpaceQuestions(
|
|
393
394
|
placeId,
|
|
394
395
|
spaceId,
|
|
395
|
-
|
|
396
|
+
reorderBookingSpaceQuestionsRequest
|
|
396
397
|
);
|
|
397
398
|
```
|
|
398
399
|
|
|
@@ -400,9 +401,9 @@ const { status, data } = await apiInstance.reorderBookingSpaceQuestions(
|
|
|
400
401
|
|
|
401
402
|
|Name | Type | Description | Notes|
|
|
402
403
|
|------------- | ------------- | ------------- | -------------|
|
|
404
|
+
| **reorderBookingSpaceQuestionsRequest** | **ReorderBookingSpaceQuestionsRequest**| | |
|
|
403
405
|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
404
406
|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
405
|
-
| **questionsIds** | **Array<string>** | Filter by questionsIds | defaults to undefined|
|
|
406
407
|
|
|
407
408
|
|
|
408
409
|
### Return type
|
|
@@ -415,7 +416,7 @@ const { status, data } = await apiInstance.reorderBookingSpaceQuestions(
|
|
|
415
416
|
|
|
416
417
|
### HTTP request headers
|
|
417
418
|
|
|
418
|
-
- **Content-Type**:
|
|
419
|
+
- **Content-Type**: application/json
|
|
419
420
|
- **Accept**: application/json
|
|
420
421
|
|
|
421
422
|
|
|
@@ -262,7 +262,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestionChoices(
|
|
|
262
262
|
[[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)
|
|
263
263
|
|
|
264
264
|
# **reorderBookingSpaceQuestionChoices**
|
|
265
|
-
> ReorderBookingSpaceQuestionChoices200Response reorderBookingSpaceQuestionChoices()
|
|
265
|
+
> ReorderBookingSpaceQuestionChoices200Response reorderBookingSpaceQuestionChoices(reorderBookingSpaceQuestionChoicesRequest)
|
|
266
266
|
|
|
267
267
|
Sets the display order of a booking space question\'s choices by supplying the full list of choice IDs in the desired sequence, requires the update bookings permission.
|
|
268
268
|
|
|
@@ -271,7 +271,8 @@ Sets the display order of a booking space question\'s choices by supplying the f
|
|
|
271
271
|
```typescript
|
|
272
272
|
import {
|
|
273
273
|
BookingsQuestionsChoicesApi,
|
|
274
|
-
Configuration
|
|
274
|
+
Configuration,
|
|
275
|
+
ReorderBookingSpaceQuestionChoicesRequest
|
|
275
276
|
} from '@connectedxm/admin-sdk';
|
|
276
277
|
|
|
277
278
|
const configuration = new Configuration();
|
|
@@ -280,13 +281,13 @@ const apiInstance = new BookingsQuestionsChoicesApi(configuration);
|
|
|
280
281
|
let placeId: string; //The place identifier (default to undefined)
|
|
281
282
|
let spaceId: string; //The space identifier (default to undefined)
|
|
282
283
|
let questionId: string; //The question identifier (default to undefined)
|
|
283
|
-
let
|
|
284
|
+
let reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest; //
|
|
284
285
|
|
|
285
286
|
const { status, data } = await apiInstance.reorderBookingSpaceQuestionChoices(
|
|
286
287
|
placeId,
|
|
287
288
|
spaceId,
|
|
288
289
|
questionId,
|
|
289
|
-
|
|
290
|
+
reorderBookingSpaceQuestionChoicesRequest
|
|
290
291
|
);
|
|
291
292
|
```
|
|
292
293
|
|
|
@@ -294,10 +295,10 @@ const { status, data } = await apiInstance.reorderBookingSpaceQuestionChoices(
|
|
|
294
295
|
|
|
295
296
|
|Name | Type | Description | Notes|
|
|
296
297
|
|------------- | ------------- | ------------- | -------------|
|
|
298
|
+
| **reorderBookingSpaceQuestionChoicesRequest** | **ReorderBookingSpaceQuestionChoicesRequest**| | |
|
|
297
299
|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
298
300
|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
299
301
|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
300
|
-
| **choicesIds** | **Array<string>** | Filter by choicesIds | defaults to undefined|
|
|
301
302
|
|
|
302
303
|
|
|
303
304
|
### Return type
|
|
@@ -310,7 +311,7 @@ const { status, data } = await apiInstance.reorderBookingSpaceQuestionChoices(
|
|
|
310
311
|
|
|
311
312
|
### HTTP request headers
|
|
312
313
|
|
|
313
|
-
- **Content-Type**:
|
|
314
|
+
- **Content-Type**: application/json
|
|
314
315
|
- **Accept**: application/json
|
|
315
316
|
|
|
316
317
|
|
|
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.deleteBookingSpace(
|
|
|
118
118
|
[[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)
|
|
119
119
|
|
|
120
120
|
# **updateBookingSpace**
|
|
121
|
-
> CreateBookingSpace200Response updateBookingSpace()
|
|
121
|
+
> CreateBookingSpace200Response updateBookingSpace(bookingSpaceUpdateInputs)
|
|
122
122
|
|
|
123
123
|
Updates the attributes of an existing booking space within a booking place, such as its details and sort order, and requires the update bookings permission.
|
|
124
124
|
|
|
@@ -136,12 +136,12 @@ const apiInstance = new BookingsSpacesApi(configuration);
|
|
|
136
136
|
|
|
137
137
|
let placeId: string; //The place identifier (default to undefined)
|
|
138
138
|
let spaceId: string; //The space identifier (default to undefined)
|
|
139
|
-
let
|
|
139
|
+
let bookingSpaceUpdateInputs: BookingSpaceUpdateInputs; //
|
|
140
140
|
|
|
141
141
|
const { status, data } = await apiInstance.updateBookingSpace(
|
|
142
142
|
placeId,
|
|
143
143
|
spaceId,
|
|
144
|
-
|
|
144
|
+
bookingSpaceUpdateInputs
|
|
145
145
|
);
|
|
146
146
|
```
|
|
147
147
|
|
|
@@ -149,9 +149,9 @@ const { status, data } = await apiInstance.updateBookingSpace(
|
|
|
149
149
|
|
|
150
150
|
|Name | Type | Description | Notes|
|
|
151
151
|
|------------- | ------------- | ------------- | -------------|
|
|
152
|
+
| **bookingSpaceUpdateInputs** | **BookingSpaceUpdateInputs**| | |
|
|
152
153
|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
153
154
|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
154
|
-
| **bookingSpace** | **BookingSpaceUpdateInputs** | Filter by bookingSpace | defaults to undefined|
|
|
155
155
|
|
|
156
156
|
|
|
157
157
|
### Return type
|
|
@@ -164,7 +164,7 @@ const { status, data } = await apiInstance.updateBookingSpace(
|
|
|
164
164
|
|
|
165
165
|
### HTTP request headers
|
|
166
166
|
|
|
167
|
-
- **Content-Type**:
|
|
167
|
+
- **Content-Type**: application/json
|
|
168
168
|
- **Accept**: application/json
|
|
169
169
|
|
|
170
170
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# BulkUploadSearchListValuesRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**values** | **Array<string>** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { BulkUploadSearchListValuesRequest } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: BulkUploadSearchListValuesRequest = {
|
|
16
|
+
values,
|
|
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)
|