mealie-typescript 1.0.5 → 1.0.7

package/docs/AdminMaintenanceApi.md

@@ -1,270 +0,0 @@
-# AdminMaintenanceApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**cleanImagesApiAdminMaintenanceCleanImagesPost**](#cleanimagesapiadminmaintenancecleanimagespost) | **POST** /api/admin/maintenance/clean/images | Clean Images|
-|[**cleanRecipeFoldersApiAdminMaintenanceCleanRecipeFoldersPost**](#cleanrecipefoldersapiadminmaintenancecleanrecipefolderspost) | **POST** /api/admin/maintenance/clean/recipe-folders | Clean Recipe Folders|
-|[**cleanTempApiAdminMaintenanceCleanTempPost**](#cleantempapiadminmaintenancecleantemppost) | **POST** /api/admin/maintenance/clean/temp | Clean Temp|
-|[**getMaintenanceSummaryApiAdminMaintenanceGet**](#getmaintenancesummaryapiadminmaintenanceget) | **GET** /api/admin/maintenance | Get Maintenance Summary|
-|[**getStorageDetailsApiAdminMaintenanceStorageGet**](#getstoragedetailsapiadminmaintenancestorageget) | **GET** /api/admin/maintenance/storage | Get Storage Details|
-
-# **cleanImagesApiAdminMaintenanceCleanImagesPost**
-> SuccessResponse cleanImagesApiAdminMaintenanceCleanImagesPost()
-
-Purges all the images from the filesystem that aren\'t .webp
-
-### Example
-
-```typescript
-import {
-    AdminMaintenanceApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminMaintenanceApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.cleanImagesApiAdminMaintenanceCleanImagesPost(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**SuccessResponse**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-
-# **cleanRecipeFoldersApiAdminMaintenanceCleanRecipeFoldersPost**
-> SuccessResponse cleanRecipeFoldersApiAdminMaintenanceCleanRecipeFoldersPost()
-
-Deletes all the recipe folders that don\'t have names that are valid UUIDs
-
-### Example
-
-```typescript
-import {
-    AdminMaintenanceApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminMaintenanceApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.cleanRecipeFoldersApiAdminMaintenanceCleanRecipeFoldersPost(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**SuccessResponse**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-
-# **cleanTempApiAdminMaintenanceCleanTempPost**
-> SuccessResponse cleanTempApiAdminMaintenanceCleanTempPost()
-
-
-### Example
-
-```typescript
-import {
-    AdminMaintenanceApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminMaintenanceApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.cleanTempApiAdminMaintenanceCleanTempPost(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**SuccessResponse**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-
-# **getMaintenanceSummaryApiAdminMaintenanceGet**
-> MaintenanceSummary getMaintenanceSummaryApiAdminMaintenanceGet()
-
-Get the maintenance summary
-
-### Example
-
-```typescript
-import {
-    AdminMaintenanceApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminMaintenanceApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getMaintenanceSummaryApiAdminMaintenanceGet(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**MaintenanceSummary**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-
-# **getStorageDetailsApiAdminMaintenanceStorageGet**
-> MaintenanceStorageDetails getStorageDetailsApiAdminMaintenanceStorageGet()
-
-
-### Example
-
-```typescript
-import {
-    AdminMaintenanceApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminMaintenanceApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getStorageDetailsApiAdminMaintenanceStorageGet(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**MaintenanceStorageDetails**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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/AdminManageGroupsApi.md

@@ -1,305 +0,0 @@
-# AdminManageGroupsApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createOneApiAdminGroupsPost**](#createoneapiadmingroupspost) | **POST** /api/admin/groups | Create One|
-|[**deleteOneApiAdminGroupsItemIdDelete**](#deleteoneapiadmingroupsitemiddelete) | **DELETE** /api/admin/groups/{item_id} | Delete One|
-|[**getAllApiAdminGroupsGet**](#getallapiadmingroupsget) | **GET** /api/admin/groups | Get All|
-|[**getOneApiAdminGroupsItemIdGet**](#getoneapiadmingroupsitemidget) | **GET** /api/admin/groups/{item_id} | Get One|
-|[**updateOneApiAdminGroupsItemIdPut**](#updateoneapiadmingroupsitemidput) | **PUT** /api/admin/groups/{item_id} | Update One|
-
-# **createOneApiAdminGroupsPost**
-> GroupInDB createOneApiAdminGroupsPost(groupBase)
-
-
-### Example
-
-```typescript
-import {
-    AdminManageGroupsApi,
-    Configuration,
-    GroupBase
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminManageGroupsApi(configuration);
-
-let groupBase: GroupBase; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.createOneApiAdminGroupsPost(
-    groupBase,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **groupBase** | **GroupBase**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**GroupInDB**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | 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)
-
-# **deleteOneApiAdminGroupsItemIdDelete**
-> GroupInDB deleteOneApiAdminGroupsItemIdDelete()
-
-
-### Example
-
-```typescript
-import {
-    AdminManageGroupsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminManageGroupsApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.deleteOneApiAdminGroupsItemIdDelete(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**GroupInDB**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-
-# **getAllApiAdminGroupsGet**
-> GroupPagination getAllApiAdminGroupsGet()
-
-
-### Example
-
-```typescript
-import {
-    AdminManageGroupsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminManageGroupsApi(configuration);
-
-let orderBy: string; // (optional) (default to undefined)
-let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
-let orderDirection: OrderDirection; // (optional) (default to undefined)
-let queryFilter: string; // (optional) (default to undefined)
-let paginationSeed: string; // (optional) (default to undefined)
-let page: number; // (optional) (default to 1)
-let perPage: number; // (optional) (default to 50)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getAllApiAdminGroupsGet(
-    orderBy,
-    orderByNullPosition,
-    orderDirection,
-    queryFilter,
-    paginationSeed,
-    page,
-    perPage,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **orderBy** | [**string**] |  | (optional) defaults to undefined|
-| **orderByNullPosition** | **OrderByNullPosition** |  | (optional) defaults to undefined|
-| **orderDirection** | **OrderDirection** |  | (optional) defaults to undefined|
-| **queryFilter** | [**string**] |  | (optional) defaults to undefined|
-| **paginationSeed** | [**string**] |  | (optional) defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to 1|
-| **perPage** | [**number**] |  | (optional) defaults to 50|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**GroupPagination**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-
-# **getOneApiAdminGroupsItemIdGet**
-> GroupInDB getOneApiAdminGroupsItemIdGet()
-
-
-### Example
-
-```typescript
-import {
-    AdminManageGroupsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminManageGroupsApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getOneApiAdminGroupsItemIdGet(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**GroupInDB**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-
-# **updateOneApiAdminGroupsItemIdPut**
-> GroupInDB updateOneApiAdminGroupsItemIdPut(groupAdminUpdate)
-
-
-### Example
-
-```typescript
-import {
-    AdminManageGroupsApi,
-    Configuration,
-    GroupAdminUpdate
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AdminManageGroupsApi(configuration);
-
-let itemId: string; // (default to undefined)
-let groupAdminUpdate: GroupAdminUpdate; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.updateOneApiAdminGroupsItemIdPut(
-    itemId,
-    groupAdminUpdate,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **groupAdminUpdate** | **GroupAdminUpdate**|  | |
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**GroupInDB**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-