@connectedxm/admin-sdk 7.2.0 → 7.2.2
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/README.md +2 -0
- package/api.ts +222 -0
- package/dist/api.d.ts +120 -0
- package/dist/api.js +160 -0
- package/dist/esm/api.d.ts +120 -0
- package/dist/esm/api.js +160 -0
- package/docs/BaseBooking.md +2 -0
- package/docs/Booking.md +2 -0
- package/docs/BookingSpace.md +6 -0
- package/docs/BookingSpaceCreateInputs.md +6 -0
- package/docs/BookingSpaceTranslation.md +2 -0
- package/docs/BookingSpaceTranslationUpdateInputs.md +2 -0
- package/docs/BookingSpaceUpdateInputs.md +6 -0
- package/docs/BookingsApi.md +116 -0
- package/docs/NotificationPreferences.md +2 -0
- package/package.json +1 -1
package/docs/BaseBooking.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**day** | **string** | | [default to undefined]
|
|
12
12
|
**time** | **string** | | [default to undefined]
|
|
13
13
|
**duration** | **number** | | [default to undefined]
|
|
14
|
+
**checkedIn** | **string** | | [default to undefined]
|
|
14
15
|
**status** | [**PurchaseStatus**](PurchaseStatus.md) | | [default to undefined]
|
|
15
16
|
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
16
17
|
**space** | [**BaseBookingSpace**](BaseBookingSpace.md) | | [default to undefined]
|
|
@@ -27,6 +28,7 @@ const instance: BaseBooking = {
|
|
|
27
28
|
day,
|
|
28
29
|
time,
|
|
29
30
|
duration,
|
|
31
|
+
checkedIn,
|
|
30
32
|
status,
|
|
31
33
|
account,
|
|
32
34
|
space,
|
package/docs/Booking.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**day** | **string** | | [default to undefined]
|
|
12
12
|
**time** | **string** | | [default to undefined]
|
|
13
13
|
**duration** | **number** | | [default to undefined]
|
|
14
|
+
**checkedIn** | **string** | | [default to undefined]
|
|
14
15
|
**status** | [**PurchaseStatus**](PurchaseStatus.md) | | [default to undefined]
|
|
15
16
|
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
16
17
|
**space** | [**BaseBookingSpace**](BaseBookingSpace.md) | | [default to undefined]
|
|
@@ -31,6 +32,7 @@ const instance: Booking = {
|
|
|
31
32
|
day,
|
|
32
33
|
time,
|
|
33
34
|
duration,
|
|
35
|
+
checkedIn,
|
|
34
36
|
status,
|
|
35
37
|
account,
|
|
36
38
|
space,
|
package/docs/BookingSpace.md
CHANGED
|
@@ -24,6 +24,9 @@ Name | Type | Description | Notes
|
|
|
24
24
|
**confirmationReplyTo** | **string** | | [default to undefined]
|
|
25
25
|
**cancellationBody** | **string** | | [default to undefined]
|
|
26
26
|
**cancellationReplyTo** | **string** | | [default to undefined]
|
|
27
|
+
**reminderBody** | **string** | | [default to undefined]
|
|
28
|
+
**reminderReplyTo** | **string** | | [default to undefined]
|
|
29
|
+
**reminderEnabled** | **boolean** | | [default to undefined]
|
|
27
30
|
**meetingId** | **string** | | [default to undefined]
|
|
28
31
|
**meeting** | [**BaseMeeting**](BaseMeeting.md) | | [default to undefined]
|
|
29
32
|
**joinBeforeTime** | **number** | | [default to undefined]
|
|
@@ -56,6 +59,9 @@ const instance: BookingSpace = {
|
|
|
56
59
|
confirmationReplyTo,
|
|
57
60
|
cancellationBody,
|
|
58
61
|
cancellationReplyTo,
|
|
62
|
+
reminderBody,
|
|
63
|
+
reminderReplyTo,
|
|
64
|
+
reminderEnabled,
|
|
59
65
|
meetingId,
|
|
60
66
|
meeting,
|
|
61
67
|
joinBeforeTime,
|
|
@@ -19,6 +19,9 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**confirmationReplyTo** | **string** | | [optional] [default to undefined]
|
|
20
20
|
**cancellationBody** | **string** | | [optional] [default to undefined]
|
|
21
21
|
**cancellationReplyTo** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**reminderBody** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**reminderReplyTo** | **string** | | [optional] [default to undefined]
|
|
24
|
+
**reminderEnabled** | **boolean** | | [optional] [default to undefined]
|
|
22
25
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
23
26
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
24
27
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
@@ -45,6 +48,9 @@ const instance: BookingSpaceCreateInputs = {
|
|
|
45
48
|
confirmationReplyTo,
|
|
46
49
|
cancellationBody,
|
|
47
50
|
cancellationReplyTo,
|
|
51
|
+
reminderBody,
|
|
52
|
+
reminderReplyTo,
|
|
53
|
+
reminderEnabled,
|
|
48
54
|
taxCode,
|
|
49
55
|
taxIncluded,
|
|
50
56
|
taxLocation,
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**description** | **string** | | [default to undefined]
|
|
12
12
|
**confirmationBody** | **string** | | [default to undefined]
|
|
13
13
|
**cancellationBody** | **string** | | [default to undefined]
|
|
14
|
+
**reminderBody** | **string** | | [default to undefined]
|
|
14
15
|
**createdAt** | **string** | | [default to undefined]
|
|
15
16
|
**updatedAt** | **string** | | [default to undefined]
|
|
16
17
|
|
|
@@ -26,6 +27,7 @@ const instance: BookingSpaceTranslation = {
|
|
|
26
27
|
description,
|
|
27
28
|
confirmationBody,
|
|
28
29
|
cancellationBody,
|
|
30
|
+
reminderBody,
|
|
29
31
|
createdAt,
|
|
30
32
|
updatedAt,
|
|
31
33
|
};
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**confirmationBody** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**cancellationBody** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**reminderBody** | **string** | | [optional] [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,6 +21,7 @@ const instance: BookingSpaceTranslationUpdateInputs = {
|
|
|
20
21
|
description,
|
|
21
22
|
confirmationBody,
|
|
22
23
|
cancellationBody,
|
|
24
|
+
reminderBody,
|
|
23
25
|
};
|
|
24
26
|
```
|
|
25
27
|
|
|
@@ -18,6 +18,9 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**confirmationReplyTo** | **string** | | [optional] [default to undefined]
|
|
19
19
|
**cancellationBody** | **string** | | [optional] [default to undefined]
|
|
20
20
|
**cancellationReplyTo** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**reminderBody** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**reminderReplyTo** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**reminderEnabled** | **boolean** | | [optional] [default to undefined]
|
|
21
24
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
22
25
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
23
26
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
@@ -43,6 +46,9 @@ const instance: BookingSpaceUpdateInputs = {
|
|
|
43
46
|
confirmationReplyTo,
|
|
44
47
|
cancellationBody,
|
|
45
48
|
cancellationReplyTo,
|
|
49
|
+
reminderBody,
|
|
50
|
+
reminderReplyTo,
|
|
51
|
+
reminderEnabled,
|
|
46
52
|
taxCode,
|
|
47
53
|
taxIncluded,
|
|
48
54
|
taxLocation,
|
package/docs/BookingsApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**addBookingSpaceTier**](#addbookingspacetier) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/tiers/{tierId} | Add Booking Space Tier|
|
|
8
8
|
|[**cancelBooking**](#cancelbooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/cancel | Cancel Booking|
|
|
9
|
+
|[**checkInBooking**](#checkinbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/checkin | Check In Booking|
|
|
9
10
|
|[**createBooking**](#createbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings | Create Booking|
|
|
10
11
|
|[**deleteBooking**](#deletebooking) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Delete Booking|
|
|
11
12
|
|[**getBooking**](#getbooking) | **GET** /bookings/{bookingId} | Get Booking|
|
|
@@ -29,6 +30,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
29
30
|
|[**getBookingSpaceTranslations**](#getbookingspacetranslations) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/translations | Get Booking Space Translations|
|
|
30
31
|
|[**getBookingSpaces**](#getbookingspaces) | **GET** /bookings/places/{placeId}/spaces | Get Booking Spaces|
|
|
31
32
|
|[**removeBookingSpaceTier**](#removebookingspacetier) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/tiers/{tierId} | Remove Booking Space Tier|
|
|
33
|
+
|[**undoCheckInBooking**](#undocheckinbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/checkin/undo | Undo Check In Booking|
|
|
32
34
|
|[**updateBooking**](#updatebooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Update Booking|
|
|
33
35
|
|
|
34
36
|
# **addBookingSpaceTier**
|
|
@@ -124,6 +126,63 @@ const { status, data } = await apiInstance.cancelBooking(
|
|
|
124
126
|
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|
|
|
125
127
|
|
|
126
128
|
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
**CreateBooking200Response**
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: Not defined
|
|
140
|
+
- **Accept**: application/json
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
### HTTP response details
|
|
144
|
+
| Status code | Description | Response headers |
|
|
145
|
+
|-------------|-------------|------------------|
|
|
146
|
+
|**200** | Successful response | - |
|
|
147
|
+
|
|
148
|
+
[[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)
|
|
149
|
+
|
|
150
|
+
# **checkInBooking**
|
|
151
|
+
> CreateBooking200Response checkInBooking()
|
|
152
|
+
|
|
153
|
+
Check In Booking endpoint
|
|
154
|
+
|
|
155
|
+
### Example
|
|
156
|
+
|
|
157
|
+
```typescript
|
|
158
|
+
import {
|
|
159
|
+
BookingsApi,
|
|
160
|
+
Configuration
|
|
161
|
+
} from '@connectedxm/admin-sdk';
|
|
162
|
+
|
|
163
|
+
const configuration = new Configuration();
|
|
164
|
+
const apiInstance = new BookingsApi(configuration);
|
|
165
|
+
|
|
166
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
167
|
+
let spaceId: string; //The space identifier (default to undefined)
|
|
168
|
+
let bookingId: string; //The booking identifier (default to undefined)
|
|
169
|
+
|
|
170
|
+
const { status, data } = await apiInstance.checkInBooking(
|
|
171
|
+
placeId,
|
|
172
|
+
spaceId,
|
|
173
|
+
bookingId
|
|
174
|
+
);
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
|Name | Type | Description | Notes|
|
|
180
|
+
|------------- | ------------- | ------------- | -------------|
|
|
181
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
182
|
+
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
183
|
+
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|
|
|
184
|
+
|
|
185
|
+
|
|
127
186
|
### Return type
|
|
128
187
|
|
|
129
188
|
**CreateBooking200Response**
|
|
@@ -1516,6 +1575,63 @@ const { status, data } = await apiInstance.removeBookingSpaceTier(
|
|
|
1516
1575
|
- **Accept**: application/json
|
|
1517
1576
|
|
|
1518
1577
|
|
|
1578
|
+
### HTTP response details
|
|
1579
|
+
| Status code | Description | Response headers |
|
|
1580
|
+
|-------------|-------------|------------------|
|
|
1581
|
+
|**200** | Successful response | - |
|
|
1582
|
+
|
|
1583
|
+
[[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)
|
|
1584
|
+
|
|
1585
|
+
# **undoCheckInBooking**
|
|
1586
|
+
> CreateBooking200Response undoCheckInBooking()
|
|
1587
|
+
|
|
1588
|
+
Undo Check In Booking endpoint
|
|
1589
|
+
|
|
1590
|
+
### Example
|
|
1591
|
+
|
|
1592
|
+
```typescript
|
|
1593
|
+
import {
|
|
1594
|
+
BookingsApi,
|
|
1595
|
+
Configuration
|
|
1596
|
+
} from '@connectedxm/admin-sdk';
|
|
1597
|
+
|
|
1598
|
+
const configuration = new Configuration();
|
|
1599
|
+
const apiInstance = new BookingsApi(configuration);
|
|
1600
|
+
|
|
1601
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
1602
|
+
let spaceId: string; //The space identifier (default to undefined)
|
|
1603
|
+
let bookingId: string; //The booking identifier (default to undefined)
|
|
1604
|
+
|
|
1605
|
+
const { status, data } = await apiInstance.undoCheckInBooking(
|
|
1606
|
+
placeId,
|
|
1607
|
+
spaceId,
|
|
1608
|
+
bookingId
|
|
1609
|
+
);
|
|
1610
|
+
```
|
|
1611
|
+
|
|
1612
|
+
### Parameters
|
|
1613
|
+
|
|
1614
|
+
|Name | Type | Description | Notes|
|
|
1615
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1616
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
1617
|
+
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
1618
|
+
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
### Return type
|
|
1622
|
+
|
|
1623
|
+
**CreateBooking200Response**
|
|
1624
|
+
|
|
1625
|
+
### Authorization
|
|
1626
|
+
|
|
1627
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1628
|
+
|
|
1629
|
+
### HTTP request headers
|
|
1630
|
+
|
|
1631
|
+
- **Content-Type**: Not defined
|
|
1632
|
+
- **Accept**: application/json
|
|
1633
|
+
|
|
1634
|
+
|
|
1519
1635
|
### HTTP response details
|
|
1520
1636
|
| Status code | Description | Response headers |
|
|
1521
1637
|
|-------------|-------------|------------------|
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**transferPush** | **boolean** | | [default to undefined]
|
|
12
12
|
**transferEmail** | **boolean** | | [default to undefined]
|
|
13
13
|
**eventReminderEmail** | **boolean** | | [default to undefined]
|
|
14
|
+
**bookingReminderEmail** | **boolean** | | [default to undefined]
|
|
14
15
|
**chatPush** | **boolean** | | [default to undefined]
|
|
15
16
|
**chatUnreadEmail** | **boolean** | | [default to undefined]
|
|
16
17
|
**chatUnreadPush** | **boolean** | | [default to undefined]
|
|
@@ -34,6 +35,7 @@ const instance: NotificationPreferences = {
|
|
|
34
35
|
transferPush,
|
|
35
36
|
transferEmail,
|
|
36
37
|
eventReminderEmail,
|
|
38
|
+
bookingReminderEmail,
|
|
37
39
|
chatPush,
|
|
38
40
|
chatUnreadEmail,
|
|
39
41
|
chatUnreadPush,
|