mealie-typescript 1.0.6 → 1.0.8

package/docs/ShoppingListItemUpdateBulk.md

@@ -1,49 +0,0 @@
-# ShoppingListItemUpdateBulk
-
-Only used for bulk update operations where the shopping list item id isn\'t already supplied
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quantity** | **number** |  | [optional] [default to 1]
-**unit** | [**Unit**](Unit.md) |  | [optional] [default to undefined]
-**food** | [**Food**](Food.md) |  | [optional] [default to undefined]
-**referencedRecipe** | [**RecipeInput**](RecipeInput.md) |  | [optional] [default to undefined]
-**note** | **string** |  | [optional] [default to undefined]
-**display** | **string** |  | [optional] [default to '']
-**shoppingListId** | **string** |  | [default to undefined]
-**checked** | **boolean** |  | [optional] [default to false]
-**position** | **number** |  | [optional] [default to 0]
-**foodId** | **string** |  | [optional] [default to undefined]
-**labelId** | **string** |  | [optional] [default to undefined]
-**unitId** | **string** |  | [optional] [default to undefined]
-**extras** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
-**recipeReferences** | [**Array<ShoppingListItemUpdateRecipeReferencesInner>**](ShoppingListItemUpdateRecipeReferencesInner.md) |  | [optional] [default to undefined]
-**id** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListItemUpdateBulk } from 'mealie-typescript';
-
-const instance: ShoppingListItemUpdateBulk = {
-    quantity,
-    unit,
-    food,
-    referencedRecipe,
-    note,
-    display,
-    shoppingListId,
-    checked,
-    position,
-    foodId,
-    labelId,
-    unitId,
-    extras,
-    recipeReferences,
-    id,
-};
-```
-
-[[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/ShoppingListItemUpdateRecipeReferencesInner.md

@@ -1,30 +0,0 @@
-# ShoppingListItemUpdateRecipeReferencesInner
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipeId** | **string** |  | [default to undefined]
-**recipeQuantity** | **number** |  | [optional] [default to 0]
-**recipeScale** | **number** |  | [optional] [default to undefined]
-**recipeNote** | **string** |  | [optional] [default to undefined]
-**id** | **string** |  | [default to undefined]
-**shoppingListItemId** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListItemUpdateRecipeReferencesInner } from 'mealie-typescript';
-
-const instance: ShoppingListItemUpdateRecipeReferencesInner = {
-    recipeId,
-    recipeQuantity,
-    recipeScale,
-    recipeNote,
-    id,
-    shoppingListItemId,
-};
-```
-
-[[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/ShoppingListItemsCollectionOut.md

@@ -1,25 +0,0 @@
-# ShoppingListItemsCollectionOut
-
-Container for bulk shopping list item changes
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**createdItems** | [**Array<ShoppingListItemOutOutput>**](ShoppingListItemOutOutput.md) |  | [optional] [default to undefined]
-**updatedItems** | [**Array<ShoppingListItemOutOutput>**](ShoppingListItemOutOutput.md) |  | [optional] [default to undefined]
-**deletedItems** | [**Array<ShoppingListItemOutOutput>**](ShoppingListItemOutOutput.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListItemsCollectionOut } from 'mealie-typescript';
-
-const instance: ShoppingListItemsCollectionOut = {
-    createdItems,
-    updatedItems,
-    deletedItems,
-};
-```
-
-[[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/ShoppingListMultiPurposeLabelOut.md

@@ -1,28 +0,0 @@
-# ShoppingListMultiPurposeLabelOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**shoppingListId** | **string** |  | [default to undefined]
-**labelId** | **string** |  | [default to undefined]
-**position** | **number** |  | [optional] [default to 0]
-**id** | **string** |  | [default to undefined]
-**label** | [**MultiPurposeLabelSummary**](MultiPurposeLabelSummary.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListMultiPurposeLabelOut } from 'mealie-typescript';
-
-const instance: ShoppingListMultiPurposeLabelOut = {
-    shoppingListId,
-    labelId,
-    position,
-    id,
-    label,
-};
-```
-
-[[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/ShoppingListMultiPurposeLabelUpdate.md

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

@@ -1,40 +0,0 @@
-# ShoppingListOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [optional] [default to undefined]
-**extras** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**userId** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**listItems** | [**Array<ShoppingListItemOutOutput>**](ShoppingListItemOutOutput.md) |  | [optional] [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**recipeReferences** | [**Array<ShoppingListRecipeRefOut>**](ShoppingListRecipeRefOut.md) |  | [optional] [default to undefined]
-**labelSettings** | [**Array<ShoppingListMultiPurposeLabelOut>**](ShoppingListMultiPurposeLabelOut.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListOut } from 'mealie-typescript';
-
-const instance: ShoppingListOut = {
-    name,
-    extras,
-    createdAt,
-    updatedAt,
-    groupId,
-    userId,
-    id,
-    listItems,
-    householdId,
-    recipeReferences,
-    labelSettings,
-};
-```
-
-[[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/ShoppingListPagination.md

@@ -1,32 +0,0 @@
-# ShoppingListPagination
-
-
-## 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<ShoppingListSummary>**](ShoppingListSummary.md) |  | [default to undefined]
-**next** | **string** |  | [optional] [default to undefined]
-**previous** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListPagination } from 'mealie-typescript';
-
-const instance: ShoppingListPagination = {
-    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/ShoppingListRecipeRefOut.md

@@ -1,28 +0,0 @@
-# ShoppingListRecipeRefOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**shoppingListId** | **string** |  | [default to undefined]
-**recipeId** | **string** |  | [default to undefined]
-**recipeQuantity** | **number** |  | [default to undefined]
-**recipe** | [**RecipeSummary**](RecipeSummary.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListRecipeRefOut } from 'mealie-typescript';
-
-const instance: ShoppingListRecipeRefOut = {
-    id,
-    shoppingListId,
-    recipeId,
-    recipeQuantity,
-    recipe,
-};
-```
-
-[[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/ShoppingListRemoveRecipeParams.md

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

@@ -1,38 +0,0 @@
-# ShoppingListSummary
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [optional] [default to undefined]
-**extras** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**userId** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**recipeReferences** | [**Array<ShoppingListRecipeRefOut>**](ShoppingListRecipeRefOut.md) |  | [default to undefined]
-**labelSettings** | [**Array<ShoppingListMultiPurposeLabelOut>**](ShoppingListMultiPurposeLabelOut.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListSummary } from 'mealie-typescript';
-
-const instance: ShoppingListSummary = {
-    name,
-    extras,
-    createdAt,
-    updatedAt,
-    groupId,
-    userId,
-    id,
-    householdId,
-    recipeReferences,
-    labelSettings,
-};
-```
-
-[[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/ShoppingListUpdate.md

@@ -1,34 +0,0 @@
-# ShoppingListUpdate
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [optional] [default to undefined]
-**extras** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**update_at** | **string** |  | [optional] [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**userId** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**listItems** | [**Array<ShoppingListItemOutInput>**](ShoppingListItemOutInput.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListUpdate } from 'mealie-typescript';
-
-const instance: ShoppingListUpdate = {
-    name,
-    extras,
-    createdAt,
-    update_at,
-    groupId,
-    userId,
-    id,
-    listItems,
-};
-```
-
-[[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/SuccessResponse.md

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

@@ -1,26 +0,0 @@
-# SupportedMigrations
-
-
-## Enum
-
-* `Nextcloud` (value: `'nextcloud'`)
-
-* `Chowdown` (value: `'chowdown'`)
-
-* `Copymethat` (value: `'copymethat'`)
-
-* `Paprika` (value: `'paprika'`)
-
-* `MealieAlpha` (value: `'mealie_alpha'`)
-
-* `Tandoor` (value: `'tandoor'`)
-
-* `Plantoeat` (value: `'plantoeat'`)
-
-* `Myrecipebox` (value: `'myrecipebox'`)
-
-* `Recipekeeper` (value: `'recipekeeper'`)
-
-* `Cookn` (value: `'cookn'`)
-
-[[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/TagBase.md

@@ -1,26 +0,0 @@
-# TagBase
-
-
-## 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 { TagBase } from 'mealie-typescript';
-
-const instance: TagBase = {
-    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/TagIn.md

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

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

@@ -1,10 +0,0 @@
-# TimelineEventImage
-
-
-## Enum
-
-* `HasImage` (value: `'has image'`)
-
-* `DoesNotHaveImage` (value: `'does not have image'`)
-
-[[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/TimelineEventType.md

@@ -1,12 +0,0 @@
-# TimelineEventType
-
-
-## Enum
-
-* `System` (value: `'system'`)
-
-* `Info` (value: `'info'`)
-
-* `Comment` (value: `'comment'`)
-
-[[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/Unit.md

@@ -1,42 +0,0 @@
-# Unit
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**name** | **string** |  | [default to undefined]
-**pluralName** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to '']
-**extras** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
-**fraction** | **boolean** |  | [optional] [default to true]
-**abbreviation** | **string** |  | [optional] [default to '']
-**pluralAbbreviation** | **string** |  | [optional] [default to undefined]
-**useAbbreviation** | **boolean** |  | [optional] [default to false]
-**aliases** | [**Array<CreateIngredientUnitAlias>**](CreateIngredientUnitAlias.md) |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**update_at** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Unit } from 'mealie-typescript';
-
-const instance: Unit = {
-    id,
-    name,
-    pluralName,
-    description,
-    extras,
-    fraction,
-    abbreviation,
-    pluralAbbreviation,
-    useAbbreviation,
-    aliases,
-    createdAt,
-    update_at,
-};
-```
-
-[[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/Unit1.md

@@ -1,42 +0,0 @@
-# Unit1
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**name** | **string** |  | [default to undefined]
-**pluralName** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to '']
-**extras** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
-**fraction** | **boolean** |  | [optional] [default to true]
-**abbreviation** | **string** |  | [optional] [default to '']
-**pluralAbbreviation** | **string** |  | [optional] [default to undefined]
-**useAbbreviation** | **boolean** |  | [optional] [default to false]
-**aliases** | [**Array<CreateIngredientUnitAlias>**](CreateIngredientUnitAlias.md) |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Unit1 } from 'mealie-typescript';
-
-const instance: Unit1 = {
-    id,
-    name,
-    pluralName,
-    description,
-    extras,
-    fraction,
-    abbreviation,
-    pluralAbbreviation,
-    useAbbreviation,
-    aliases,
-    createdAt,
-    updatedAt,
-};
-```
-
-[[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/UnlockResults.md

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

@@ -1,36 +0,0 @@
-# UpdateCookBook
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [default to undefined]
-**description** | **string** |  | [optional] [default to '']
-**slug** | **string** |  | [optional] [default to undefined]
-**position** | **number** |  | [optional] [default to 1]
-**_public** | **boolean** |  | [optional] [default to false]
-**queryFilterString** | **string** |  | [optional] [default to '']
-**groupId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { UpdateCookBook } from 'mealie-typescript';
-
-const instance: UpdateCookBook = {
-    name,
-    description,
-    slug,
-    position,
-    _public,
-    queryFilterString,
-    groupId,
-    householdId,
-    id,
-};
-```
-
-[[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/UpdateGroupPreferences.md

@@ -1,20 +0,0 @@
-# UpdateGroupPreferences
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**privateGroup** | **boolean** |  | [optional] [default to true]
-
-## Example
-
-```typescript
-import { UpdateGroupPreferences } from 'mealie-typescript';
-
-const instance: UpdateGroupPreferences = {
-    privateGroup,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)