@connectedxm/admin-sdk 7.2.3 → 7.2.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 +1 -1
- package/README.md +2 -1
- package/api.ts +141 -23
- package/dist/api.d.ts +77 -22
- package/dist/api.js +100 -10
- package/dist/esm/api.d.ts +77 -22
- package/dist/esm/api.js +94 -4
- package/docs/AccountsApi.md +64 -0
- package/docs/BaseEventSessionQuestion.md +0 -4
- package/docs/EventSessionQuestion.md +0 -4
- package/docs/EventSessionQuestionCreateInputs.md +0 -4
- package/docs/EventSessionQuestionUpdateInputs.md +0 -4
- package/docs/{GetSupportTickets200Response.md → GetAccountSupportTickets200Response.md} +3 -3
- package/docs/RoundSessionQuestion.md +0 -4
- package/docs/SupportApi.md +2 -2
- package/package.json +1 -1
package/docs/AccountsApi.md
CHANGED
|
@@ -17,6 +17,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
17
17
|
|[**getAccountNotificationPreferences**](#getaccountnotificationpreferences) | **GET** /accounts/{accountId}/notification-preferences | Get Account Notification Preferences|
|
|
18
18
|
|[**getAccountPayments**](#getaccountpayments) | **GET** /accounts/{accountId}/payments | Get Account Payments|
|
|
19
19
|
|[**getAccountRegistrations**](#getaccountregistrations) | **GET** /accounts/{accountId}/registrations | Get Account Registrations|
|
|
20
|
+
|[**getAccountSupportTickets**](#getaccountsupporttickets) | **GET** /accounts/{accountId}/supportTickets | Get Account Support Tickets|
|
|
20
21
|
|[**getAccountThreads**](#getaccountthreads) | **GET** /accounts/{accountId}/threads | Get Account Threads|
|
|
21
22
|
|[**getAccounts**](#getaccounts) | **GET** /accounts | Get Accounts|
|
|
22
23
|
|[**getAccountsByInternalRefId**](#getaccountsbyinternalrefid) | **GET** /accounts/internal-ref-id/{internalRefId} | Get Accounts By Internal Ref Id|
|
|
@@ -787,6 +788,69 @@ const { status, data } = await apiInstance.getAccountRegistrations(
|
|
|
787
788
|
- **Accept**: application/json
|
|
788
789
|
|
|
789
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
|
+
|
|
790
854
|
### HTTP response details
|
|
791
855
|
| Status code | Description | Response headers |
|
|
792
856
|
|-------------|-------------|------------------|
|
|
@@ -26,8 +26,6 @@ Name | Type | Description | Notes
|
|
|
26
26
|
**sortOrder** | **number** | | [default to undefined]
|
|
27
27
|
**featured** | **boolean** | | [default to undefined]
|
|
28
28
|
**choices** | [**Array<BaseEventSessionQuestionChoice>**](BaseEventSessionQuestionChoice.md) | | [default to undefined]
|
|
29
|
-
**price** | **number** | | [default to undefined]
|
|
30
|
-
**supply** | **number** | | [default to undefined]
|
|
31
29
|
|
|
32
30
|
## Example
|
|
33
31
|
|
|
@@ -56,8 +54,6 @@ const instance: BaseEventSessionQuestion = {
|
|
|
56
54
|
sortOrder,
|
|
57
55
|
featured,
|
|
58
56
|
choices,
|
|
59
|
-
price,
|
|
60
|
-
supply,
|
|
61
57
|
};
|
|
62
58
|
```
|
|
63
59
|
|
|
@@ -26,8 +26,6 @@ Name | Type | Description | Notes
|
|
|
26
26
|
**sortOrder** | **number** | | [default to undefined]
|
|
27
27
|
**featured** | **boolean** | | [default to undefined]
|
|
28
28
|
**choices** | [**Array<BaseEventSessionQuestionChoice>**](BaseEventSessionQuestionChoice.md) | | [default to undefined]
|
|
29
|
-
**price** | **number** | | [default to undefined]
|
|
30
|
-
**supply** | **number** | | [default to undefined]
|
|
31
29
|
**sections** | [**Array<BaseEventSessionSectionQuestion>**](BaseEventSessionSectionQuestion.md) | | [default to undefined]
|
|
32
30
|
**subQuestionOf** | [**Array<EventSessionQuestionChoiceSubQuestion>**](EventSessionQuestionChoiceSubQuestion.md) | | [default to undefined]
|
|
33
31
|
**dashboardVisibility** | **boolean** | | [default to undefined]
|
|
@@ -62,8 +60,6 @@ const instance: EventSessionQuestion = {
|
|
|
62
60
|
sortOrder,
|
|
63
61
|
featured,
|
|
64
62
|
choices,
|
|
65
|
-
price,
|
|
66
|
-
supply,
|
|
67
63
|
sections,
|
|
68
64
|
subQuestionOf,
|
|
69
65
|
dashboardVisibility,
|
|
@@ -26,8 +26,6 @@ Name | Type | Description | Notes
|
|
|
26
26
|
**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
27
27
|
**featured** | **boolean** | | [optional] [default to undefined]
|
|
28
28
|
**choices** | **Array<string>** | | [optional] [default to undefined]
|
|
29
|
-
**price** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
30
|
-
**supply** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
31
29
|
**searchListId** | **string** | | [optional] [default to undefined]
|
|
32
30
|
**masked** | **boolean** | | [optional] [default to undefined]
|
|
33
31
|
|
|
@@ -58,8 +56,6 @@ const instance: EventSessionQuestionCreateInputs = {
|
|
|
58
56
|
sortOrder,
|
|
59
57
|
featured,
|
|
60
58
|
choices,
|
|
61
|
-
price,
|
|
62
|
-
supply,
|
|
63
59
|
searchListId,
|
|
64
60
|
masked,
|
|
65
61
|
};
|
|
@@ -23,8 +23,6 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**locationOption** | [**LocationQuestionOption**](LocationQuestionOption.md) | | [optional] [default to undefined]
|
|
24
24
|
**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
25
25
|
**featured** | **boolean** | | [optional] [default to undefined]
|
|
26
|
-
**price** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
27
|
-
**supply** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
28
26
|
**searchListId** | **string** | | [optional] [default to undefined]
|
|
29
27
|
|
|
30
28
|
## Example
|
|
@@ -51,8 +49,6 @@ const instance: EventSessionQuestionUpdateInputs = {
|
|
|
51
49
|
locationOption,
|
|
52
50
|
sortOrder,
|
|
53
51
|
featured,
|
|
54
|
-
price,
|
|
55
|
-
supply,
|
|
56
52
|
searchListId,
|
|
57
53
|
};
|
|
58
54
|
```
|
|
@@ -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,
|
|
@@ -26,8 +26,6 @@ Name | Type | Description | Notes
|
|
|
26
26
|
**sortOrder** | **number** | | [default to undefined]
|
|
27
27
|
**featured** | **boolean** | | [default to undefined]
|
|
28
28
|
**choices** | [**Array<BaseEventSessionQuestionChoice>**](BaseEventSessionQuestionChoice.md) | | [default to undefined]
|
|
29
|
-
**price** | **number** | | [default to undefined]
|
|
30
|
-
**supply** | **number** | | [default to undefined]
|
|
31
29
|
**sections** | [**Array<BaseEventSessionSectionQuestion>**](BaseEventSessionSectionQuestion.md) | | [default to undefined]
|
|
32
30
|
**subQuestionOf** | [**Array<EventSessionQuestionChoiceSubQuestion>**](EventSessionQuestionChoiceSubQuestion.md) | | [default to undefined]
|
|
33
31
|
**dashboardVisibility** | **boolean** | | [default to undefined]
|
|
@@ -64,8 +62,6 @@ const instance: RoundSessionQuestion = {
|
|
|
64
62
|
sortOrder,
|
|
65
63
|
featured,
|
|
66
64
|
choices,
|
|
67
|
-
price,
|
|
68
|
-
supply,
|
|
69
65
|
sections,
|
|
70
66
|
subQuestionOf,
|
|
71
67
|
dashboardVisibility,
|
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
|
|