mealie-typescript 1.0.6 → 1.0.8

package/docs/AllBackups.md

@@ -1,22 +0,0 @@
-# AllBackups
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**imports** | [**Array<BackupFile>**](BackupFile.md) |  | [default to undefined]
-**templates** | **Array<string>** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AllBackups } from 'mealie-typescript';
-
-const instance: AllBackups = {
-    imports,
-    templates,
-};
-```
-
-[[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/AppAboutApi.md

@@ -1,142 +0,0 @@
-# AppAboutApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getAppInfoApiAppAboutGet**](#getappinfoapiappaboutget) | **GET** /api/app/about | Get App Info|
-|[**getAppThemeApiAppAboutThemeGet**](#getappthemeapiappaboutthemeget) | **GET** /api/app/about/theme | Get App Theme|
-|[**getStartupInfoApiAppAboutStartupInfoGet**](#getstartupinfoapiappaboutstartupinfoget) | **GET** /api/app/about/startup-info | Get Startup Info|
-
-# **getAppInfoApiAppAboutGet**
-> AppInfo getAppInfoApiAppAboutGet()
-
-Get general application information
-
-### Example
-
-```typescript
-import {
-    AppAboutApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AppAboutApi(configuration);
-
-const { status, data } = await apiInstance.getAppInfoApiAppAboutGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**AppInfo**
-
-### 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 |  -  |
-
-[[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)
-
-# **getAppThemeApiAppAboutThemeGet**
-> AppTheme getAppThemeApiAppAboutThemeGet()
-
-Get\'s the current theme settings
-
-### Example
-
-```typescript
-import {
-    AppAboutApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AppAboutApi(configuration);
-
-const { status, data } = await apiInstance.getAppThemeApiAppAboutThemeGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**AppTheme**
-
-### 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 |  -  |
-
-[[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)
-
-# **getStartupInfoApiAppAboutStartupInfoGet**
-> AppStartupInfo getStartupInfoApiAppAboutStartupInfoGet()
-
-returns helpful startup information
-
-### Example
-
-```typescript
-import {
-    AppAboutApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new AppAboutApi(configuration);
-
-const { status, data } = await apiInstance.getStartupInfoApiAppAboutStartupInfoGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**AppStartupInfo**
-
-### 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 |  -  |
-
-[[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/AppInfo.md

@@ -1,44 +0,0 @@
-# AppInfo
-
-
-## 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]
-
-## Example
-
-```typescript
-import { AppInfo } from 'mealie-typescript';
-
-const instance: AppInfo = {
-    production,
-    version,
-    demoStatus,
-    allowSignup,
-    allowPasswordLogin,
-    defaultGroupSlug,
-    defaultHouseholdSlug,
-    enableOidc,
-    oidcRedirect,
-    oidcProviderName,
-    enableOpenai,
-    enableOpenaiImageServices,
-    tokenTime,
-};
-```
-
-[[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/AppStartupInfo.md

@@ -1,22 +0,0 @@
-# AppStartupInfo
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**isFirstLogin** | **boolean** |  | [default to undefined]
-**isDemo** | **boolean** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AppStartupInfo } from 'mealie-typescript';
-
-const instance: AppStartupInfo = {
-    isFirstLogin,
-    isDemo,
-};
-```
-
-[[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/AppStatistics.md

@@ -1,30 +0,0 @@
-# AppStatistics
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**totalRecipes** | **number** |  | [default to undefined]
-**totalUsers** | **number** |  | [default to undefined]
-**totalHouseholds** | **number** |  | [default to undefined]
-**totalGroups** | **number** |  | [default to undefined]
-**uncategorizedRecipes** | **number** |  | [default to undefined]
-**untaggedRecipes** | **number** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AppStatistics } from 'mealie-typescript';
-
-const instance: AppStatistics = {
-    totalRecipes,
-    totalUsers,
-    totalHouseholds,
-    totalGroups,
-    uncategorizedRecipes,
-    untaggedRecipes,
-};
-```
-
-[[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/AppTheme.md

@@ -1,46 +0,0 @@
-# AppTheme
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**lightPrimary** | **string** |  | [optional] [default to '#E58325']
-**lightAccent** | **string** |  | [optional] [default to '#007A99']
-**lightSecondary** | **string** |  | [optional] [default to '#973542']
-**lightSuccess** | **string** |  | [optional] [default to '#43A047']
-**lightInfo** | **string** |  | [optional] [default to '#1976D2']
-**lightWarning** | **string** |  | [optional] [default to '#FF6D00']
-**lightError** | **string** |  | [optional] [default to '#EF5350']
-**darkPrimary** | **string** |  | [optional] [default to '#E58325']
-**darkAccent** | **string** |  | [optional] [default to '#007A99']
-**darkSecondary** | **string** |  | [optional] [default to '#973542']
-**darkSuccess** | **string** |  | [optional] [default to '#43A047']
-**darkInfo** | **string** |  | [optional] [default to '#1976D2']
-**darkWarning** | **string** |  | [optional] [default to '#FF6D00']
-**darkError** | **string** |  | [optional] [default to '#EF5350']
-
-## Example
-
-```typescript
-import { AppTheme } from 'mealie-typescript';
-
-const instance: AppTheme = {
-    lightPrimary,
-    lightAccent,
-    lightSecondary,
-    lightSuccess,
-    lightInfo,
-    lightWarning,
-    lightError,
-    darkPrimary,
-    darkAccent,
-    darkSecondary,
-    darkSuccess,
-    darkInfo,
-    darkWarning,
-    darkError,
-};
-```
-
-[[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/AssignCategories.md

@@ -1,22 +0,0 @@
-# AssignCategories
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipes** | **Array<string>** |  | [default to undefined]
-**categories** | [**Array<CategoryBase>**](CategoryBase.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AssignCategories } from 'mealie-typescript';
-
-const instance: AssignCategories = {
-    recipes,
-    categories,
-};
-```
-
-[[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/AssignSettings.md

@@ -1,22 +0,0 @@
-# AssignSettings
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipes** | **Array<string>** |  | [default to undefined]
-**settings** | [**RecipeSettings**](RecipeSettings.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AssignSettings } from 'mealie-typescript';
-
-const instance: AssignSettings = {
-    recipes,
-    settings,
-};
-```
-
-[[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/AssignTags.md

@@ -1,22 +0,0 @@
-# AssignTags
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipes** | **Array<string>** |  | [default to undefined]
-**tags** | [**Array<TagBase>**](TagBase.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { AssignTags } from 'mealie-typescript';
-
-const instance: AssignTags = {
-    recipes,
-    tags,
-};
-```
-
-[[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/AuthMethod.md

@@ -1,12 +0,0 @@
-# AuthMethod
-
-
-## Enum
-
-* `Mealie` (value: `'Mealie'`)
-
-* `Ldap` (value: `'LDAP'`)
-
-* `Oidc` (value: `'OIDC'`)
-
-[[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/BackupFile.md

@@ -1,24 +0,0 @@
-# BackupFile
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [default to undefined]
-**date** | **string** |  | [default to undefined]
-**size** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { BackupFile } from 'mealie-typescript';
-
-const instance: BackupFile = {
-    name,
-    date,
-    size,
-};
-```
-
-[[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/BodyTriggerActionApiHouseholdsRecipeActionsItemIdTriggerRecipeSlugPost.md

@@ -1,20 +0,0 @@
-# BodyTriggerActionApiHouseholdsRecipeActionsItemIdTriggerRecipeSlugPost
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipe_scale** | **number** |  | [optional] [default to 1]
-
-## Example
-
-```typescript
-import { BodyTriggerActionApiHouseholdsRecipeActionsItemIdTriggerRecipeSlugPost } from 'mealie-typescript';
-
-const instance: BodyTriggerActionApiHouseholdsRecipeActionsItemIdTriggerRecipeSlugPost = {
-    recipe_scale,
-};
-```
-
-[[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/CategoryBase.md

@@ -1,26 +0,0 @@
-# CategoryBase
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**groupId** | **string** |  | [optional] [default to undefined]
-**slug** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CategoryBase } from 'mealie-typescript';
-
-const instance: CategoryBase = {
-    name,
-    id,
-    groupId,
-    slug,
-};
-```
-
-[[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/CategoryIn.md

@@ -1,20 +0,0 @@
-# CategoryIn
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CategoryIn } from 'mealie-typescript';
-
-const instance: CategoryIn = {
-    name,
-};
-```
-
-[[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/CategoryOut.md

@@ -1,26 +0,0 @@
-# CategoryOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**slug** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CategoryOut } from 'mealie-typescript';
-
-const instance: CategoryOut = {
-    name,
-    id,
-    groupId,
-    slug,
-};
-```
-
-[[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/CategorySummary.md

@@ -1,24 +0,0 @@
-# CategorySummary
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**slug** | **string** |  | [default to undefined]
-**name** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CategorySummary } from 'mealie-typescript';
-
-const instance: CategorySummary = {
-    id,
-    slug,
-    name,
-};
-```
-
-[[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/ChangePassword.md

@@ -1,22 +0,0 @@
-# ChangePassword
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**currentPassword** | **string** |  | [optional] [default to '']
-**newPassword** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ChangePassword } from 'mealie-typescript';
-
-const instance: ChangePassword = {
-    currentPassword,
-    newPassword,
-};
-```
-
-[[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/CheckAppConfig.md

@@ -1,30 +0,0 @@
-# CheckAppConfig
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**emailReady** | **boolean** |  | [default to undefined]
-**ldapReady** | **boolean** |  | [default to undefined]
-**oidcReady** | **boolean** |  | [default to undefined]
-**enableOpenai** | **boolean** |  | [default to undefined]
-**baseUrlSet** | **boolean** |  | [default to undefined]
-**isUpToDate** | **boolean** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CheckAppConfig } from 'mealie-typescript';
-
-const instance: CheckAppConfig = {
-    emailReady,
-    ldapReady,
-    oidcReady,
-    enableOpenai,
-    baseUrlSet,
-    isUpToDate,
-};
-```
-
-[[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/CookBookPagination.md

@@ -1,32 +0,0 @@
-# CookBookPagination
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**page** | **number** |  | [optional] [default to 1]
-**per_page** | **number** |  | [optional] [default to 10]
-**total** | **number** |  | [optional] [default to 0]
-**total_pages** | **number** |  | [optional] [default to 0]
-**items** | [**Array<ReadCookBook>**](ReadCookBook.md) |  | [default to undefined]
-**next** | **string** |  | [optional] [default to undefined]
-**previous** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CookBookPagination } from 'mealie-typescript';
-
-const instance: CookBookPagination = {
-    page,
-    per_page,
-    total,
-    total_pages,
-    items,
-    next,
-    previous,
-};
-```
-
-[[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/Cookbook.md

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

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

@@ -1,22 +0,0 @@
-# CookbookHousehold
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**name** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { CookbookHousehold } from 'mealie-typescript';
-
-const instance: CookbookHousehold = {
-    id,
-    name,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)