@orangefox-recovery/foxinternalclient 5.2.6 → 5.2.8

package/docs/ReleaseApi.md

@@ -1,289 +0,0 @@
-# ReleaseApi
-
-All URIs are relative to *https://api.orangefox.download*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getRelease**](#getrelease) | **GET** /releases/get | Get Release|
-|[**getReleaseDeprecated**](#getreleasedeprecated) | **GET** /releases/{release_id} | Get Release Short|
-|[**getReleases**](#getreleases) | **GET** /releases/ | Get Releases|
-|[**getUpdatesDeprecated**](#getupdatesdeprecated) | **GET** /updates/{last_known_id} | Get Updates|
-
-# **getRelease**
-> ReleaseResponse getRelease()
-
-Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID.  Example: /device/get?codename=lavender  Calling this method without parameters will return the latest available release in the database  Warning: the filename identification is deprecated! Use /release/<release_id> instead!
-
-### Example
-
-```typescript
-import {
-    ReleaseApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new ReleaseApi(configuration);
-
-let releaseId: string; //Release ID (optional) (default to undefined)
-let id: string; //Release ID (deprecated) (optional) (default to undefined)
-let buildId: string; //Build ID, `ro.build.fox_id` prop (optional) (default to undefined)
-let filename: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getRelease(
-    releaseId,
-    id,
-    buildId,
-    filename
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **releaseId** | [**string**] | Release ID | (optional) defaults to undefined|
-| **id** | [**string**] | Release ID (deprecated) | (optional) defaults to undefined|
-| **buildId** | [**string**] | Build ID, &#x60;ro.build.fox_id&#x60; prop | (optional) defaults to undefined|
-| **filename** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ReleaseResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**422** | Validation Error |  -  |
-
-[[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)
-
-# **getReleaseDeprecated**
-> ReleaseResponse getReleaseDeprecated()
-
-Gets release information using the release ID, nothing to discuss really.
-
-### Example
-
-```typescript
-import {
-    ReleaseApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new ReleaseApi(configuration);
-
-let releaseId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.getReleaseDeprecated(
-    releaseId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **releaseId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**ReleaseResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**422** | Validation Error |  -  |
-
-[[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)
-
-# **getReleases**
-> ResponseGetReleases getReleases()
-
-Lists releases.  This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one  (aka get updates).  You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device.  Getting releases by device codename is obsolete thought. The reason for this is that devices could change  codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID  somewhere and use it afterward.  Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod  versions and very different by each maintainer.
-
-### Example
-
-```typescript
-import {
-    ReleaseApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new ReleaseApi(configuration);
-
-let id: Array<string>; //Filter by Release IDs (optional) (default to undefined)
-let id2: Array<string>; //Filter by Release IDs (deprecated) (optional) (default to undefined)
-let buildId: Array<string>; //Filter by Build IDs (optional) (default to undefined)
-let deviceId: Array<string>; //Filter by Device IDs (optional) (default to undefined)
-let maintainerId: Array<string>; //Filter by Maintainer IDs (optional) (default to undefined)
-let codename: Array<string>; //Filter by device codenames (optional) (default to undefined)
-let version: Array<string>; //Filter by release version (optional) (default to undefined)
-let type: Array<ReleaseType>; //Filter by release type (optional) (default to undefined)
-let archived: boolean; //Filter by the archived status (optional) (default to undefined)
-let freezed: boolean; //Filter by the freezed status (optional) (default to undefined)
-let afterReleaseId: string; //Show releases after the provided one (optional) (default to undefined)
-let afterDate: number; //Show releases after the provided timestamp (optional) (default to undefined)
-let sort: ReleasesSort; //Sort mode (optional) (default to undefined)
-let group: boolean; //Group releases by version + variant. This will change the response! (optional) (default to undefined)
-let skip: number; //Skip query results (optional) (default to undefined)
-let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getReleases(
-    id,
-    id2,
-    buildId,
-    deviceId,
-    maintainerId,
-    codename,
-    version,
-    type,
-    archived,
-    freezed,
-    afterReleaseId,
-    afterDate,
-    sort,
-    group,
-    skip,
-    limit
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | **Array&lt;string&gt;** | Filter by Release IDs | (optional) defaults to undefined|
-| **id2** | **Array&lt;string&gt;** | Filter by Release IDs (deprecated) | (optional) defaults to undefined|
-| **buildId** | **Array&lt;string&gt;** | Filter by Build IDs | (optional) defaults to undefined|
-| **deviceId** | **Array&lt;string&gt;** | Filter by Device IDs | (optional) defaults to undefined|
-| **maintainerId** | **Array&lt;string&gt;** | Filter by Maintainer IDs | (optional) defaults to undefined|
-| **codename** | **Array&lt;string&gt;** | Filter by device codenames | (optional) defaults to undefined|
-| **version** | **Array&lt;string&gt;** | Filter by release version | (optional) defaults to undefined|
-| **type** | **Array&lt;ReleaseType&gt;** | Filter by release type | (optional) defaults to undefined|
-| **archived** | [**boolean**] | Filter by the archived status | (optional) defaults to undefined|
-| **freezed** | [**boolean**] | Filter by the freezed status | (optional) defaults to undefined|
-| **afterReleaseId** | [**string**] | Show releases after the provided one | (optional) defaults to undefined|
-| **afterDate** | [**number**] | Show releases after the provided timestamp | (optional) defaults to undefined|
-| **sort** | **ReleasesSort** | Sort mode | (optional) defaults to undefined|
-| **group** | [**boolean**] | Group releases by version + variant. This will change the response! | (optional) defaults to undefined|
-| **skip** | [**number**] | Skip query results | (optional) defaults to undefined|
-| **limit** | [**number**] | Limit query results (0 means unlimited) | (optional) defaults to undefined|
-
-
-### Return type
-
-**ResponseGetReleases**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**404** | Item not found |  -  |
-|**422** | Validation Error |  -  |
-
-[[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)
-
-# **getUpdatesDeprecated**
-> ListResponseShortReleaseResponse getUpdatesDeprecated()
-
-Get updates method. Returns all new releases with release IDs.  For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device.  Warning: This method is obsolete! Please use /release/?after_release_id= instead!
-
-### Example
-
-```typescript
-import {
-    ReleaseApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new ReleaseApi(configuration);
-
-let lastKnownId: string; // (default to undefined)
-let deviceId: Array<string>; //Filter by device ID (optional) (default to undefined)
-let type: Array<ReleaseType>; //Filter by release type (optional) (default to undefined)
-let releaseType: Array<ReleaseType>; //Filter by release type (legacy) (optional) (default to undefined)
-let skip: number; //Skip query results (optional) (default to undefined)
-let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getUpdatesDeprecated(
-    lastKnownId,
-    deviceId,
-    type,
-    releaseType,
-    skip,
-    limit
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **lastKnownId** | [**string**] |  | defaults to undefined|
-| **deviceId** | **Array&lt;string&gt;** | Filter by device ID | (optional) defaults to undefined|
-| **type** | **Array&lt;ReleaseType&gt;** | Filter by release type | (optional) defaults to undefined|
-| **releaseType** | **Array&lt;ReleaseType&gt;** | Filter by release type (legacy) | (optional) defaults to undefined|
-| **skip** | [**number**] | Skip query results | (optional) defaults to undefined|
-| **limit** | [**number**] | Limit query results (0 means unlimited) | (optional) defaults to undefined|
-
-
-### Return type
-
-**ListResponseShortReleaseResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**422** | Validation Error |  -  |
-
-[[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/ReleaseGroupsResponse.md

@@ -1,20 +0,0 @@
-# ReleaseGroupsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | **{ [key: string]: Array<ReleaseResponse>; }** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ReleaseGroupsResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ReleaseGroupsResponse = {
-    data,
-};
-```
-
-[[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/docs/ReleaseInternalResponse.md

@@ -1,62 +0,0 @@
-# ReleaseInternalResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [default to undefined]
-**size** | **number** |  | [default to undefined]
-**id** | **string** | Release ID, that\'s how we indentify the release in the infrastructure | [default to undefined]
-**build_id** | **string** |  | [optional] [default to undefined]
-**filename** | **string** |  | [default to undefined]
-**variant** | **string** |  | [default to undefined]
-**device_id** | **string** |  | [default to undefined]
-**date** | **number** |  | [default to undefined]
-**md5** | **string** |  | [default to undefined]
-**version** | **string** |  | [default to undefined]
-**type** | [**ReleaseType**](ReleaseType.md) |  | [default to undefined]
-**maintainer_id** | **string** |  | [optional] [default to undefined]
-**archived** | **boolean** |  | [default to undefined]
-**recovery_img** | [**RecoveryImgResponse**](RecoveryImgResponse.md) |  | [default to undefined]
-**changelog** | **Array<string>** |  | [default to undefined]
-**bugs** | **Array<string>** |  | [default to undefined]
-**notes** | **string** |  | [default to undefined]
-**prop** | [**{ [key: string]: ReleaseInternalResponsePropValue; }**](ReleaseInternalResponsePropValue.md) |  | [optional] [default to undefined]
-**stats** | [**ReleaseStatsResponse**](ReleaseStatsResponse.md) |  | [optional] [default to undefined]
-**maintainer** | [**MaintainerShortModel**](MaintainerShortModel.md) |  | [default to undefined]
-**url** | **string** | URL of the release on the official website | [readonly] [default to undefined]
-**mirrors** | **{ [key: string]: string; }** | Mirrors list (deprecated) | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ReleaseInternalResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ReleaseInternalResponse = {
-    _id,
-    size,
-    id,
-    build_id,
-    filename,
-    variant,
-    device_id,
-    date,
-    md5,
-    version,
-    type,
-    maintainer_id,
-    archived,
-    recovery_img,
-    changelog,
-    bugs,
-    notes,
-    prop,
-    stats,
-    maintainer,
-    url,
-    mirrors,
-};
-```
-
-[[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/docs/ReleaseInternalResponsePropValue.md

@@ -1,18 +0,0 @@
-# ReleaseInternalResponsePropValue
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Example
-
-```typescript
-import { ReleaseInternalResponsePropValue } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ReleaseInternalResponsePropValue = {
-};
-```
-
-[[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/docs/ReleaseResponse.md

@@ -1,56 +0,0 @@
-# ReleaseResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [default to undefined]
-**size** | **number** |  | [default to undefined]
-**id** | **string** | Release ID, that\'s how we indentify the release in the infrastructure | [default to undefined]
-**build_id** | **string** |  | [optional] [default to undefined]
-**filename** | **string** |  | [default to undefined]
-**variant** | **string** |  | [default to undefined]
-**device_id** | **string** |  | [default to undefined]
-**date** | **number** |  | [default to undefined]
-**md5** | **string** |  | [default to undefined]
-**version** | **string** |  | [default to undefined]
-**type** | [**ReleaseType**](ReleaseType.md) |  | [default to undefined]
-**maintainer_id** | **string** |  | [optional] [default to undefined]
-**archived** | **boolean** |  | [default to undefined]
-**recovery_img** | [**RecoveryImgResponse**](RecoveryImgResponse.md) |  | [default to undefined]
-**changelog** | **Array<string>** |  | [default to undefined]
-**bugs** | **Array<string>** |  | [default to undefined]
-**notes** | **string** |  | [default to undefined]
-**url** | **string** | URL of the release on the official website | [readonly] [default to undefined]
-**mirrors** | **{ [key: string]: string; }** | Mirrors list (deprecated) | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ReleaseResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ReleaseResponse = {
-    _id,
-    size,
-    id,
-    build_id,
-    filename,
-    variant,
-    device_id,
-    date,
-    md5,
-    version,
-    type,
-    maintainer_id,
-    archived,
-    recovery_img,
-    changelog,
-    bugs,
-    notes,
-    url,
-    mirrors,
-};
-```
-
-[[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/docs/ReleaseStatsResponse.md

@@ -1,24 +0,0 @@
-# ReleaseStatsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **number** |  | [default to undefined]
-**days** | **{ [key: string]: number; }** |  | [default to undefined]
-**mirrors** | **{ [key: string]: number; }** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ReleaseStatsResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ReleaseStatsResponse = {
-    count,
-    days,
-    mirrors,
-};
-```
-
-[[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/docs/ReleaseType.md

@@ -1,12 +0,0 @@
-# ReleaseType
-
-
-## Enum
-
-* `Stable` (value: `'stable'`)
-
-* `Beta` (value: `'beta'`)
-
-* `Alpha` (value: `'alpha'`)
-
-[[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/docs/ReleaseUpdateBody.md

@@ -1,26 +0,0 @@
-# ReleaseUpdateBody
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**changelog** | **Array<string>** |  | [optional] [default to undefined]
-**bugs** | **Array<string>** |  | [optional] [default to undefined]
-**notes** | **string** |  | [optional] [default to undefined]
-**freezed** | **boolean** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ReleaseUpdateBody } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ReleaseUpdateBody = {
-    changelog,
-    bugs,
-    notes,
-    freezed,
-};
-```
-
-[[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/docs/ReleasesSort.md

@@ -1,10 +0,0 @@
-# ReleasesSort
-
-
-## Enum
-
-* `DateAsc` (value: `'date_asc'`)
-
-* `DateDesc` (value: `'date_desc'`)
-
-[[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/docs/ResponseGetReleases.md

@@ -1,22 +0,0 @@
-# ResponseGetReleases
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | **{ [key: string]: Array<ReleaseResponse>; }** |  | [default to undefined]
-**count** | **number** |  | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ResponseGetReleases } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ResponseGetReleases = {
-    data,
-    count,
-};
-```
-
-[[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/docs/ShortDeviceResponse.md

@@ -1,38 +0,0 @@
-# ShortDeviceResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [default to undefined]
-**codename** | **string** | Device codename, legacy | [default to undefined]
-**model_name** | **string** | Model name of device, does not include the OEM part, legacy | [default to undefined]
-**oem_name** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**codenames** | **Array<string>** |  | [default to undefined]
-**model_names** | **Array<string>** |  | [default to undefined]
-**supported** | **boolean** |  | [default to undefined]
-**full_name** | **string** | Full name of device / devices, legacy | [readonly] [default to undefined]
-**url** | **string** | URL of the device on the official website | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ShortDeviceResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ShortDeviceResponse = {
-    _id,
-    codename,
-    model_name,
-    oem_name,
-    id,
-    codenames,
-    model_names,
-    supported,
-    full_name,
-    url,
-};
-```
-
-[[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/docs/ShortReleaseResponse.md

@@ -1,44 +0,0 @@
-# ShortReleaseResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [default to undefined]
-**size** | **number** |  | [default to undefined]
-**id** | **string** | Release ID, that\'s how we indentify the release in the infrastructure | [default to undefined]
-**build_id** | **string** |  | [optional] [default to undefined]
-**filename** | **string** |  | [default to undefined]
-**variant** | **string** |  | [default to undefined]
-**device_id** | **string** |  | [default to undefined]
-**date** | **number** |  | [default to undefined]
-**md5** | **string** |  | [default to undefined]
-**version** | **string** |  | [default to undefined]
-**type** | [**ReleaseType**](ReleaseType.md) |  | [default to undefined]
-**maintainer_id** | **string** |  | [optional] [default to undefined]
-**archived** | **boolean** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ShortReleaseResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ShortReleaseResponse = {
-    _id,
-    size,
-    id,
-    build_id,
-    filename,
-    variant,
-    device_id,
-    date,
-    md5,
-    version,
-    type,
-    maintainer_id,
-    archived,
-};
-```
-
-[[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/docs/StatsApi.md

@@ -1,53 +0,0 @@
-# StatsApi
-
-All URIs are relative to *https://api.orangefox.download*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getPublicStats**](#getpublicstats) | **GET** /stats/ | Public Stats|
-
-# **getPublicStats**
-> GlobalStatsAggregationModel getPublicStats()
-
-Returns the global OrangeFox downloads statistics. This request causes an increased load to the database, as it needs to aggregate all the release stats data, therefore, it is limited to a small number of requests per minute for public usage.
-
-### Example
-
-```typescript
-import {
-    StatsApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new StatsApi(configuration);
-
-const { status, data } = await apiInstance.getPublicStats();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**GlobalStatsAggregationModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**429** | Too many requests |  -  |
-
-[[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)
-