@orangefox-recovery/foxinternalclient 5.2.5 → 5.2.7

package/docs/InternalApi.md

@@ -1,958 +0,0 @@
-# InternalApi
-
-All URIs are relative to *https://api.orangefox.download*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**changePasswordProfileChangePasswordPost**](#changepasswordprofilechangepasswordpost) | **POST** /profile/change_password | Change Password|
-|[**delReleaseInternalReleasesReleaseIdDelete**](#delreleaseinternalreleasesreleaseiddelete) | **DELETE** /internal/releases/{release_id} | Del Release|
-|[**deleteUserInternalUsersUserIdDelete**](#deleteuserinternalusersuseriddelete) | **DELETE** /internal/users/{user_id} | Delete User|
-|[**editReleaseInternalReleasesReleaseIdPut**](#editreleaseinternalreleasesreleaseidput) | **PUT** /internal/releases/{release_id} | Edit Release|
-|[**getDeviceInfoInternalDevicesDeviceIdGet**](#getdeviceinfointernaldevicesdeviceidget) | **GET** /internal/devices/{device_id} | Get Device Info|
-|[**getLogsInternalLogsGet**](#getlogsinternallogsget) | **GET** /internal/logs/ | Get Logs|
-|[**getReleaseInfoInternalReleasesReleaseIdGet**](#getreleaseinfointernalreleasesreleaseidget) | **GET** /internal/releases/{release_id} | Get Release Info|
-|[**getReleaseZipInternalReleasesReleaseIdDlGet**](#getreleasezipinternalreleasesreleaseiddlget) | **GET** /internal/releases/{release_id}/dl | Get Release Zip|
-|[**getUserByIdInternalUsersUserIdGet**](#getuserbyidinternalusersuseridget) | **GET** /internal/users/{user_id} | Get User By Id|
-|[**listUsersInternalUsersGet**](#listusersinternalusersget) | **GET** /internal/users/ | List Users|
-|[**loginOauthAuthLoginPost**](#loginoauthauthloginpost) | **POST** /auth/login | Login Oauth|
-|[**logoutAuthLogoutPost**](#logoutauthlogoutpost) | **POST** /auth/logout | Logout|
-|[**newDeviceInternalDevicesPost**](#newdeviceinternaldevicespost) | **POST** /internal/devices/ | New Device|
-|[**newReleaseInternalReleasesPost**](#newreleaseinternalreleasespost) | **POST** /internal/releases/ | New Release|
-|[**renewAuthRenewPost**](#renewauthrenewpost) | **POST** /auth/renew | Renew|
-|[**updateDeviceInternalDevicesDeviceIdPut**](#updatedeviceinternaldevicesdeviceidput) | **PUT** /internal/devices/{device_id} | Update Device|
-|[**updateUserInternalUsersUserIdPut**](#updateuserinternalusersuseridput) | **PUT** /internal/users/{user_id} | Update User|
-
-# **changePasswordProfileChangePasswordPost**
-> boolean changePasswordProfileChangePasswordPost(bodyChangePasswordProfileChangePasswordPost)
-
-Change the password for a user.
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration,
-    BodyChangePasswordProfileChangePasswordPost
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let bodyChangePasswordProfileChangePasswordPost: BodyChangePasswordProfileChangePasswordPost; //
-
-const { status, data } = await apiInstance.changePasswordProfileChangePasswordPost(
-    bodyChangePasswordProfileChangePasswordPost
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **bodyChangePasswordProfileChangePasswordPost** | **BodyChangePasswordProfileChangePasswordPost**|  | |
-
-
-### Return type
-
-**boolean**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **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)
-
-# **delReleaseInternalReleasesReleaseIdDelete**
-> boolean delReleaseInternalReleasesReleaseIdDelete()
-
-Delete release
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let releaseId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.delReleaseInternalReleasesReleaseIdDelete(
-    releaseId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **releaseId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**boolean**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### 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)
-
-# **deleteUserInternalUsersUserIdDelete**
-> boolean deleteUserInternalUsersUserIdDelete()
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let userId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.deleteUserInternalUsersUserIdDelete(
-    userId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **userId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**boolean**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### 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)
-
-# **editReleaseInternalReleasesReleaseIdPut**
-> boolean editReleaseInternalReleasesReleaseIdPut(releaseUpdateBody)
-
-Edit Release information
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration,
-    ReleaseUpdateBody
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let releaseId: string; // (default to undefined)
-let releaseUpdateBody: ReleaseUpdateBody; //
-
-const { status, data } = await apiInstance.editReleaseInternalReleasesReleaseIdPut(
-    releaseId,
-    releaseUpdateBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **releaseUpdateBody** | **ReleaseUpdateBody**|  | |
-| **releaseId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**boolean**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **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)
-
-# **getDeviceInfoInternalDevicesDeviceIdGet**
-> DeviceInternalResponse getDeviceInfoInternalDevicesDeviceIdGet()
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let deviceId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.getDeviceInfoInternalDevicesDeviceIdGet(
-    deviceId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **deviceId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**DeviceInternalResponse**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### 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)
-
-# **getLogsInternalLogsGet**
-> LogListResponse getLogsInternalLogsGet()
-
-Get a paginated list of logs with optional filtering.
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let page: number; // (optional) (default to 1)
-let perPage: number; // (optional) (default to 20)
-let deviceId: string; // (optional) (default to undefined)
-let releaseId: string; // (optional) (default to undefined)
-let userId: string; // (optional) (default to undefined)
-let hideVerbose: boolean; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getLogsInternalLogsGet(
-    page,
-    perPage,
-    deviceId,
-    releaseId,
-    userId,
-    hideVerbose
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **page** | [**number**] |  | (optional) defaults to 1|
-| **perPage** | [**number**] |  | (optional) defaults to 20|
-| **deviceId** | [**string**] |  | (optional) defaults to undefined|
-| **releaseId** | [**string**] |  | (optional) defaults to undefined|
-| **userId** | [**string**] |  | (optional) defaults to undefined|
-| **hideVerbose** | [**boolean**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**LogListResponse**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### 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)
-
-# **getReleaseInfoInternalReleasesReleaseIdGet**
-> ReleaseInternalResponse getReleaseInfoInternalReleasesReleaseIdGet()
-
-Get release information
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let releaseId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.getReleaseInfoInternalReleasesReleaseIdGet(
-    releaseId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **releaseId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**ReleaseInternalResponse**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### 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)
-
-# **getReleaseZipInternalReleasesReleaseIdDlGet**
-> boolean getReleaseZipInternalReleasesReleaseIdDlGet()
-
-Download release ZIP directly
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let releaseId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.getReleaseZipInternalReleasesReleaseIdDlGet(
-    releaseId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **releaseId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**boolean**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### 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)
-
-# **getUserByIdInternalUsersUserIdGet**
-> UserInternalResponse getUserByIdInternalUsersUserIdGet()
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let userId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.getUserByIdInternalUsersUserIdGet(
-    userId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **userId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**UserInternalResponse**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### 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)
-
-# **listUsersInternalUsersGet**
-> ListResponseUserShortResponse listUsersInternalUsersGet()
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-const { status, data } = await apiInstance.listUsersInternalUsersGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**ListResponseUserShortResponse**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### 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)
-
-# **loginOauthAuthLoginPost**
-> TokenResponse loginOauthAuthLoginPost()
-
-OAuth2 compatible token login, get an access token for future requests
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let username: string; // (default to undefined)
-let password: string; // (default to undefined)
-let minTime: number; // (optional) (default to 0.3)
-let maxTime: number; // (optional) (default to 1)
-let grantType: string; // (optional) (default to undefined)
-let scope: string; // (optional) (default to '')
-let clientId: string; // (optional) (default to undefined)
-let clientSecret: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.loginOauthAuthLoginPost(
-    username,
-    password,
-    minTime,
-    maxTime,
-    grantType,
-    scope,
-    clientId,
-    clientSecret
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **username** | [**string**] |  | defaults to undefined|
-| **password** | [**string**] |  | defaults to undefined|
-| **minTime** | [**number**] |  | (optional) defaults to 0.3|
-| **maxTime** | [**number**] |  | (optional) defaults to 1|
-| **grantType** | [**string**] |  | (optional) defaults to undefined|
-| **scope** | [**string**] |  | (optional) defaults to ''|
-| **clientId** | [**string**] |  | (optional) defaults to undefined|
-| **clientSecret** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**TokenResponse**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### HTTP request headers
-
- - **Content-Type**: application/x-www-form-urlencoded
- - **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)
-
-# **logoutAuthLogoutPost**
-> any logoutAuthLogoutPost(body)
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let body: string; //
-
-const { status, data } = await apiInstance.logoutAuthLogoutPost(
-    body
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **string**|  | |
-
-
-### Return type
-
-**any**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **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)
-
-# **newDeviceInternalDevicesPost**
-> string newDeviceInternalDevicesPost(newDeviceBody)
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration,
-    NewDeviceBody
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let newDeviceBody: NewDeviceBody; //
-
-const { status, data } = await apiInstance.newDeviceInternalDevicesPost(
-    newDeviceBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **newDeviceBody** | **NewDeviceBody**|  | |
-
-
-### Return type
-
-**string**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **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)
-
-# **newReleaseInternalReleasesPost**
-> ReleaseResponse newReleaseInternalReleasesPost()
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let deviceId: string; // (default to undefined)
-let releaseZip: File; // (default to undefined)
-let md5: string; // (default to undefined)
-let changelog: Array<string>; // (default to undefined)
-let bugs: Array<string>; // (optional) (default to undefined)
-let notes: string; // (optional) (default to undefined)
-let force: boolean; // (optional) (default to false)
-
-const { status, data } = await apiInstance.newReleaseInternalReleasesPost(
-    deviceId,
-    releaseZip,
-    md5,
-    changelog,
-    bugs,
-    notes,
-    force
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **deviceId** | [**string**] |  | defaults to undefined|
-| **releaseZip** | [**File**] |  | defaults to undefined|
-| **md5** | [**string**] |  | defaults to undefined|
-| **changelog** | **Array&lt;string&gt;** |  | defaults to undefined|
-| **bugs** | **Array&lt;string&gt;** |  | (optional) defaults to undefined|
-| **notes** | [**string**] |  | (optional) defaults to undefined|
-| **force** | [**boolean**] |  | (optional) defaults to false|
-
-
-### Return type
-
-**ReleaseResponse**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **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)
-
-# **renewAuthRenewPost**
-> string renewAuthRenewPost(body)
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let body: string; //
-
-const { status, data } = await apiInstance.renewAuthRenewPost(
-    body
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **string**|  | |
-
-
-### Return type
-
-**string**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **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)
-
-# **updateDeviceInternalDevicesDeviceIdPut**
-> boolean updateDeviceInternalDevicesDeviceIdPut(deviceUpdateBody)
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration,
-    DeviceUpdateBody
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let deviceId: string; // (default to undefined)
-let deviceUpdateBody: DeviceUpdateBody; //
-
-const { status, data } = await apiInstance.updateDeviceInternalDevicesDeviceIdPut(
-    deviceId,
-    deviceUpdateBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **deviceUpdateBody** | **DeviceUpdateBody**|  | |
-| **deviceId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**boolean**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **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)
-
-# **updateUserInternalUsersUserIdPut**
-> boolean updateUserInternalUsersUserIdPut(userUpdateBody)
-
-
-### Example
-
-```typescript
-import {
-    InternalApi,
-    Configuration,
-    UserUpdateBody
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new InternalApi(configuration);
-
-let userId: string; // (default to undefined)
-let userUpdateBody: UserUpdateBody; //
-
-const { status, data } = await apiInstance.updateUserInternalUsersUserIdPut(
-    userId,
-    userUpdateBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **userUpdateBody** | **UserUpdateBody**|  | |
-| **userId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**boolean**
-
-### Authorization
-
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **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)
-