@connectedxm/admin-sdk 7.2.2 → 7.2.4
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 +2 -2
- package/README.md +4 -2
- package/api.ts +285 -28
- package/dist/api.d.ts +158 -27
- package/dist/api.js +195 -15
- package/dist/esm/api.d.ts +158 -27
- package/dist/esm/api.js +188 -8
- package/docs/AccountsApi.md +128 -0
- package/docs/Booking.md +2 -0
- package/docs/BookingsApi.md +4 -4
- package/docs/{GetBookingPlaceBookings200Response.md → GetAccountBookings200Response.md} +3 -3
- package/docs/{GetSupportTickets200Response.md → GetAccountSupportTickets200Response.md} +3 -3
- package/docs/SupportApi.md +2 -2
- package/package.json +1 -1
package/docs/AccountsApi.md
CHANGED
|
@@ -10,12 +10,14 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
10
10
|
|[**getAcccountEmailReceipts**](#getacccountemailreceipts) | **GET** /accounts/{accountId}/email-receipts | Get Acccount Email Receipts|
|
|
11
11
|
|[**getAccount**](#getaccount) | **GET** /accounts/{accountId} | Get Account|
|
|
12
12
|
|[**getAccountActivities**](#getaccountactivities) | **GET** /accounts/{accountId}/activities | Get Account Activities|
|
|
13
|
+
|[**getAccountBookings**](#getaccountbookings) | **GET** /accounts/{accountId}/bookings | Get Account Bookings|
|
|
13
14
|
|[**getAccountComments**](#getaccountcomments) | **GET** /accounts/{accountId}/comments | Get Account Comments|
|
|
14
15
|
|[**getAccountEvents**](#getaccountevents) | **GET** /accounts/{accountId}/events | Get Account Events|
|
|
15
16
|
|[**getAccountLikes**](#getaccountlikes) | **GET** /accounts/{accountId}/likes | Get Account Likes|
|
|
16
17
|
|[**getAccountNotificationPreferences**](#getaccountnotificationpreferences) | **GET** /accounts/{accountId}/notification-preferences | Get Account Notification Preferences|
|
|
17
18
|
|[**getAccountPayments**](#getaccountpayments) | **GET** /accounts/{accountId}/payments | Get Account Payments|
|
|
18
19
|
|[**getAccountRegistrations**](#getaccountregistrations) | **GET** /accounts/{accountId}/registrations | Get Account Registrations|
|
|
20
|
+
|[**getAccountSupportTickets**](#getaccountsupporttickets) | **GET** /accounts/{accountId}/supportTickets | Get Account Support Tickets|
|
|
19
21
|
|[**getAccountThreads**](#getaccountthreads) | **GET** /accounts/{accountId}/threads | Get Account Threads|
|
|
20
22
|
|[**getAccounts**](#getaccounts) | **GET** /accounts | Get Accounts|
|
|
21
23
|
|[**getAccountsByInternalRefId**](#getaccountsbyinternalrefid) | **GET** /accounts/internal-ref-id/{internalRefId} | Get Accounts By Internal Ref Id|
|
|
@@ -354,6 +356,69 @@ const { status, data } = await apiInstance.getAccountActivities(
|
|
|
354
356
|
- **Accept**: application/json
|
|
355
357
|
|
|
356
358
|
|
|
359
|
+
### HTTP response details
|
|
360
|
+
| Status code | Description | Response headers |
|
|
361
|
+
|-------------|-------------|------------------|
|
|
362
|
+
|**200** | Successful response | - |
|
|
363
|
+
|
|
364
|
+
[[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)
|
|
365
|
+
|
|
366
|
+
# **getAccountBookings**
|
|
367
|
+
> GetAccountBookings200Response getAccountBookings()
|
|
368
|
+
|
|
369
|
+
Get Account Bookings endpoint
|
|
370
|
+
|
|
371
|
+
### Example
|
|
372
|
+
|
|
373
|
+
```typescript
|
|
374
|
+
import {
|
|
375
|
+
AccountsApi,
|
|
376
|
+
Configuration
|
|
377
|
+
} from '@connectedxm/admin-sdk';
|
|
378
|
+
|
|
379
|
+
const configuration = new Configuration();
|
|
380
|
+
const apiInstance = new AccountsApi(configuration);
|
|
381
|
+
|
|
382
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
383
|
+
let page: number; //Page number (optional) (default to 1)
|
|
384
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
385
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
386
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
387
|
+
|
|
388
|
+
const { status, data } = await apiInstance.getAccountBookings(
|
|
389
|
+
accountId,
|
|
390
|
+
page,
|
|
391
|
+
pageSize,
|
|
392
|
+
orderBy,
|
|
393
|
+
search
|
|
394
|
+
);
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
### Parameters
|
|
398
|
+
|
|
399
|
+
|Name | Type | Description | Notes|
|
|
400
|
+
|------------- | ------------- | ------------- | -------------|
|
|
401
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
402
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
403
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
404
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
405
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
### Return type
|
|
409
|
+
|
|
410
|
+
**GetAccountBookings200Response**
|
|
411
|
+
|
|
412
|
+
### Authorization
|
|
413
|
+
|
|
414
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
415
|
+
|
|
416
|
+
### HTTP request headers
|
|
417
|
+
|
|
418
|
+
- **Content-Type**: Not defined
|
|
419
|
+
- **Accept**: application/json
|
|
420
|
+
|
|
421
|
+
|
|
357
422
|
### HTTP response details
|
|
358
423
|
| Status code | Description | Response headers |
|
|
359
424
|
|-------------|-------------|------------------|
|
|
@@ -723,6 +788,69 @@ const { status, data } = await apiInstance.getAccountRegistrations(
|
|
|
723
788
|
- **Accept**: application/json
|
|
724
789
|
|
|
725
790
|
|
|
791
|
+
### HTTP response details
|
|
792
|
+
| Status code | Description | Response headers |
|
|
793
|
+
|-------------|-------------|------------------|
|
|
794
|
+
|**200** | Successful response | - |
|
|
795
|
+
|
|
796
|
+
[[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)
|
|
797
|
+
|
|
798
|
+
# **getAccountSupportTickets**
|
|
799
|
+
> GetAccountSupportTickets200Response getAccountSupportTickets()
|
|
800
|
+
|
|
801
|
+
Get Account Support Tickets endpoint
|
|
802
|
+
|
|
803
|
+
### Example
|
|
804
|
+
|
|
805
|
+
```typescript
|
|
806
|
+
import {
|
|
807
|
+
AccountsApi,
|
|
808
|
+
Configuration
|
|
809
|
+
} from '@connectedxm/admin-sdk';
|
|
810
|
+
|
|
811
|
+
const configuration = new Configuration();
|
|
812
|
+
const apiInstance = new AccountsApi(configuration);
|
|
813
|
+
|
|
814
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
815
|
+
let page: number; //Page number (optional) (default to 1)
|
|
816
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
817
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
818
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
819
|
+
|
|
820
|
+
const { status, data } = await apiInstance.getAccountSupportTickets(
|
|
821
|
+
accountId,
|
|
822
|
+
page,
|
|
823
|
+
pageSize,
|
|
824
|
+
orderBy,
|
|
825
|
+
search
|
|
826
|
+
);
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
### Parameters
|
|
830
|
+
|
|
831
|
+
|Name | Type | Description | Notes|
|
|
832
|
+
|------------- | ------------- | ------------- | -------------|
|
|
833
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
834
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
835
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
836
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
837
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
### Return type
|
|
841
|
+
|
|
842
|
+
**GetAccountSupportTickets200Response**
|
|
843
|
+
|
|
844
|
+
### Authorization
|
|
845
|
+
|
|
846
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
847
|
+
|
|
848
|
+
### HTTP request headers
|
|
849
|
+
|
|
850
|
+
- **Content-Type**: Not defined
|
|
851
|
+
- **Accept**: application/json
|
|
852
|
+
|
|
853
|
+
|
|
726
854
|
### HTTP response details
|
|
727
855
|
| Status code | Description | Response headers |
|
|
728
856
|
|-------------|-------------|------------------|
|
package/docs/Booking.md
CHANGED
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**createdAt** | **string** | | [default to undefined]
|
|
20
20
|
**updatedAt** | **string** | | [default to undefined]
|
|
21
21
|
**responses** | [**Array<BaseBookingQuestionResponse>**](BaseBookingQuestionResponse.md) | | [optional] [default to undefined]
|
|
22
|
+
**place** | [**BaseBookingPlace**](BaseBookingPlace.md) | | [optional] [default to undefined]
|
|
22
23
|
|
|
23
24
|
## Example
|
|
24
25
|
|
|
@@ -40,6 +41,7 @@ const instance: Booking = {
|
|
|
40
41
|
createdAt,
|
|
41
42
|
updatedAt,
|
|
42
43
|
responses,
|
|
44
|
+
place,
|
|
43
45
|
};
|
|
44
46
|
```
|
|
45
47
|
|
package/docs/BookingsApi.md
CHANGED
|
@@ -422,7 +422,7 @@ const { status, data } = await apiInstance.getBookingPlace(
|
|
|
422
422
|
[[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)
|
|
423
423
|
|
|
424
424
|
# **getBookingPlaceBookings**
|
|
425
|
-
>
|
|
425
|
+
> GetAccountBookings200Response getBookingPlaceBookings()
|
|
426
426
|
|
|
427
427
|
Get Booking Place Bookings endpoint
|
|
428
428
|
|
|
@@ -471,7 +471,7 @@ const { status, data } = await apiInstance.getBookingPlaceBookings(
|
|
|
471
471
|
|
|
472
472
|
### Return type
|
|
473
473
|
|
|
474
|
-
**
|
|
474
|
+
**GetAccountBookings200Response**
|
|
475
475
|
|
|
476
476
|
### Authorization
|
|
477
477
|
|
|
@@ -1073,7 +1073,7 @@ const { status, data } = await apiInstance.getBookingSpaceBlackouts(
|
|
|
1073
1073
|
[[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)
|
|
1074
1074
|
|
|
1075
1075
|
# **getBookingSpaceBookings**
|
|
1076
|
-
>
|
|
1076
|
+
> GetAccountBookings200Response getBookingSpaceBookings()
|
|
1077
1077
|
|
|
1078
1078
|
Get Booking Space Bookings endpoint
|
|
1079
1079
|
|
|
@@ -1125,7 +1125,7 @@ const { status, data } = await apiInstance.getBookingSpaceBookings(
|
|
|
1125
1125
|
|
|
1126
1126
|
### Return type
|
|
1127
1127
|
|
|
1128
|
-
**
|
|
1128
|
+
**GetAccountBookings200Response**
|
|
1129
1129
|
|
|
1130
1130
|
### Authorization
|
|
1131
1131
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# GetAccountBookings200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { GetAccountBookings200Response } from '@connectedxm/admin-sdk';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: GetAccountBookings200Response = {
|
|
19
19
|
status,
|
|
20
20
|
message,
|
|
21
21
|
data,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# GetAccountSupportTickets200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { GetAccountSupportTickets200Response } from '@connectedxm/admin-sdk';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: GetAccountSupportTickets200Response = {
|
|
19
19
|
status,
|
|
20
20
|
message,
|
|
21
21
|
data,
|
package/docs/SupportApi.md
CHANGED
|
@@ -284,7 +284,7 @@ const { status, data } = await apiInstance.getSupportTicketViewer(
|
|
|
284
284
|
[[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)
|
|
285
285
|
|
|
286
286
|
# **getSupportTickets**
|
|
287
|
-
>
|
|
287
|
+
> GetAccountSupportTickets200Response getSupportTickets()
|
|
288
288
|
|
|
289
289
|
Get Support Tickets endpoint
|
|
290
290
|
|
|
@@ -333,7 +333,7 @@ const { status, data } = await apiInstance.getSupportTickets(
|
|
|
333
333
|
|
|
334
334
|
### Return type
|
|
335
335
|
|
|
336
|
-
**
|
|
336
|
+
**GetAccountSupportTickets200Response**
|
|
337
337
|
|
|
338
338
|
### Authorization
|
|
339
339
|
|