@connectedxm/admin-sdk 6.6.2 → 6.7.4

package/docs/{LevelsApi.md → SponsorsApi.md}

@@ -1,4 +1,4 @@
-# LevelsApi
+# SponsorsApi
 
 All URIs are relative to *https://admin-api.connected.dev*
 
@@ -19,13 +19,13 @@ Create Level endpoint
 
 ```typescript
 import {
-    LevelsApi,
+    SponsorsApi,
     Configuration,
     LevelCreateInputs
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new LevelsApi(configuration);
+const apiInstance = new SponsorsApi(configuration);
 
 let levelCreateInputs: LevelCreateInputs; //
 
@@ -71,12 +71,12 @@ Delete Level endpoint
 
 ```typescript
 import {
-    LevelsApi,
+    SponsorsApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new LevelsApi(configuration);
+const apiInstance = new SponsorsApi(configuration);
 
 let levelId: string; //The level identifier (default to undefined)
 
@@ -122,12 +122,12 @@ Get Level endpoint
 
 ```typescript
 import {
-    LevelsApi,
+    SponsorsApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new LevelsApi(configuration);
+const apiInstance = new SponsorsApi(configuration);
 
 let sponsorshipLevelId: string; //The sponsorshipLevel identifier (default to undefined)
 
@@ -173,12 +173,12 @@ Get Levels endpoint
 
 ```typescript
 import {
-    LevelsApi,
+    SponsorsApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new LevelsApi(configuration);
+const apiInstance = new SponsorsApi(configuration);
 
 let page: number; //Page number (optional) (default to 1)
 let pageSize: number; //Number of items per page (optional) (default to 25)
@@ -233,13 +233,13 @@ Update Level endpoint
 
 ```typescript
 import {
-    LevelsApi,
+    SponsorsApi,
     Configuration,
     LevelUpdateInputs
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new LevelsApi(configuration);
+const apiInstance = new SponsorsApi(configuration);
 
 let levelId: string; //The level identifier (default to undefined)
 let level: LevelUpdateInputs; //Filter by level (default to undefined)

package/docs/StorageFilesApi.md

@@ -0,0 +1,181 @@
+# StorageFilesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getFile**](#getfile) | **GET** /files/{fileId} | Get File|
+|[**getFiles**](#getfiles) | **GET** /files | Get Files|
+|[**uploadFile**](#uploadfile) | **POST** /files | Upload File|
+
+# **getFile**
+> UploadFile200Response getFile()
+
+Get File endpoint
+
+### Example
+
+```typescript
+import {
+    StorageFilesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StorageFilesApi(configuration);
+
+let fileId: string; //The file identifier (default to undefined)
+
+const { status, data } = await apiInstance.getFile(
+    fileId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **fileId** | [**string**] | The file identifier | defaults to undefined|
+
+
+### Return type
+
+**UploadFile200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getFiles**
+> GetFiles200Response getFiles()
+
+Get Files endpoint
+
+### Example
+
+```typescript
+import {
+    StorageFilesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StorageFilesApi(configuration);
+
+let source: string; //Filter by source (optional) (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getFiles(
+    source,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **source** | [**string**] | Filter by source | (optional) defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetFiles200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **uploadFile**
+> UploadFile200Response uploadFile()
+
+Upload File endpoint
+
+### Example
+
+```typescript
+import {
+    StorageFilesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StorageFilesApi(configuration);
+
+let dataUri: string; //Filter by dataUri (default to undefined)
+let source: 'admin' | 'response'; //Filter by source (default to undefined)
+let name: string; //Filter by name (optional) (default to undefined)
+
+const { status, data } = await apiInstance.uploadFile(
+    dataUri,
+    source,
+    name
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **dataUri** | [**string**] | Filter by dataUri | defaults to undefined|
+| **source** | [**&#39;admin&#39; | &#39;response&#39;**]**Array<&#39;admin&#39; &#124; &#39;response&#39;>** | Filter by source | defaults to undefined|
+| **name** | [**string**] | Filter by name | (optional) defaults to undefined|
+
+
+### Return type
+
+**UploadFile200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+

package/docs/{ImagesApi.md → StorageImagesApi.md}

@@ -1,4 +1,4 @@
-# ImagesApi
+# StorageImagesApi
 
 All URIs are relative to *https://admin-api.connected.dev*
 
@@ -22,13 +22,13 @@ Create Image endpoint
 
 ```typescript
 import {
-    ImagesApi,
+    StorageImagesApi,
     Configuration,
     ImageCreateInputs
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new ImagesApi(configuration);
+const apiInstance = new StorageImagesApi(configuration);
 
 let imageCreateInputs: ImageCreateInputs; //
 
@@ -74,12 +74,12 @@ Delete Image endpoint
 
 ```typescript
 import {
-    ImagesApi,
+    StorageImagesApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new ImagesApi(configuration);
+const apiInstance = new StorageImagesApi(configuration);
 
 let imageId: string; //The image identifier (default to undefined)
 
@@ -125,12 +125,12 @@ Delete Many Images endpoint
 
 ```typescript
 import {
-    ImagesApi,
+    StorageImagesApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new ImagesApi(configuration);
+const apiInstance = new StorageImagesApi(configuration);
 
 let imageIds: Array<string>; //Filter by imageIds (default to undefined)
 
@@ -176,12 +176,12 @@ Get Image endpoint
 
 ```typescript
 import {
-    ImagesApi,
+    StorageImagesApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new ImagesApi(configuration);
+const apiInstance = new StorageImagesApi(configuration);
 
 let imageId: string; //The image identifier (default to undefined)
 
@@ -227,12 +227,12 @@ Get Image Usage endpoint
 
 ```typescript
 import {
-    ImagesApi,
+    StorageImagesApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new ImagesApi(configuration);
+const apiInstance = new StorageImagesApi(configuration);
 
 let imageId: string; //The image identifier (default to undefined)
 
@@ -278,12 +278,12 @@ Get Images endpoint
 
 ```typescript
 import {
-    ImagesApi,
+    StorageImagesApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new ImagesApi(configuration);
+const apiInstance = new StorageImagesApi(configuration);
 
 let type: ImageType; //Filter by type (optional) (default to undefined)
 let page: number; //Page number (optional) (default to 1)
@@ -341,12 +341,12 @@ Switch Image endpoint
 
 ```typescript
 import {
-    ImagesApi,
+    StorageImagesApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new ImagesApi(configuration);
+const apiInstance = new StorageImagesApi(configuration);
 
 let imageId: string; //The image identifier (default to undefined)
 let image: object; //Filter by image (default to undefined)
@@ -395,13 +395,13 @@ Update Image endpoint
 
 ```typescript
 import {
-    ImagesApi,
+    StorageImagesApi,
     Configuration,
     ImageUpdateInputs
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new ImagesApi(configuration);
+const apiInstance = new StorageImagesApi(configuration);
 
 let imageId: string; //The image identifier (default to undefined)
 let imageUpdateInputs: ImageUpdateInputs; //

package/docs/{VideosApi.md → StorageVideosApi.md}

@@ -1,4 +1,4 @@
-# VideosApi
+# StorageVideosApi
 
 All URIs are relative to *https://admin-api.connected.dev*
 
@@ -21,12 +21,12 @@ Delete Many Videos endpoint
 
 ```typescript
 import {
-    VideosApi,
+    StorageVideosApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosApi(configuration);
+const apiInstance = new StorageVideosApi(configuration);
 
 let videoIds: Array<string>; //Filter by videoIds (default to undefined)
 
@@ -72,12 +72,12 @@ Delete Video endpoint
 
 ```typescript
 import {
-    VideosApi,
+    StorageVideosApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosApi(configuration);
+const apiInstance = new StorageVideosApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 
@@ -123,12 +123,12 @@ Get Video endpoint
 
 ```typescript
 import {
-    VideosApi,
+    StorageVideosApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosApi(configuration);
+const apiInstance = new StorageVideosApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 
@@ -174,12 +174,12 @@ Get Video Download Status endpoint
 
 ```typescript
 import {
-    VideosApi,
+    StorageVideosApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosApi(configuration);
+const apiInstance = new StorageVideosApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 
@@ -225,12 +225,12 @@ Get Videos endpoint
 
 ```typescript
 import {
-    VideosApi,
+    StorageVideosApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosApi(configuration);
+const apiInstance = new StorageVideosApi(configuration);
 
 let source: string; //Filter by source (optional) (default to undefined)
 let page: number; //Page number (optional) (default to 1)
@@ -288,12 +288,12 @@ Initiate Video Download endpoint
 
 ```typescript
 import {
-    VideosApi,
+    StorageVideosApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosApi(configuration);
+const apiInstance = new StorageVideosApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 
@@ -339,13 +339,13 @@ Update Video endpoint
 
 ```typescript
 import {
-    VideosApi,
+    StorageVideosApi,
     Configuration,
     VideoUpdateInputs
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosApi(configuration);
+const apiInstance = new StorageVideosApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 let videoUpdateInputs: VideoUpdateInputs; //

package/docs/{VideosCaptionsApi.md → StorageVideosCaptionsApi.md}

@@ -1,4 +1,4 @@
-# VideosCaptionsApi
+# StorageVideosCaptionsApi
 
 All URIs are relative to *https://admin-api.connected.dev*
 
@@ -19,12 +19,12 @@ Delete Video Caption endpoint
 
 ```typescript
 import {
-    VideosCaptionsApi,
+    StorageVideosCaptionsApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosCaptionsApi(configuration);
+const apiInstance = new StorageVideosCaptionsApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 let language: string; //The language identifier (default to undefined)
@@ -73,12 +73,12 @@ Download Video Caption endpoint
 
 ```typescript
 import {
-    VideosCaptionsApi,
+    StorageVideosCaptionsApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosCaptionsApi(configuration);
+const apiInstance = new StorageVideosCaptionsApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 let language: string; //The language identifier (default to undefined)
@@ -127,12 +127,12 @@ Generate Video Captions endpoint
 
 ```typescript
 import {
-    VideosCaptionsApi,
+    StorageVideosCaptionsApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosCaptionsApi(configuration);
+const apiInstance = new StorageVideosCaptionsApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 let language: string; //The language identifier (default to undefined)
@@ -181,12 +181,12 @@ Get Video Captions endpoint
 
 ```typescript
 import {
-    VideosCaptionsApi,
+    StorageVideosCaptionsApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosCaptionsApi(configuration);
+const apiInstance = new StorageVideosCaptionsApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 let page: number; //Page number (optional) (default to 1)
@@ -244,12 +244,12 @@ Upload Video Captions endpoint
 
 ```typescript
 import {
-    VideosCaptionsApi,
+    StorageVideosCaptionsApi,
     Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
-const apiInstance = new VideosCaptionsApi(configuration);
+const apiInstance = new StorageVideosCaptionsApi(configuration);
 
 let videoId: string; //The video identifier (default to undefined)
 let language: string; //The language identifier (default to undefined)