@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.
Files changed (41) hide show
  1. package/.openapi-generator/FILES +14 -9
  2. package/AdminApi.ts +21 -27
  3. package/README.md +47 -37
  4. package/api.ts +17637 -17396
  5. package/dist/AdminApi.d.ts +8 -10
  6. package/dist/AdminApi.js +7 -9
  7. package/dist/api.d.ts +3139 -3021
  8. package/dist/api.js +8437 -8272
  9. package/dist/esm/AdminApi.d.ts +8 -10
  10. package/dist/esm/AdminApi.js +8 -10
  11. package/dist/esm/api.d.ts +3139 -3021
  12. package/dist/esm/api.js +8043 -7870
  13. package/docs/AccountsApi.md +64 -0
  14. package/docs/ActivitiesApi.md +3 -0
  15. package/docs/BaseOrganizationModuleSettings.md +20 -0
  16. package/docs/BaseOrganizationModuleSettingsTranslation.md +22 -0
  17. package/docs/EventAttendeeCreateInputs.md +20 -0
  18. package/docs/EventsAttendeesApi.md +7 -6
  19. package/docs/FilesApi.md +0 -116
  20. package/docs/Organization.md +0 -16
  21. package/docs/OrganizationModuleSettings.md +36 -0
  22. package/docs/OrganizationModuleSettingsTranslation.md +24 -0
  23. package/docs/OrganizationModuleSettingsTranslationUpdateInputs.md +20 -0
  24. package/docs/OrganizationModuleSettingsUpdateInputs.md +34 -0
  25. package/docs/OrganizationModulesSettingsApi.md +105 -0
  26. package/docs/OrganizationUpdateInputs.md +0 -16
  27. package/docs/{LevelsAccountsApi.md → SponsorsAccountsApi.md} +7 -7
  28. package/docs/{LevelsApi.md → SponsorsApi.md} +11 -11
  29. package/docs/StorageFilesApi.md +181 -0
  30. package/docs/{ImagesApi.md → StorageImagesApi.md} +17 -17
  31. package/docs/{VideosApi.md → StorageVideosApi.md} +15 -15
  32. package/docs/{VideosCaptionsApi.md → StorageVideosCaptionsApi.md} +11 -11
  33. package/docs/SupportApi.md +241 -0
  34. package/docs/SupportMessagesApi.md +64 -0
  35. package/docs/SupportNotesApi.md +64 -0
  36. package/docs/SupportTicketState.md +2 -0
  37. package/package.json +1 -1
  38. package/docs/StorageApi.md +0 -65
  39. package/docs/SupportticketsApi.md +0 -248
  40. package/docs/SupportticketsMessagesApi.md +0 -71
  41. package/docs/SupportticketsNotesApi.md +0 -71
