mealie-typescript 1.0.0

package/docs/AdminAboutApi.md

@@ -0,0 +1,164 @@
+# AdminAboutApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**checkAppConfigApiAdminAboutCheckGet**](#checkappconfigapiadminaboutcheckget) | **GET** /api/admin/about/check | Check App Config|
+|[**getAppInfoApiAdminAboutGet**](#getappinfoapiadminaboutget) | **GET** /api/admin/about | Get App Info|
+|[**getAppStatisticsApiAdminAboutStatisticsGet**](#getappstatisticsapiadminaboutstatisticsget) | **GET** /api/admin/about/statistics | Get App Statistics|
+
+# **checkAppConfigApiAdminAboutCheckGet**
+> CheckAppConfig checkAppConfigApiAdminAboutCheckGet()
+
+
+### Example
+
+```typescript
+import {
+    AdminAboutApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminAboutApi(configuration);
+
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.checkAppConfigApiAdminAboutCheckGet(
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**CheckAppConfig**
+
+### 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)
+
+# **getAppInfoApiAdminAboutGet**
+> AdminAboutInfo getAppInfoApiAdminAboutGet()
+
+Get general application information
+
+### Example
+
+```typescript
+import {
+    AdminAboutApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminAboutApi(configuration);
+
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getAppInfoApiAdminAboutGet(
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**AdminAboutInfo**
+
+### 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)
+
+# **getAppStatisticsApiAdminAboutStatisticsGet**
+> AppStatistics getAppStatisticsApiAdminAboutStatisticsGet()
+
+
+### Example
+
+```typescript
+import {
+    AdminAboutApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminAboutApi(configuration);
+
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getAppStatisticsApiAdminAboutStatisticsGet(
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**AppStatistics**
+
+### 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/AdminAboutInfo.md

@@ -0,0 +1,62 @@
+# AdminAboutInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**production** | **boolean** |  | [default to undefined]
+**version** | **string** |  | [default to undefined]
+**demoStatus** | **boolean** |  | [default to undefined]
+**allowSignup** | **boolean** |  | [default to undefined]
+**allowPasswordLogin** | **boolean** |  | [default to undefined]
+**defaultGroupSlug** | **string** |  | [optional] [default to undefined]
+**defaultHouseholdSlug** | **string** |  | [optional] [default to undefined]
+**enableOidc** | **boolean** |  | [default to undefined]
+**oidcRedirect** | **boolean** |  | [default to undefined]
+**oidcProviderName** | **string** |  | [default to undefined]
+**enableOpenai** | **boolean** |  | [default to undefined]
+**enableOpenaiImageServices** | **boolean** |  | [default to undefined]
+**tokenTime** | **number** |  | [default to undefined]
+**versionLatest** | **string** |  | [default to undefined]
+**apiPort** | **number** |  | [default to undefined]
+**apiDocs** | **boolean** |  | [default to undefined]
+**dbType** | **string** |  | [default to undefined]
+**dbUrl** | **string** |  | [optional] [default to undefined]
+**defaultGroup** | **string** |  | [default to undefined]
+**defaultHousehold** | **string** |  | [default to undefined]
+**buildId** | **string** |  | [default to undefined]
+**recipeScraperVersion** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AdminAboutInfo } from 'mealie-typescript';
+
+const instance: AdminAboutInfo = {
+    production,
+    version,
+    demoStatus,
+    allowSignup,
+    allowPasswordLogin,
+    defaultGroupSlug,
+    defaultHouseholdSlug,
+    enableOidc,
+    oidcRedirect,
+    oidcProviderName,
+    enableOpenai,
+    enableOpenaiImageServices,
+    tokenTime,
+    versionLatest,
+    apiPort,
+    apiDocs,
+    dbType,
+    dbUrl,
+    defaultGroup,
+    defaultHousehold,
+    buildId,
+    recipeScraperVersion,
+};
+```
+
+[[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/AdminBackupsApi.md

@@ -0,0 +1,333 @@
+# AdminBackupsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createOneApiAdminBackupsPost**](#createoneapiadminbackupspost) | **POST** /api/admin/backups | Create One|
+|[**deleteOneApiAdminBackupsFileNameDelete**](#deleteoneapiadminbackupsfilenamedelete) | **DELETE** /api/admin/backups/{file_name} | Delete One|
+|[**getAllApiAdminBackupsGet**](#getallapiadminbackupsget) | **GET** /api/admin/backups | Get All|
+|[**getOneApiAdminBackupsFileNameGet**](#getoneapiadminbackupsfilenameget) | **GET** /api/admin/backups/{file_name} | Get One|
+|[**importOneApiAdminBackupsFileNameRestorePost**](#importoneapiadminbackupsfilenamerestorepost) | **POST** /api/admin/backups/{file_name}/restore | Import One|
+|[**uploadOneApiAdminBackupsUploadPost**](#uploadoneapiadminbackupsuploadpost) | **POST** /api/admin/backups/upload | Upload One|
+
+# **createOneApiAdminBackupsPost**
+> SuccessResponse createOneApiAdminBackupsPost()
+
+
+### Example
+
+```typescript
+import {
+    AdminBackupsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminBackupsApi(configuration);
+
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.createOneApiAdminBackupsPost(
+    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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **deleteOneApiAdminBackupsFileNameDelete**
+> SuccessResponse deleteOneApiAdminBackupsFileNameDelete()
+
+
+### Example
+
+```typescript
+import {
+    AdminBackupsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminBackupsApi(configuration);
+
+let fileName: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.deleteOneApiAdminBackupsFileNameDelete(
+    fileName,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **fileName** | [**string**] |  | defaults to undefined|
+| **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)
+
+# **getAllApiAdminBackupsGet**
+> AllBackups getAllApiAdminBackupsGet()
+
+
+### Example
+
+```typescript
+import {
+    AdminBackupsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminBackupsApi(configuration);
+
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getAllApiAdminBackupsGet(
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**AllBackups**
+
+### 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)
+
+# **getOneApiAdminBackupsFileNameGet**
+> FileTokenResponse getOneApiAdminBackupsFileNameGet()
+
+Returns a token to download a file
+
+### Example
+
+```typescript
+import {
+    AdminBackupsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminBackupsApi(configuration);
+
+let fileName: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getOneApiAdminBackupsFileNameGet(
+    fileName,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **fileName** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**FileTokenResponse**
+
+### 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)
+
+# **importOneApiAdminBackupsFileNameRestorePost**
+> SuccessResponse importOneApiAdminBackupsFileNameRestorePost()
+
+
+### Example
+
+```typescript
+import {
+    AdminBackupsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminBackupsApi(configuration);
+
+let fileName: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.importOneApiAdminBackupsFileNameRestorePost(
+    fileName,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **fileName** | [**string**] |  | defaults to undefined|
+| **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)
+
+# **uploadOneApiAdminBackupsUploadPost**
+> SuccessResponse uploadOneApiAdminBackupsUploadPost()
+
+Upload a .zip File to later be imported into Mealie
+
+### Example
+
+```typescript
+import {
+    AdminBackupsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminBackupsApi(configuration);
+
+let archive: File; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.uploadOneApiAdminBackupsUploadPost(
+    archive,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **archive** | [**File**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### 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)
+

package/docs/AdminDebugApi.md

@@ -0,0 +1,62 @@
+# AdminDebugApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**debugOpenaiApiAdminDebugOpenaiPost**](#debugopenaiapiadmindebugopenaipost) | **POST** /api/admin/debug/openai | Debug Openai|
+
+# **debugOpenaiApiAdminDebugOpenaiPost**
+> DebugResponse debugOpenaiApiAdminDebugOpenaiPost()
+
+
+### Example
+
+```typescript
+import {
+    AdminDebugApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new AdminDebugApi(configuration);
+
+let acceptLanguage: string; // (optional) (default to undefined)
+let image: File; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.debugOpenaiApiAdminDebugOpenaiPost(
+    acceptLanguage,
+    image
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+| **image** | [**File**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**DebugResponse**
+
+### Authorization
+
+[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### 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)
+