@connectedxm/admin-sdk 6.6.2 → 6.7.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 +14 -9
- package/AdminApi.ts +21 -27
- package/README.md +47 -37
- package/api.ts +17637 -17396
- package/dist/AdminApi.d.ts +8 -10
- package/dist/AdminApi.js +7 -9
- package/dist/api.d.ts +3139 -3021
- package/dist/api.js +8437 -8272
- package/dist/esm/AdminApi.d.ts +8 -10
- package/dist/esm/AdminApi.js +8 -10
- package/dist/esm/api.d.ts +3139 -3021
- package/dist/esm/api.js +8043 -7870
- package/docs/AccountsApi.md +64 -0
- package/docs/ActivitiesApi.md +3 -0
- package/docs/BaseOrganizationModuleSettings.md +20 -0
- package/docs/BaseOrganizationModuleSettingsTranslation.md +22 -0
- package/docs/EventAttendeeCreateInputs.md +20 -0
- package/docs/EventsAttendeesApi.md +7 -6
- package/docs/FilesApi.md +0 -116
- package/docs/Organization.md +0 -16
- package/docs/OrganizationModuleSettings.md +36 -0
- package/docs/OrganizationModuleSettingsTranslation.md +24 -0
- package/docs/OrganizationModuleSettingsTranslationUpdateInputs.md +20 -0
- package/docs/OrganizationModuleSettingsUpdateInputs.md +34 -0
- package/docs/OrganizationModulesSettingsApi.md +105 -0
- package/docs/OrganizationUpdateInputs.md +0 -16
- package/docs/{LevelsAccountsApi.md → SponsorsAccountsApi.md} +7 -7
- package/docs/{LevelsApi.md → SponsorsApi.md} +11 -11
- package/docs/StorageFilesApi.md +181 -0
- package/docs/{ImagesApi.md → StorageImagesApi.md} +17 -17
- package/docs/{VideosApi.md → StorageVideosApi.md} +15 -15
- package/docs/{VideosCaptionsApi.md → StorageVideosCaptionsApi.md} +11 -11
- package/docs/SupportApi.md +241 -0
- package/docs/SupportMessagesApi.md +64 -0
- package/docs/SupportNotesApi.md +64 -0
- package/docs/SupportTicketState.md +2 -0
- package/package.json +1 -1
- package/docs/StorageApi.md +0 -65
- package/docs/SupportticketsApi.md +0 -248
- package/docs/SupportticketsMessagesApi.md +0 -71
- package/docs/SupportticketsNotesApi.md +0 -71
package/docs/AccountsApi.md
CHANGED
|
@@ -15,6 +15,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
15
15
|
|[**getAccountLikes**](#getaccountlikes) | **GET** /accounts/{accountId}/likes | Get Account Likes|
|
|
16
16
|
|[**getAccountNotificationPreferences**](#getaccountnotificationpreferences) | **GET** /accounts/{accountId}/notification-preferences | Get Account Notification Preferences|
|
|
17
17
|
|[**getAccountPayments**](#getaccountpayments) | **GET** /accounts/{accountId}/payments | Get Account Payments|
|
|
18
|
+
|[**getAccountRegistrations**](#getaccountregistrations) | **GET** /accounts/{accountId}/registrations | Get Account Registrations|
|
|
18
19
|
|[**getAccountThreads**](#getaccountthreads) | **GET** /accounts/{accountId}/threads | Get Account Threads|
|
|
19
20
|
|[**getAccounts**](#getaccounts) | **GET** /accounts | Get Accounts|
|
|
20
21
|
|[**impersonateAccount**](#impersonateaccount) | **POST** /accounts/{accountId}/impersonate/{username} | Impersonate Account|
|
|
@@ -656,6 +657,69 @@ const { status, data } = await apiInstance.getAccountPayments(
|
|
|
656
657
|
- **Accept**: application/json
|
|
657
658
|
|
|
658
659
|
|
|
660
|
+
### HTTP response details
|
|
661
|
+
| Status code | Description | Response headers |
|
|
662
|
+
|-------------|-------------|------------------|
|
|
663
|
+
|**200** | Successful response | - |
|
|
664
|
+
|
|
665
|
+
[[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)
|
|
666
|
+
|
|
667
|
+
# **getAccountRegistrations**
|
|
668
|
+
> GetAccountInvitations200Response getAccountRegistrations()
|
|
669
|
+
|
|
670
|
+
Get Account Registrations endpoint
|
|
671
|
+
|
|
672
|
+
### Example
|
|
673
|
+
|
|
674
|
+
```typescript
|
|
675
|
+
import {
|
|
676
|
+
AccountsApi,
|
|
677
|
+
Configuration
|
|
678
|
+
} from '@connectedxm/admin-sdk';
|
|
679
|
+
|
|
680
|
+
const configuration = new Configuration();
|
|
681
|
+
const apiInstance = new AccountsApi(configuration);
|
|
682
|
+
|
|
683
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
684
|
+
let page: number; //Page number (optional) (default to 1)
|
|
685
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
686
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
687
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
688
|
+
|
|
689
|
+
const { status, data } = await apiInstance.getAccountRegistrations(
|
|
690
|
+
accountId,
|
|
691
|
+
page,
|
|
692
|
+
pageSize,
|
|
693
|
+
orderBy,
|
|
694
|
+
search
|
|
695
|
+
);
|
|
696
|
+
```
|
|
697
|
+
|
|
698
|
+
### Parameters
|
|
699
|
+
|
|
700
|
+
|Name | Type | Description | Notes|
|
|
701
|
+
|------------- | ------------- | ------------- | -------------|
|
|
702
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
703
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
704
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
705
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
706
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
### Return type
|
|
710
|
+
|
|
711
|
+
**GetAccountInvitations200Response**
|
|
712
|
+
|
|
713
|
+
### Authorization
|
|
714
|
+
|
|
715
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
716
|
+
|
|
717
|
+
### HTTP request headers
|
|
718
|
+
|
|
719
|
+
- **Content-Type**: Not defined
|
|
720
|
+
- **Accept**: application/json
|
|
721
|
+
|
|
722
|
+
|
|
659
723
|
### HTTP response details
|
|
660
724
|
| Status code | Description | Response headers |
|
|
661
725
|
|-------------|-------------|------------------|
|
package/docs/ActivitiesApi.md
CHANGED
|
@@ -193,6 +193,7 @@ const apiInstance = new ActivitiesApi(configuration);
|
|
|
193
193
|
let moderation: ModerationStatus; //Filter by moderation (optional) (default to undefined)
|
|
194
194
|
let featured: object; //Filter by featured (optional) (default to undefined)
|
|
195
195
|
let status: ActivityStatus; //Filter by status (optional) (default to undefined)
|
|
196
|
+
let global: boolean; //Filter by global (optional) (default to undefined)
|
|
196
197
|
let page: number; //Page number (optional) (default to 1)
|
|
197
198
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
198
199
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
@@ -202,6 +203,7 @@ const { status, data } = await apiInstance.getActivities(
|
|
|
202
203
|
moderation,
|
|
203
204
|
featured,
|
|
204
205
|
status,
|
|
206
|
+
global,
|
|
205
207
|
page,
|
|
206
208
|
pageSize,
|
|
207
209
|
orderBy,
|
|
@@ -216,6 +218,7 @@ const { status, data } = await apiInstance.getActivities(
|
|
|
216
218
|
| **moderation** | **ModerationStatus** | Filter by moderation | (optional) defaults to undefined|
|
|
217
219
|
| **featured** | **object** | Filter by featured | (optional) defaults to undefined|
|
|
218
220
|
| **status** | **ActivityStatus** | Filter by status | (optional) defaults to undefined|
|
|
221
|
+
| **global** | [**boolean**] | Filter by global | (optional) defaults to undefined|
|
|
219
222
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
220
223
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
221
224
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# BaseOrganizationModuleSettings
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**organizationId** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { BaseOrganizationModuleSettings } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: BaseOrganizationModuleSettings = {
|
|
16
|
+
organizationId,
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BaseOrganizationModuleSettingsTranslation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**organizationId** | **string** | | [default to undefined]
|
|
9
|
+
**locale** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BaseOrganizationModuleSettingsTranslation } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: BaseOrganizationModuleSettingsTranslation = {
|
|
17
|
+
organizationId,
|
|
18
|
+
locale,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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,20 @@
|
|
|
1
|
+
# EventAttendeeCreateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**accountId** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EventAttendeeCreateInputs } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: EventAttendeeCreateInputs = {
|
|
16
|
+
accountId,
|
|
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)
|
|
@@ -17,7 +17,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
17
17
|
|[**updateEventAttendee**](#updateeventattendee) | **PUT** /events/{eventId}/attendees/{accountId} | Update Event Attendee|
|
|
18
18
|
|
|
19
19
|
# **createEventAttendee**
|
|
20
|
-
> CreateEventAttendee200Response createEventAttendee()
|
|
20
|
+
> CreateEventAttendee200Response createEventAttendee(eventAttendeeCreateInputs)
|
|
21
21
|
|
|
22
22
|
Create Event Attendee endpoint
|
|
23
23
|
|
|
@@ -26,18 +26,19 @@ Create Event Attendee endpoint
|
|
|
26
26
|
```typescript
|
|
27
27
|
import {
|
|
28
28
|
EventsAttendeesApi,
|
|
29
|
-
Configuration
|
|
29
|
+
Configuration,
|
|
30
|
+
EventAttendeeCreateInputs
|
|
30
31
|
} from '@connectedxm/admin-sdk';
|
|
31
32
|
|
|
32
33
|
const configuration = new Configuration();
|
|
33
34
|
const apiInstance = new EventsAttendeesApi(configuration);
|
|
34
35
|
|
|
35
36
|
let eventId: string; //The event identifier (default to undefined)
|
|
36
|
-
let
|
|
37
|
+
let eventAttendeeCreateInputs: EventAttendeeCreateInputs; //
|
|
37
38
|
|
|
38
39
|
const { status, data } = await apiInstance.createEventAttendee(
|
|
39
40
|
eventId,
|
|
40
|
-
|
|
41
|
+
eventAttendeeCreateInputs
|
|
41
42
|
);
|
|
42
43
|
```
|
|
43
44
|
|
|
@@ -45,8 +46,8 @@ const { status, data } = await apiInstance.createEventAttendee(
|
|
|
45
46
|
|
|
46
47
|
|Name | Type | Description | Notes|
|
|
47
48
|
|------------- | ------------- | ------------- | -------------|
|
|
49
|
+
| **eventAttendeeCreateInputs** | **EventAttendeeCreateInputs**| | |
|
|
48
50
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
49
|
-
| **accountId** | [**string**] | Filter by accountId | defaults to undefined|
|
|
50
51
|
|
|
51
52
|
|
|
52
53
|
### Return type
|
|
@@ -59,7 +60,7 @@ const { status, data } = await apiInstance.createEventAttendee(
|
|
|
59
60
|
|
|
60
61
|
### HTTP request headers
|
|
61
62
|
|
|
62
|
-
- **Content-Type**:
|
|
63
|
+
- **Content-Type**: application/json
|
|
63
64
|
- **Accept**: application/json
|
|
64
65
|
|
|
65
66
|
|
package/docs/FilesApi.md
CHANGED
|
@@ -5,8 +5,6 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**deleteFile**](#deletefile) | **DELETE** /files/{fileId} | Delete File|
|
|
8
|
-
|[**getFile**](#getfile) | **GET** /files/{fileId} | Get File|
|
|
9
|
-
|[**getFiles**](#getfiles) | **GET** /files | Get Files|
|
|
10
8
|
|[**updateFile**](#updatefile) | **PUT** /files/{fileId} | Update File|
|
|
11
9
|
|
|
12
10
|
# **deleteFile**
|
|
@@ -53,120 +51,6 @@ const { status, data } = await apiInstance.deleteFile(
|
|
|
53
51
|
- **Accept**: application/json
|
|
54
52
|
|
|
55
53
|
|
|
56
|
-
### HTTP response details
|
|
57
|
-
| Status code | Description | Response headers |
|
|
58
|
-
|-------------|-------------|------------------|
|
|
59
|
-
|**200** | Successful response | - |
|
|
60
|
-
|
|
61
|
-
[[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)
|
|
62
|
-
|
|
63
|
-
# **getFile**
|
|
64
|
-
> UploadFile200Response getFile()
|
|
65
|
-
|
|
66
|
-
Get File endpoint
|
|
67
|
-
|
|
68
|
-
### Example
|
|
69
|
-
|
|
70
|
-
```typescript
|
|
71
|
-
import {
|
|
72
|
-
FilesApi,
|
|
73
|
-
Configuration
|
|
74
|
-
} from '@connectedxm/admin-sdk';
|
|
75
|
-
|
|
76
|
-
const configuration = new Configuration();
|
|
77
|
-
const apiInstance = new FilesApi(configuration);
|
|
78
|
-
|
|
79
|
-
let fileId: string; //The file identifier (default to undefined)
|
|
80
|
-
|
|
81
|
-
const { status, data } = await apiInstance.getFile(
|
|
82
|
-
fileId
|
|
83
|
-
);
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
### Parameters
|
|
87
|
-
|
|
88
|
-
|Name | Type | Description | Notes|
|
|
89
|
-
|------------- | ------------- | ------------- | -------------|
|
|
90
|
-
| **fileId** | [**string**] | The file identifier | defaults to undefined|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
### Return type
|
|
94
|
-
|
|
95
|
-
**UploadFile200Response**
|
|
96
|
-
|
|
97
|
-
### Authorization
|
|
98
|
-
|
|
99
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
100
|
-
|
|
101
|
-
### HTTP request headers
|
|
102
|
-
|
|
103
|
-
- **Content-Type**: Not defined
|
|
104
|
-
- **Accept**: application/json
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
### HTTP response details
|
|
108
|
-
| Status code | Description | Response headers |
|
|
109
|
-
|-------------|-------------|------------------|
|
|
110
|
-
|**200** | Successful response | - |
|
|
111
|
-
|
|
112
|
-
[[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)
|
|
113
|
-
|
|
114
|
-
# **getFiles**
|
|
115
|
-
> GetFiles200Response getFiles()
|
|
116
|
-
|
|
117
|
-
Get Files endpoint
|
|
118
|
-
|
|
119
|
-
### Example
|
|
120
|
-
|
|
121
|
-
```typescript
|
|
122
|
-
import {
|
|
123
|
-
FilesApi,
|
|
124
|
-
Configuration
|
|
125
|
-
} from '@connectedxm/admin-sdk';
|
|
126
|
-
|
|
127
|
-
const configuration = new Configuration();
|
|
128
|
-
const apiInstance = new FilesApi(configuration);
|
|
129
|
-
|
|
130
|
-
let source: string; //Filter by source (optional) (default to undefined)
|
|
131
|
-
let page: number; //Page number (optional) (default to 1)
|
|
132
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
133
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
134
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
135
|
-
|
|
136
|
-
const { status, data } = await apiInstance.getFiles(
|
|
137
|
-
source,
|
|
138
|
-
page,
|
|
139
|
-
pageSize,
|
|
140
|
-
orderBy,
|
|
141
|
-
search
|
|
142
|
-
);
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
### Parameters
|
|
146
|
-
|
|
147
|
-
|Name | Type | Description | Notes|
|
|
148
|
-
|------------- | ------------- | ------------- | -------------|
|
|
149
|
-
| **source** | [**string**] | Filter by source | (optional) defaults to undefined|
|
|
150
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
151
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
152
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
153
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
### Return type
|
|
157
|
-
|
|
158
|
-
**GetFiles200Response**
|
|
159
|
-
|
|
160
|
-
### Authorization
|
|
161
|
-
|
|
162
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
163
|
-
|
|
164
|
-
### HTTP request headers
|
|
165
|
-
|
|
166
|
-
- **Content-Type**: Not defined
|
|
167
|
-
- **Accept**: application/json
|
|
168
|
-
|
|
169
|
-
|
|
170
54
|
### HTTP response details
|
|
171
55
|
| Status code | Description | Response headers |
|
|
172
56
|
|-------------|-------------|------------------|
|
package/docs/Organization.md
CHANGED
|
@@ -74,15 +74,7 @@ Name | Type | Description | Notes
|
|
|
74
74
|
**locales** | **Array<string>** | | [default to undefined]
|
|
75
75
|
**inviteOnly** | **boolean** | | [default to undefined]
|
|
76
76
|
**googleTagManagerId** | **string** | | [default to undefined]
|
|
77
|
-
**meetingGroupCallAdminPreset** | **string** | | [default to undefined]
|
|
78
|
-
**meetingGroupCallGuestPreset** | **string** | | [default to undefined]
|
|
79
|
-
**meetingWebinarAdminPreset** | **string** | | [default to undefined]
|
|
80
|
-
**meetingWebinarGuestPreset** | **string** | | [default to undefined]
|
|
81
|
-
**meetingLivestreamAdminPreset** | **string** | | [default to undefined]
|
|
82
|
-
**meetingLivestreamGuestPreset** | **string** | | [default to undefined]
|
|
83
77
|
**_options** | **object** | | [default to undefined]
|
|
84
|
-
**autoResolveSupportTickets** | **boolean** | | [default to undefined]
|
|
85
|
-
**autoResolveSupportTicketMessage** | **string** | | [default to undefined]
|
|
86
78
|
|
|
87
79
|
## Example
|
|
88
80
|
|
|
@@ -159,15 +151,7 @@ const instance: Organization = {
|
|
|
159
151
|
locales,
|
|
160
152
|
inviteOnly,
|
|
161
153
|
googleTagManagerId,
|
|
162
|
-
meetingGroupCallAdminPreset,
|
|
163
|
-
meetingGroupCallGuestPreset,
|
|
164
|
-
meetingWebinarAdminPreset,
|
|
165
|
-
meetingWebinarGuestPreset,
|
|
166
|
-
meetingLivestreamAdminPreset,
|
|
167
|
-
meetingLivestreamGuestPreset,
|
|
168
154
|
_options,
|
|
169
|
-
autoResolveSupportTickets,
|
|
170
|
-
autoResolveSupportTicketMessage,
|
|
171
155
|
};
|
|
172
156
|
```
|
|
173
157
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# OrganizationModuleSettings
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**organizationId** | **string** | | [default to undefined]
|
|
9
|
+
**meetingGroupCallAdminPreset** | **string** | | [default to undefined]
|
|
10
|
+
**meetingGroupCallGuestPreset** | **string** | | [default to undefined]
|
|
11
|
+
**meetingWebinarAdminPreset** | **string** | | [default to undefined]
|
|
12
|
+
**meetingWebinarGuestPreset** | **string** | | [default to undefined]
|
|
13
|
+
**meetingLivestreamAdminPreset** | **string** | | [default to undefined]
|
|
14
|
+
**meetingLivestreamGuestPreset** | **string** | | [default to undefined]
|
|
15
|
+
**supportAutoResolve** | **boolean** | | [default to undefined]
|
|
16
|
+
**supportAutoResolveMessage** | **string** | | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { OrganizationModuleSettings } from '@connectedxm/admin-sdk';
|
|
22
|
+
|
|
23
|
+
const instance: OrganizationModuleSettings = {
|
|
24
|
+
organizationId,
|
|
25
|
+
meetingGroupCallAdminPreset,
|
|
26
|
+
meetingGroupCallGuestPreset,
|
|
27
|
+
meetingWebinarAdminPreset,
|
|
28
|
+
meetingWebinarGuestPreset,
|
|
29
|
+
meetingLivestreamAdminPreset,
|
|
30
|
+
meetingLivestreamGuestPreset,
|
|
31
|
+
supportAutoResolve,
|
|
32
|
+
supportAutoResolveMessage,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[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,24 @@
|
|
|
1
|
+
# OrganizationModuleSettingsTranslation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**organizationId** | **string** | | [default to undefined]
|
|
9
|
+
**locale** | **string** | | [default to undefined]
|
|
10
|
+
**supportAutoResolveMessage** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { OrganizationModuleSettingsTranslation } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: OrganizationModuleSettingsTranslation = {
|
|
18
|
+
organizationId,
|
|
19
|
+
locale,
|
|
20
|
+
supportAutoResolveMessage,
|
|
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,20 @@
|
|
|
1
|
+
# OrganizationModuleSettingsTranslationUpdateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**supportAutoResolveMessage** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { OrganizationModuleSettingsTranslationUpdateInputs } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: OrganizationModuleSettingsTranslationUpdateInputs = {
|
|
16
|
+
supportAutoResolveMessage,
|
|
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)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# OrganizationModuleSettingsUpdateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**meetingGroupCallAdminPreset** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**meetingGroupCallGuestPreset** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**meetingWebinarAdminPreset** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**meetingWebinarGuestPreset** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**meetingLivestreamAdminPreset** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**meetingLivestreamGuestPreset** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**supportAutoResolve** | **boolean** | | [optional] [default to undefined]
|
|
15
|
+
**supportAutoResolveMessage** | **string** | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { OrganizationModuleSettingsUpdateInputs } from '@connectedxm/admin-sdk';
|
|
21
|
+
|
|
22
|
+
const instance: OrganizationModuleSettingsUpdateInputs = {
|
|
23
|
+
meetingGroupCallAdminPreset,
|
|
24
|
+
meetingGroupCallGuestPreset,
|
|
25
|
+
meetingWebinarAdminPreset,
|
|
26
|
+
meetingWebinarGuestPreset,
|
|
27
|
+
meetingLivestreamAdminPreset,
|
|
28
|
+
meetingLivestreamGuestPreset,
|
|
29
|
+
supportAutoResolve,
|
|
30
|
+
supportAutoResolveMessage,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[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,105 @@
|
|
|
1
|
+
# OrganizationModulesSettingsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getOrganizationModuleSettings**](#getorganizationmodulesettings) | **GET** /organization/module-settings | Get Organization Module Settings|
|
|
8
|
+
|[**updateOrganizationModuleSettings**](#updateorganizationmodulesettings) | **PUT** /organization/module-settings | Update Organization Module Settings|
|
|
9
|
+
|
|
10
|
+
# **getOrganizationModuleSettings**
|
|
11
|
+
> CreateAccountAddress200Response getOrganizationModuleSettings()
|
|
12
|
+
|
|
13
|
+
Get Organization Module Settings endpoint
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
OrganizationModulesSettingsApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@connectedxm/admin-sdk';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new OrganizationModulesSettingsApi(configuration);
|
|
25
|
+
|
|
26
|
+
const { status, data } = await apiInstance.getOrganizationModuleSettings();
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Parameters
|
|
30
|
+
This endpoint does not have any parameters.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
### Return type
|
|
34
|
+
|
|
35
|
+
**CreateAccountAddress200Response**
|
|
36
|
+
|
|
37
|
+
### Authorization
|
|
38
|
+
|
|
39
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
40
|
+
|
|
41
|
+
### HTTP request headers
|
|
42
|
+
|
|
43
|
+
- **Content-Type**: Not defined
|
|
44
|
+
- **Accept**: application/json
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### HTTP response details
|
|
48
|
+
| Status code | Description | Response headers |
|
|
49
|
+
|-------------|-------------|------------------|
|
|
50
|
+
|**200** | Successful response | - |
|
|
51
|
+
|
|
52
|
+
[[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)
|
|
53
|
+
|
|
54
|
+
# **updateOrganizationModuleSettings**
|
|
55
|
+
> CreateAccountAddress200Response updateOrganizationModuleSettings(organizationModuleSettingsUpdateInputs)
|
|
56
|
+
|
|
57
|
+
Update Organization Module Settings endpoint
|
|
58
|
+
|
|
59
|
+
### Example
|
|
60
|
+
|
|
61
|
+
```typescript
|
|
62
|
+
import {
|
|
63
|
+
OrganizationModulesSettingsApi,
|
|
64
|
+
Configuration,
|
|
65
|
+
OrganizationModuleSettingsUpdateInputs
|
|
66
|
+
} from '@connectedxm/admin-sdk';
|
|
67
|
+
|
|
68
|
+
const configuration = new Configuration();
|
|
69
|
+
const apiInstance = new OrganizationModulesSettingsApi(configuration);
|
|
70
|
+
|
|
71
|
+
let organizationModuleSettingsUpdateInputs: OrganizationModuleSettingsUpdateInputs; //
|
|
72
|
+
|
|
73
|
+
const { status, data } = await apiInstance.updateOrganizationModuleSettings(
|
|
74
|
+
organizationModuleSettingsUpdateInputs
|
|
75
|
+
);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Parameters
|
|
79
|
+
|
|
80
|
+
|Name | Type | Description | Notes|
|
|
81
|
+
|------------- | ------------- | ------------- | -------------|
|
|
82
|
+
| **organizationModuleSettingsUpdateInputs** | **OrganizationModuleSettingsUpdateInputs**| | |
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
### Return type
|
|
86
|
+
|
|
87
|
+
**CreateAccountAddress200Response**
|
|
88
|
+
|
|
89
|
+
### Authorization
|
|
90
|
+
|
|
91
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
92
|
+
|
|
93
|
+
### HTTP request headers
|
|
94
|
+
|
|
95
|
+
- **Content-Type**: application/json
|
|
96
|
+
- **Accept**: application/json
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
### HTTP response details
|
|
100
|
+
| Status code | Description | Response headers |
|
|
101
|
+
|-------------|-------------|------------------|
|
|
102
|
+
|**200** | Successful response | - |
|
|
103
|
+
|
|
104
|
+
[[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)
|
|
105
|
+
|
|
@@ -49,15 +49,7 @@ Name | Type | Description | Notes
|
|
|
49
49
|
**locales** | **Array<string>** | | [optional] [default to undefined]
|
|
50
50
|
**inviteOnly** | **boolean** | | [optional] [default to undefined]
|
|
51
51
|
**googleTagManagerId** | **string** | | [optional] [default to undefined]
|
|
52
|
-
**meetingGroupCallAdminPreset** | **string** | | [optional] [default to undefined]
|
|
53
|
-
**meetingGroupCallGuestPreset** | **string** | | [optional] [default to undefined]
|
|
54
|
-
**meetingWebinarAdminPreset** | **string** | | [optional] [default to undefined]
|
|
55
|
-
**meetingWebinarGuestPreset** | **string** | | [optional] [default to undefined]
|
|
56
|
-
**meetingLivestreamAdminPreset** | **string** | | [optional] [default to undefined]
|
|
57
|
-
**meetingLivestreamGuestPreset** | **string** | | [optional] [default to undefined]
|
|
58
52
|
**_options** | **object** | | [optional] [default to undefined]
|
|
59
|
-
**autoResolveSupportTickets** | **boolean** | | [optional] [default to undefined]
|
|
60
|
-
**autoResolveSupportTicketMessage** | **string** | | [optional] [default to undefined]
|
|
61
53
|
|
|
62
54
|
## Example
|
|
63
55
|
|
|
@@ -109,15 +101,7 @@ const instance: OrganizationUpdateInputs = {
|
|
|
109
101
|
locales,
|
|
110
102
|
inviteOnly,
|
|
111
103
|
googleTagManagerId,
|
|
112
|
-
meetingGroupCallAdminPreset,
|
|
113
|
-
meetingGroupCallGuestPreset,
|
|
114
|
-
meetingWebinarAdminPreset,
|
|
115
|
-
meetingWebinarGuestPreset,
|
|
116
|
-
meetingLivestreamAdminPreset,
|
|
117
|
-
meetingLivestreamGuestPreset,
|
|
118
104
|
_options,
|
|
119
|
-
autoResolveSupportTickets,
|
|
120
|
-
autoResolveSupportTicketMessage,
|
|
121
105
|
};
|
|
122
106
|
```
|
|
123
107
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# SponsorsAccountsApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
4
|
|
|
@@ -17,12 +17,12 @@ Add Level Account endpoint
|
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
19
|
import {
|
|
20
|
-
|
|
20
|
+
SponsorsAccountsApi,
|
|
21
21
|
Configuration
|
|
22
22
|
} from '@connectedxm/admin-sdk';
|
|
23
23
|
|
|
24
24
|
const configuration = new Configuration();
|
|
25
|
-
const apiInstance = new
|
|
25
|
+
const apiInstance = new SponsorsAccountsApi(configuration);
|
|
26
26
|
|
|
27
27
|
let levelId: string; //The level identifier (default to undefined)
|
|
28
28
|
let accountId: string; //The account identifier (default to undefined)
|
|
@@ -71,12 +71,12 @@ Get Level Accounts endpoint
|
|
|
71
71
|
|
|
72
72
|
```typescript
|
|
73
73
|
import {
|
|
74
|
-
|
|
74
|
+
SponsorsAccountsApi,
|
|
75
75
|
Configuration
|
|
76
76
|
} from '@connectedxm/admin-sdk';
|
|
77
77
|
|
|
78
78
|
const configuration = new Configuration();
|
|
79
|
-
const apiInstance = new
|
|
79
|
+
const apiInstance = new SponsorsAccountsApi(configuration);
|
|
80
80
|
|
|
81
81
|
let levelId: string; //The level identifier (default to undefined)
|
|
82
82
|
let page: number; //Page number (optional) (default to 1)
|
|
@@ -134,12 +134,12 @@ Remove Level Account endpoint
|
|
|
134
134
|
|
|
135
135
|
```typescript
|
|
136
136
|
import {
|
|
137
|
-
|
|
137
|
+
SponsorsAccountsApi,
|
|
138
138
|
Configuration
|
|
139
139
|
} from '@connectedxm/admin-sdk';
|
|
140
140
|
|
|
141
141
|
const configuration = new Configuration();
|
|
142
|
-
const apiInstance = new
|
|
142
|
+
const apiInstance = new SponsorsAccountsApi(configuration);
|
|
143
143
|
|
|
144
144
|
let levelId: string; //The level identifier (default to undefined)
|
|
145
145
|
let accountId: string; //The account identifier (default to undefined)
|