@connectedxm/admin-sdk 7.9.3 → 7.9.5
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 +6 -0
- package/AdminApi.ts +3 -0
- package/README.md +9 -0
- package/api.ts +538 -0
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +296 -0
- package/dist/api.js +407 -26
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +296 -0
- package/dist/esm/api.js +377 -0
- package/docs/BaseBookingQuestionResponseChange.md +32 -0
- package/docs/BasePassAddOn.md +2 -0
- package/docs/BookingQuestionResponse.md +2 -0
- package/docs/BookingQuestionResponseChange.md +36 -0
- package/docs/BookingsResponsesApi.md +136 -0
- package/docs/EventsPassesAddonsApi.md +116 -0
- package/docs/FulfillEventPassAddOn200Response.md +24 -0
- package/docs/GetBookingResponseChanges200Response.md +26 -0
- package/docs/PassAddOn.md +2 -0
- package/docs/UpdateBookingResponsesInputs.md +20 -0
- package/package.json +1 -1
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
# BookingsResponsesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getBookingResponseChanges**](#getbookingresponsechanges) | **GET** /bookings/{bookingId}/responses/{questionId}/changes | List a booking response\'s edit history|
|
|
8
|
+
|[**updateBookingResponses**](#updatebookingresponses) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/responses | Update a booking\'s question responses|
|
|
9
|
+
|
|
10
|
+
# **getBookingResponseChanges**
|
|
11
|
+
> GetBookingResponseChanges200Response getBookingResponseChanges()
|
|
12
|
+
|
|
13
|
+
Returns a paginated list of edits made to a single question response on a booking, including the old and new values for each change; requires the \"read\" permission on \"bookings\".
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
BookingsResponsesApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@connectedxm/admin-sdk';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new BookingsResponsesApi(configuration);
|
|
25
|
+
|
|
26
|
+
let bookingId: string; //The booking identifier (default to undefined)
|
|
27
|
+
let questionId: string; //The question identifier (default to undefined)
|
|
28
|
+
let page: number; //Page number (optional) (default to 1)
|
|
29
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
30
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
31
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.getBookingResponseChanges(
|
|
34
|
+
bookingId,
|
|
35
|
+
questionId,
|
|
36
|
+
page,
|
|
37
|
+
pageSize,
|
|
38
|
+
orderBy,
|
|
39
|
+
search
|
|
40
|
+
);
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
|Name | Type | Description | Notes|
|
|
46
|
+
|------------- | ------------- | ------------- | -------------|
|
|
47
|
+
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|
|
|
48
|
+
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
49
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
50
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
51
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
52
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
**GetBookingResponseChanges200Response**
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: Not defined
|
|
66
|
+
- **Accept**: application/json
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### HTTP response details
|
|
70
|
+
| Status code | Description | Response headers |
|
|
71
|
+
|-------------|-------------|------------------|
|
|
72
|
+
|**200** | Successful response | - |
|
|
73
|
+
|
|
74
|
+
[[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)
|
|
75
|
+
|
|
76
|
+
# **updateBookingResponses**
|
|
77
|
+
> CreateAccountInvitations200Response updateBookingResponses(updateBookingResponsesInputs)
|
|
78
|
+
|
|
79
|
+
Bulk-updates the answers submitted to a booking space\'s custom questions for a specific booking, requires read and update permission on bookings.
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
import {
|
|
85
|
+
BookingsResponsesApi,
|
|
86
|
+
Configuration,
|
|
87
|
+
UpdateBookingResponsesInputs
|
|
88
|
+
} from '@connectedxm/admin-sdk';
|
|
89
|
+
|
|
90
|
+
const configuration = new Configuration();
|
|
91
|
+
const apiInstance = new BookingsResponsesApi(configuration);
|
|
92
|
+
|
|
93
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
94
|
+
let spaceId: string; //The space identifier (default to undefined)
|
|
95
|
+
let bookingId: string; //The booking identifier (default to undefined)
|
|
96
|
+
let updateBookingResponsesInputs: UpdateBookingResponsesInputs; //
|
|
97
|
+
|
|
98
|
+
const { status, data } = await apiInstance.updateBookingResponses(
|
|
99
|
+
placeId,
|
|
100
|
+
spaceId,
|
|
101
|
+
bookingId,
|
|
102
|
+
updateBookingResponsesInputs
|
|
103
|
+
);
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Parameters
|
|
107
|
+
|
|
108
|
+
|Name | Type | Description | Notes|
|
|
109
|
+
|------------- | ------------- | ------------- | -------------|
|
|
110
|
+
| **updateBookingResponsesInputs** | **UpdateBookingResponsesInputs**| | |
|
|
111
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
112
|
+
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
113
|
+
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
### Return type
|
|
117
|
+
|
|
118
|
+
**CreateAccountInvitations200Response**
|
|
119
|
+
|
|
120
|
+
### Authorization
|
|
121
|
+
|
|
122
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
123
|
+
|
|
124
|
+
### HTTP request headers
|
|
125
|
+
|
|
126
|
+
- **Content-Type**: application/json
|
|
127
|
+
- **Accept**: application/json
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
### HTTP response details
|
|
131
|
+
| Status code | Description | Response headers |
|
|
132
|
+
|-------------|-------------|------------------|
|
|
133
|
+
|**200** | Successful response | - |
|
|
134
|
+
|
|
135
|
+
[[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)
|
|
136
|
+
|
|
@@ -5,8 +5,10 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add an add-on to an attendee\'s pass|
|
|
8
|
+
|[**fulfillEventPassAddOn**](#fulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/fulfill | Fulfill an add-on on an attendee\'s pass|
|
|
8
9
|
|[**getEventPassAddOns**](#geteventpassaddons) | **GET** /events/{eventId}/passes/{passId}/addOns | List an event pass\'s add-ons|
|
|
9
10
|
|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove an add-on from an attendee\'s pass|
|
|
11
|
+
|[**unfulfillEventPassAddOn**](#unfulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/undo | Undo an add-on fulfillment|
|
|
10
12
|
|
|
11
13
|
# **addEventPassAddOn**
|
|
12
14
|
> CreateEventPass200Response addEventPassAddOn()
|
|
@@ -58,6 +60,63 @@ const { status, data } = await apiInstance.addEventPassAddOn(
|
|
|
58
60
|
- **Accept**: application/json
|
|
59
61
|
|
|
60
62
|
|
|
63
|
+
### HTTP response details
|
|
64
|
+
| Status code | Description | Response headers |
|
|
65
|
+
|-------------|-------------|------------------|
|
|
66
|
+
|**200** | Successful response | - |
|
|
67
|
+
|
|
68
|
+
[[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)
|
|
69
|
+
|
|
70
|
+
# **fulfillEventPassAddOn**
|
|
71
|
+
> FulfillEventPassAddOn200Response fulfillEventPassAddOn()
|
|
72
|
+
|
|
73
|
+
Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
EventsPassesAddonsApi,
|
|
80
|
+
Configuration
|
|
81
|
+
} from '@connectedxm/admin-sdk';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new EventsPassesAddonsApi(configuration);
|
|
85
|
+
|
|
86
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
87
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
88
|
+
let addOnId: string; //The addOn identifier (default to undefined)
|
|
89
|
+
|
|
90
|
+
const { status, data } = await apiInstance.fulfillEventPassAddOn(
|
|
91
|
+
eventId,
|
|
92
|
+
passId,
|
|
93
|
+
addOnId
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|Name | Type | Description | Notes|
|
|
100
|
+
|------------- | ------------- | ------------- | -------------|
|
|
101
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
102
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
103
|
+
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
**FulfillEventPassAddOn200Response**
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: Not defined
|
|
117
|
+
- **Accept**: application/json
|
|
118
|
+
|
|
119
|
+
|
|
61
120
|
### HTTP response details
|
|
62
121
|
| Status code | Description | Response headers |
|
|
63
122
|
|-------------|-------------|------------------|
|
|
@@ -188,3 +247,60 @@ const { status, data } = await apiInstance.removeEventPassAddOn(
|
|
|
188
247
|
|
|
189
248
|
[[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)
|
|
190
249
|
|
|
250
|
+
# **unfulfillEventPassAddOn**
|
|
251
|
+
> FulfillEventPassAddOn200Response unfulfillEventPassAddOn()
|
|
252
|
+
|
|
253
|
+
Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.
|
|
254
|
+
|
|
255
|
+
### Example
|
|
256
|
+
|
|
257
|
+
```typescript
|
|
258
|
+
import {
|
|
259
|
+
EventsPassesAddonsApi,
|
|
260
|
+
Configuration
|
|
261
|
+
} from '@connectedxm/admin-sdk';
|
|
262
|
+
|
|
263
|
+
const configuration = new Configuration();
|
|
264
|
+
const apiInstance = new EventsPassesAddonsApi(configuration);
|
|
265
|
+
|
|
266
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
267
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
268
|
+
let addOnId: string; //The addOn identifier (default to undefined)
|
|
269
|
+
|
|
270
|
+
const { status, data } = await apiInstance.unfulfillEventPassAddOn(
|
|
271
|
+
eventId,
|
|
272
|
+
passId,
|
|
273
|
+
addOnId
|
|
274
|
+
);
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### Parameters
|
|
278
|
+
|
|
279
|
+
|Name | Type | Description | Notes|
|
|
280
|
+
|------------- | ------------- | ------------- | -------------|
|
|
281
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
282
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
283
|
+
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
### Return type
|
|
287
|
+
|
|
288
|
+
**FulfillEventPassAddOn200Response**
|
|
289
|
+
|
|
290
|
+
### Authorization
|
|
291
|
+
|
|
292
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
293
|
+
|
|
294
|
+
### HTTP request headers
|
|
295
|
+
|
|
296
|
+
- **Content-Type**: Not defined
|
|
297
|
+
- **Accept**: application/json
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
### HTTP response details
|
|
301
|
+
| Status code | Description | Response headers |
|
|
302
|
+
|-------------|-------------|------------------|
|
|
303
|
+
|**200** | Successful response | - |
|
|
304
|
+
|
|
305
|
+
[[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)
|
|
306
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# FulfillEventPassAddOn200Response
|
|
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** | [**PassAddOn**](PassAddOn.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { FulfillEventPassAddOn200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: FulfillEventPassAddOn200Response = {
|
|
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)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetBookingResponseChanges200Response
|
|
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** | [**Array<BookingQuestionResponseChange>**](BookingQuestionResponseChange.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetBookingResponseChanges200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetBookingResponseChanges200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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/PassAddOn.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**addOnId** | **string** | | [default to undefined]
|
|
9
9
|
**addOn** | [**BaseEventAddOn**](BaseEventAddOn.md) | | [default to undefined]
|
|
10
|
+
**fulfilledAt** | **string** | | [default to undefined]
|
|
10
11
|
**createdAt** | **string** | | [default to undefined]
|
|
11
12
|
**pass** | [**BaseEventPass**](BaseEventPass.md) | | [default to undefined]
|
|
12
13
|
**updatedAt** | **string** | | [default to undefined]
|
|
@@ -19,6 +20,7 @@ import { PassAddOn } from '@connectedxm/admin-sdk';
|
|
|
19
20
|
const instance: PassAddOn = {
|
|
20
21
|
addOnId,
|
|
21
22
|
addOn,
|
|
23
|
+
fulfilledAt,
|
|
22
24
|
createdAt,
|
|
23
25
|
pass,
|
|
24
26
|
updatedAt,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdateBookingResponsesInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**questions** | [**Array<Question>**](Question.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateBookingResponsesInputs } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateBookingResponsesInputs = {
|
|
16
|
+
questions,
|
|
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)
|