@@ -6,6 +6,10 @@ All URIs are relative to *https://admin-api.connected.dev*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**createSupportTicket**](#createsupportticket) | **POST** /supportTickets | Create Support Ticket|
8
8
  |[**deleteSupportTicket**](#deletesupportticket) | **DELETE** /supportTickets/{supportTicketId} | Delete Support Ticket|
9
+ |[**getSupportTicket**](#getsupportticket) | **GET** /supportTickets/{supportTicketId} | Get Support Ticket|
10
+ |[**getSupportTicketActivity**](#getsupportticketactivity) | **GET** /supportTickets/{supportTicketId}/activityLog | Get Support Ticket Activity|
11
+ |[**getSupportTicketViewer**](#getsupportticketviewer) | **GET** /supportTickets/{supportTicketId}/viewer | Get Support Ticket Viewer|
12
+ |[**getSupportTickets**](#getsupporttickets) | **GET** /supportTickets | Get Support Tickets|
9
13
  |[**updateSupportTicket**](#updatesupportticket) | **PUT** /supportTickets/{supportTicketId} | Update Support Ticket|
10
14
 
11
15
  # **createSupportTicket**
@@ -104,6 +108,243 @@ const { status, data } = await apiInstance.deleteSupportTicket(
104
108
  - **Accept**: application/json
105
109
 
106
110
 
111
+ ### HTTP response details
112
+ | Status code | Description | Response headers |
113
+ |-------------|-------------|------------------|
114
+ |**200** | Successful response | - |
115
+
116
+ [[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)
117
+
118
+ # **getSupportTicket**
119
+ > CreateSupportTicket200Response getSupportTicket()
120
+
121
+ Get Support Ticket endpoint
122
+
123
+ ### Example
124
+
125
+ ```typescript
126
+ import {
127
+ SupportApi,
128
+ Configuration
129
+ } from '@connectedxm/admin-sdk';
130
+
131
+ const configuration = new Configuration();
132
+ const apiInstance = new SupportApi(configuration);
133
+
134
+ let supportTicketId: string; //The supportTicket identifier (default to undefined)
135
+
136
+ const { status, data } = await apiInstance.getSupportTicket(
137
+ supportTicketId
138
+ );
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+ |Name | Type | Description | Notes|
144
+ |------------- | ------------- | ------------- | -------------|
145
+ | **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
146
+
147
+
148
+ ### Return type
149
+
150
+ **CreateSupportTicket200Response**
151
+
152
+ ### Authorization
153
+
154
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
155
+
156
+ ### HTTP request headers
157
+
158
+ - **Content-Type**: Not defined
159
+ - **Accept**: application/json
160
+
161
+
162
+ ### HTTP response details
163
+ | Status code | Description | Response headers |
164
+ |-------------|-------------|------------------|
165
+ |**200** | Successful response | - |
166
+
167
+ [[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)
168
+
169
+ # **getSupportTicketActivity**
170
+ > CreateAccountAddress200Response getSupportTicketActivity()
171
+
172
+ Get Support Ticket Activity endpoint
173
+
174
+ ### Example
175
+
176
+ ```typescript
177
+ import {
178
+ SupportApi,
179
+ Configuration
180
+ } from '@connectedxm/admin-sdk';
181
+
182
+ const configuration = new Configuration();
183
+ const apiInstance = new SupportApi(configuration);
184
+
185
+ let supportTicketId: string; //The supportTicket identifier (default to undefined)
186
+
187
+ const { status, data } = await apiInstance.getSupportTicketActivity(
188
+ supportTicketId
189
+ );
190
+ ```
191
+
192
+ ### Parameters
193
+
194
+ |Name | Type | Description | Notes|
195
+ |------------- | ------------- | ------------- | -------------|
196
+ | **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
197
+
198
+
199
+ ### Return type
200
+
201
+ **CreateAccountAddress200Response**
202
+
203
+ ### Authorization
204
+
205
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: Not defined
210
+ - **Accept**: application/json
211
+
212
+
213
+ ### HTTP response details
214
+ | Status code | Description | Response headers |
215
+ |-------------|-------------|------------------|
216
+ |**200** | Successful response | - |
217
+
218
+ [[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)
219
+
220
+ # **getSupportTicketViewer**
221
+ > GetAccountInvitations200Response getSupportTicketViewer()
222
+
223
+ Get Support Ticket Viewer endpoint
224
+
225
+ ### Example
226
+
227
+ ```typescript
228
+ import {
229
+ SupportApi,
230
+ Configuration
231
+ } from '@connectedxm/admin-sdk';
232
+
233
+ const configuration = new Configuration();
234
+ const apiInstance = new SupportApi(configuration);
235
+
236
+ let supportTicketId: string; //The supportTicket identifier (default to undefined)
237
+ let orgMembershipId: string; //Filter by orgMembershipId (optional) (default to undefined)
238
+ let page: number; //Page number (optional) (default to 1)
239
+ let pageSize: number; //Number of items per page (optional) (default to 25)
240
+ let orderBy: string; //Field to order by (optional) (default to undefined)
241
+ let search: string; //Search query (optional) (default to undefined)
242
+
243
+ const { status, data } = await apiInstance.getSupportTicketViewer(
244
+ supportTicketId,
245
+ orgMembershipId,
246
+ page,
247
+ pageSize,
248
+ orderBy,
249
+ search
250
+ );
251
+ ```
252
+
253
+ ### Parameters
254
+
255
+ |Name | Type | Description | Notes|
256
+ |------------- | ------------- | ------------- | -------------|
257
+ | **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
258
+ | **orgMembershipId** | [**string**] | Filter by orgMembershipId | (optional) defaults to undefined|
259
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
260
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
261
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
262
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
263
+
264
+
265
+ ### Return type
266
+
267
+ **GetAccountInvitations200Response**
268
+
269
+ ### Authorization
270
+
271
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
272
+
273
+ ### HTTP request headers
274
+
275
+ - **Content-Type**: Not defined
276
+ - **Accept**: application/json
277
+
278
+
279
+ ### HTTP response details
280
+ | Status code | Description | Response headers |
281
+ |-------------|-------------|------------------|
282
+ |**200** | Successful response | - |
283
+
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
+
286
+ # **getSupportTickets**
287
+ > GetSupportTickets200Response getSupportTickets()
288
+
289
+ Get Support Tickets endpoint
290
+
291
+ ### Example
292
+
293
+ ```typescript
294
+ import {
295
+ SupportApi,
296
+ Configuration
297
+ } from '@connectedxm/admin-sdk';
298
+
299
+ const configuration = new Configuration();
300
+ const apiInstance = new SupportApi(configuration);
301
+
302
+ let type: string; //Filter by type (optional) (default to undefined)
303
+ let state: string; //Filter by state (optional) (default to undefined)
304
+ let assignment: 'me' | 'unassigned'; //Filter by assignment (optional) (default to undefined)
305
+ let page: number; //Page number (optional) (default to 1)
306
+ let pageSize: number; //Number of items per page (optional) (default to 25)
307
+ let orderBy: string; //Field to order by (optional) (default to undefined)
308
+ let search: string; //Search query (optional) (default to undefined)
309
+
310
+ const { status, data } = await apiInstance.getSupportTickets(
311
+ type,
312
+ state,
313
+ assignment,
314
+ page,
315
+ pageSize,
316
+ orderBy,
317
+ search
318
+ );
319
+ ```
320
+
321
+ ### Parameters
322
+
323
+ |Name | Type | Description | Notes|
324
+ |------------- | ------------- | ------------- | -------------|
325
+ | **type** | [**string**] | Filter by type | (optional) defaults to undefined|
326
+ | **state** | [**string**] | Filter by state | (optional) defaults to undefined|
327
+ | **assignment** | [**&#39;me&#39; | &#39;unassigned&#39;**]**Array<&#39;me&#39; &#124; &#39;unassigned&#39;>** | Filter by assignment | (optional) defaults to undefined|
328
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
329
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
330
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
331
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
332
+
333
+
334
+ ### Return type
335
+
336
+ **GetSupportTickets200Response**
337
+
338
+ ### Authorization
339
+
340
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: Not defined
345
+ - **Accept**: application/json
346
+
347
+
107
348
  ### HTTP response details
108
349
  | Status code | Description | Response headers |
109
350
  |-------------|-------------|------------------|
@@ -5,6 +5,7 @@ All URIs are relative to *https://admin-api.connected.dev*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**createSupportTicketMessage**](#createsupportticketmessage) | **POST** /supportTickets/{supportTicketId}/messages | Create Support Ticket Message|
8
+ |[**getSupportTicketMessages**](#getsupportticketmessages) | **GET** /supportTickets/{supportTicketId}/messages | Get Support Ticket Messages|
8
9
 
9
10
  # **createSupportTicketMessage**
10
11
  > CreateAccountAddress200Response createSupportTicketMessage(supportTicketMessageCreateInputs)
@@ -61,3 +62,66 @@ const { status, data } = await apiInstance.createSupportTicketMessage(
61
62
 
62
63
  [[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)
63
64
 
65
+ # **getSupportTicketMessages**
66
+ > GetAccountInvitations200Response getSupportTicketMessages()
67
+
68
+ Get Support Ticket Messages endpoint
69
+
70
+ ### Example
71
+
72
+ ```typescript
73
+ import {
74
+ SupportMessagesApi,
75
+ Configuration
76
+ } from '@connectedxm/admin-sdk';
77
+
78
+ const configuration = new Configuration();
79
+ const apiInstance = new SupportMessagesApi(configuration);
80
+
81
+ let supportTicketId: string; //The supportTicket identifier (default to undefined)
82
+ let page: number; //Page number (optional) (default to 1)
83
+ let pageSize: number; //Number of items per page (optional) (default to 25)
84
+ let orderBy: string; //Field to order by (optional) (default to undefined)
85
+ let search: string; //Search query (optional) (default to undefined)
86
+
87
+ const { status, data } = await apiInstance.getSupportTicketMessages(
88
+ supportTicketId,
89
+ page,
90
+ pageSize,
91
+ orderBy,
92
+ search
93
+ );
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ |Name | Type | Description | Notes|
99
+ |------------- | ------------- | ------------- | -------------|
100
+ | **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
101
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
102
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
103
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
104
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
105
+
106
+
107
+ ### Return type
108
+
109
+ **GetAccountInvitations200Response**
110
+
111
+ ### Authorization
112
+
113
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: Not defined
118
+ - **Accept**: application/json
119
+
120
+
121
+ ### HTTP response details
122
+ | Status code | Description | Response headers |
123
+ |-------------|-------------|------------------|
124
+ |**200** | Successful response | - |
125
+
126
+ [[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)
127
+
@@ -6,6 +6,7 @@ All URIs are relative to *https://admin-api.connected.dev*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**createSupportTicketNote**](#createsupportticketnote) | **POST** /supportTickets/{supportTicketId}/notes | Create Support Ticket Note|
8
8
  |[**deleteSupportTicketNote**](#deletesupportticketnote) | **DELETE** /supportTickets/{supportTicketId}/notes/{noteId} | Delete Support Ticket Note|
9
+ |[**getSupportTicketNotes**](#getsupportticketnotes) | **GET** /supportTickets/{supportTicketId}/notes | Get Support Ticket Notes|
9
10
 
10
11
  # **createSupportTicketNote**
11
12
  > CreateAccountAddress200Response createSupportTicketNote(supportTicketNoteCreateInputs)
@@ -116,3 +117,66 @@ const { status, data } = await apiInstance.deleteSupportTicketNote(
116
117
 
117
118
  [[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)
118
119
 
120
+ # **getSupportTicketNotes**
121
+ > GetAccountInvitations200Response getSupportTicketNotes()
122
+
123
+ Get Support Ticket Notes endpoint
124
+
125
+ ### Example
126
+
127
+ ```typescript
128
+ import {
129
+ SupportNotesApi,
130
+ Configuration
131
+ } from '@connectedxm/admin-sdk';
132
+
133
+ const configuration = new Configuration();
134
+ const apiInstance = new SupportNotesApi(configuration);
135
+
136
+ let supportTicketId: string; //The supportTicket identifier (default to undefined)
137
+ let page: number; //Page number (optional) (default to 1)
138
+ let pageSize: number; //Number of items per page (optional) (default to 25)
139
+ let orderBy: string; //Field to order by (optional) (default to undefined)
140
+ let search: string; //Search query (optional) (default to undefined)
141
+
142
+ const { status, data } = await apiInstance.getSupportTicketNotes(
143
+ supportTicketId,
144
+ page,
145
+ pageSize,
146
+ orderBy,
147
+ search
148
+ );
149
+ ```
150
+
151
+ ### Parameters
152
+
153
+ |Name | Type | Description | Notes|
154
+ |------------- | ------------- | ------------- | -------------|
155
+ | **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
156
+ | **page** | [**number**] | Page number | (optional) defaults to 1|
157
+ | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
158
+ | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
159
+ | **search** | [**string**] | Search query | (optional) defaults to undefined|
160
+
161
+
162
+ ### Return type
163
+
164
+ **GetAccountInvitations200Response**
165
+
166
+ ### Authorization
167
+
168
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
169
+
170
+ ### HTTP request headers
171
+
172
+ - **Content-Type**: Not defined
173
+ - **Accept**: application/json
174
+
175
+
176
+ ### HTTP response details
177
+ | Status code | Description | Response headers |
178
+ |-------------|-------------|------------------|
179
+ |**200** | Successful response | - |
180
+
181
+ [[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)
182
+
@@ -11,4 +11,6 @@
11
11
 
12
12
  * `Spam` (value: `'spam'`)
13
13
 
14
+ * `Archived` (value: `'archived'`)
15
+
14
16
  [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "6.6.2",
3
+ "version": "6.7.4",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -1,65 +0,0 @@
1
- # StorageApi
2
-
3
- All URIs are relative to *https://admin-api.connected.dev*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**uploadFile**](#uploadfile) | **POST** /files | Upload File|
8
-
9
- # **uploadFile**
10
- > UploadFile200Response uploadFile()
11
-
12
- Upload File endpoint
13
-
14
- ### Example
15
-
16
- ```typescript
17
- import {
18
- StorageApi,
19
- Configuration
20
- } from '@connectedxm/admin-sdk';
21
-
22
- const configuration = new Configuration();
23
- const apiInstance = new StorageApi(configuration);
24
-
25
- let dataUri: string; //Filter by dataUri (default to undefined)
26
- let source: 'admin' | 'response'; //Filter by source (default to undefined)
27
- let name: string; //Filter by name (optional) (default to undefined)
28
-
29
- const { status, data } = await apiInstance.uploadFile(
30
- dataUri,
31
- source,
32
- name
33
- );
34
- ```
35
-
36
- ### Parameters
37
-
38
- |Name | Type | Description | Notes|
39
- |------------- | ------------- | ------------- | -------------|
40
- | **dataUri** | [**string**] | Filter by dataUri | defaults to undefined|
41
- | **source** | [**&#39;admin&#39; | &#39;response&#39;**]**Array<&#39;admin&#39; &#124; &#39;response&#39;>** | Filter by source | defaults to undefined|
42
- | **name** | [**string**] | Filter by name | (optional) defaults to undefined|
43
-
44
-
45
- ### Return type
46
-
47
- **UploadFile200Response**
48
-
49
- ### Authorization
50
-
51
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
52
-
53
- ### HTTP request headers
54
-
55
- - **Content-Type**: Not defined
56
- - **Accept**: application/json
57
-
58
-
59
- ### HTTP response details
60
- | Status code | Description | Response headers |
61
- |-------------|-------------|------------------|
62
- |**200** | Successful response | - |
63
-
64
- [[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)
65
-