@connectedxm/admin-sdk 7.0.9 → 7.0.11
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 +3 -0
- package/api.ts +349 -1
- package/dist/api.d.ts +180 -1
- package/dist/api.js +256 -0
- package/dist/esm/api.d.ts +180 -1
- package/dist/esm/api.js +256 -0
- package/docs/BookingSpace.md +2 -0
- package/docs/BookingsApi.md +183 -0
- package/docs/FileSource.md +2 -0
- package/package.json +1 -1
package/docs/BookingsApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addBookingSpaceTier**](#addbookingspacetier) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/tiers/{tierId} | Add Booking Space Tier|
|
|
7
8
|
|[**cancelBooking**](#cancelbooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/cancel | Cancel Booking|
|
|
8
9
|
|[**createBooking**](#createbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings | Create Booking|
|
|
9
10
|
|[**deleteBooking**](#deletebooking) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Delete Booking|
|
|
@@ -23,11 +24,70 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
23
24
|
|[**getBookingSpaceBookings**](#getbookingspacebookings) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/bookings | Get Booking Space Bookings|
|
|
24
25
|
|[**getBookingSpacePayments**](#getbookingspacepayments) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/payments | Get Booking Space Payments|
|
|
25
26
|
|[**getBookingSpaceSlots**](#getbookingspaceslots) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/slots | Get Booking Space Slots|
|
|
27
|
+
|[**getBookingSpaceTiers**](#getbookingspacetiers) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/tiers | Get Booking Space Tiers|
|
|
26
28
|
|[**getBookingSpaceTranslation**](#getbookingspacetranslation) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/translations/{locale} | Get Booking Space Translation|
|
|
27
29
|
|[**getBookingSpaceTranslations**](#getbookingspacetranslations) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/translations | Get Booking Space Translations|
|
|
28
30
|
|[**getBookingSpaces**](#getbookingspaces) | **GET** /bookings/places/{placeId}/spaces | Get Booking Spaces|
|
|
31
|
+
|[**removeBookingSpaceTier**](#removebookingspacetier) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/tiers/{tierId} | Remove Booking Space Tier|
|
|
29
32
|
|[**updateBooking**](#updatebooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Update Booking|
|
|
30
33
|
|
|
34
|
+
# **addBookingSpaceTier**
|
|
35
|
+
> CreateBookingSpace200Response addBookingSpaceTier()
|
|
36
|
+
|
|
37
|
+
Add Booking Space Tier endpoint
|
|
38
|
+
|
|
39
|
+
### Example
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import {
|
|
43
|
+
BookingsApi,
|
|
44
|
+
Configuration
|
|
45
|
+
} from '@connectedxm/admin-sdk';
|
|
46
|
+
|
|
47
|
+
const configuration = new Configuration();
|
|
48
|
+
const apiInstance = new BookingsApi(configuration);
|
|
49
|
+
|
|
50
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
51
|
+
let spaceId: string; //The space identifier (default to undefined)
|
|
52
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
53
|
+
|
|
54
|
+
const { status, data } = await apiInstance.addBookingSpaceTier(
|
|
55
|
+
placeId,
|
|
56
|
+
spaceId,
|
|
57
|
+
tierId
|
|
58
|
+
);
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
|Name | Type | Description | Notes|
|
|
64
|
+
|------------- | ------------- | ------------- | -------------|
|
|
65
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
66
|
+
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
67
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
**CreateBookingSpace200Response**
|
|
73
|
+
|
|
74
|
+
### Authorization
|
|
75
|
+
|
|
76
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
77
|
+
|
|
78
|
+
### HTTP request headers
|
|
79
|
+
|
|
80
|
+
- **Content-Type**: Not defined
|
|
81
|
+
- **Accept**: application/json
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
### HTTP response details
|
|
85
|
+
| Status code | Description | Response headers |
|
|
86
|
+
|-------------|-------------|------------------|
|
|
87
|
+
|**200** | Successful response | - |
|
|
88
|
+
|
|
89
|
+
[[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)
|
|
90
|
+
|
|
31
91
|
# **cancelBooking**
|
|
32
92
|
> CreateBooking200Response cancelBooking()
|
|
33
93
|
|
|
@@ -1147,6 +1207,72 @@ const { status, data } = await apiInstance.getBookingSpaceSlots(
|
|
|
1147
1207
|
- **Accept**: application/json
|
|
1148
1208
|
|
|
1149
1209
|
|
|
1210
|
+
### HTTP response details
|
|
1211
|
+
| Status code | Description | Response headers |
|
|
1212
|
+
|-------------|-------------|------------------|
|
|
1213
|
+
|**200** | Successful response | - |
|
|
1214
|
+
|
|
1215
|
+
[[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)
|
|
1216
|
+
|
|
1217
|
+
# **getBookingSpaceTiers**
|
|
1218
|
+
> GetAccountTiers200Response getBookingSpaceTiers()
|
|
1219
|
+
|
|
1220
|
+
Get Booking Space Tiers endpoint
|
|
1221
|
+
|
|
1222
|
+
### Example
|
|
1223
|
+
|
|
1224
|
+
```typescript
|
|
1225
|
+
import {
|
|
1226
|
+
BookingsApi,
|
|
1227
|
+
Configuration
|
|
1228
|
+
} from '@connectedxm/admin-sdk';
|
|
1229
|
+
|
|
1230
|
+
const configuration = new Configuration();
|
|
1231
|
+
const apiInstance = new BookingsApi(configuration);
|
|
1232
|
+
|
|
1233
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
1234
|
+
let spaceId: string; //The space identifier (default to undefined)
|
|
1235
|
+
let page: number; //Page number (optional) (default to 1)
|
|
1236
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
1237
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
1238
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
1239
|
+
|
|
1240
|
+
const { status, data } = await apiInstance.getBookingSpaceTiers(
|
|
1241
|
+
placeId,
|
|
1242
|
+
spaceId,
|
|
1243
|
+
page,
|
|
1244
|
+
pageSize,
|
|
1245
|
+
orderBy,
|
|
1246
|
+
search
|
|
1247
|
+
);
|
|
1248
|
+
```
|
|
1249
|
+
|
|
1250
|
+
### Parameters
|
|
1251
|
+
|
|
1252
|
+
|Name | Type | Description | Notes|
|
|
1253
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1254
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
1255
|
+
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
1256
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
1257
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
1258
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
1259
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
### Return type
|
|
1263
|
+
|
|
1264
|
+
**GetAccountTiers200Response**
|
|
1265
|
+
|
|
1266
|
+
### Authorization
|
|
1267
|
+
|
|
1268
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1269
|
+
|
|
1270
|
+
### HTTP request headers
|
|
1271
|
+
|
|
1272
|
+
- **Content-Type**: Not defined
|
|
1273
|
+
- **Accept**: application/json
|
|
1274
|
+
|
|
1275
|
+
|
|
1150
1276
|
### HTTP response details
|
|
1151
1277
|
| Status code | Description | Response headers |
|
|
1152
1278
|
|-------------|-------------|------------------|
|
|
@@ -1333,6 +1459,63 @@ const { status, data } = await apiInstance.getBookingSpaces(
|
|
|
1333
1459
|
- **Accept**: application/json
|
|
1334
1460
|
|
|
1335
1461
|
|
|
1462
|
+
### HTTP response details
|
|
1463
|
+
| Status code | Description | Response headers |
|
|
1464
|
+
|-------------|-------------|------------------|
|
|
1465
|
+
|**200** | Successful response | - |
|
|
1466
|
+
|
|
1467
|
+
[[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)
|
|
1468
|
+
|
|
1469
|
+
# **removeBookingSpaceTier**
|
|
1470
|
+
> CreateBookingSpace200Response removeBookingSpaceTier()
|
|
1471
|
+
|
|
1472
|
+
Remove Booking Space Tier endpoint
|
|
1473
|
+
|
|
1474
|
+
### Example
|
|
1475
|
+
|
|
1476
|
+
```typescript
|
|
1477
|
+
import {
|
|
1478
|
+
BookingsApi,
|
|
1479
|
+
Configuration
|
|
1480
|
+
} from '@connectedxm/admin-sdk';
|
|
1481
|
+
|
|
1482
|
+
const configuration = new Configuration();
|
|
1483
|
+
const apiInstance = new BookingsApi(configuration);
|
|
1484
|
+
|
|
1485
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
1486
|
+
let spaceId: string; //The space identifier (default to undefined)
|
|
1487
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
1488
|
+
|
|
1489
|
+
const { status, data } = await apiInstance.removeBookingSpaceTier(
|
|
1490
|
+
placeId,
|
|
1491
|
+
spaceId,
|
|
1492
|
+
tierId
|
|
1493
|
+
);
|
|
1494
|
+
```
|
|
1495
|
+
|
|
1496
|
+
### Parameters
|
|
1497
|
+
|
|
1498
|
+
|Name | Type | Description | Notes|
|
|
1499
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1500
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
1501
|
+
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
|
|
1502
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
### Return type
|
|
1506
|
+
|
|
1507
|
+
**CreateBookingSpace200Response**
|
|
1508
|
+
|
|
1509
|
+
### Authorization
|
|
1510
|
+
|
|
1511
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1512
|
+
|
|
1513
|
+
### HTTP request headers
|
|
1514
|
+
|
|
1515
|
+
- **Content-Type**: Not defined
|
|
1516
|
+
- **Accept**: application/json
|
|
1517
|
+
|
|
1518
|
+
|
|
1336
1519
|
### HTTP response details
|
|
1337
1520
|
| Status code | Description | Response headers |
|
|
1338
1521
|
|-------------|-------------|------------------|
|
package/docs/FileSource.md
CHANGED