mealie-typescript 1.0.6 → 1.0.8

package/docs/IngredientUnitOutput.md

@@ -1,42 +0,0 @@
-# IngredientUnitOutput
-
-
-## 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<IngredientUnitAlias>**](IngredientUnitAlias.md) |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IngredientUnitOutput } from 'mealie-typescript';
-
-const instance: IngredientUnitOutput = {
-    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/IngredientUnitPagination.md

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

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

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

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

@@ -1,10 +0,0 @@
-# LogicalOperator
-
-
-## Enum
-
-* `And` (value: `'AND'`)
-
-* `Or` (value: `'OR'`)
-
-[[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/LongLiveTokenCreateResponse.md

@@ -1,27 +0,0 @@
-# LongLiveTokenCreateResponse
-
-Should ONLY be used when creating a new token, as the token field is sensitive
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [default to undefined]
-**id** | **number** |  | [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**token** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { LongLiveTokenCreateResponse } from 'mealie-typescript';
-
-const instance: LongLiveTokenCreateResponse = {
-    name,
-    id,
-    createdAt,
-    token,
-};
-```
-
-[[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/LongLiveTokenIn.md

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

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

@@ -1,28 +0,0 @@
-# MaintenanceStorageDetails
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**tempDirSize** | **string** |  | [default to undefined]
-**backupsDirSize** | **string** |  | [default to undefined]
-**groupsDirSize** | **string** |  | [default to undefined]
-**recipesDirSize** | **string** |  | [default to undefined]
-**userDirSize** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { MaintenanceStorageDetails } from 'mealie-typescript';
-
-const instance: MaintenanceStorageDetails = {
-    tempDirSize,
-    backupsDirSize,
-    groupsDirSize,
-    recipesDirSize,
-    userDirSize,
-};
-```
-
-[[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/MaintenanceSummary.md

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

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

@@ -1,44 +0,0 @@
-# MealieSchemaUserUserUserBase
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**username** | **string** |  | [optional] [default to undefined]
-**fullName** | **string** |  | [optional] [default to undefined]
-**email** | **string** |  | [default to undefined]
-**authMethod** | [**AuthMethod**](AuthMethod.md) |  | [optional] [default to undefined]
-**admin** | **boolean** |  | [optional] [default to false]
-**group** | **string** |  | [optional] [default to undefined]
-**household** | **string** |  | [optional] [default to undefined]
-**advanced** | **boolean** |  | [optional] [default to false]
-**canInvite** | **boolean** |  | [optional] [default to false]
-**canManage** | **boolean** |  | [optional] [default to false]
-**canManageHousehold** | **boolean** |  | [optional] [default to false]
-**canOrganize** | **boolean** |  | [optional] [default to false]
-
-## Example
-
-```typescript
-import { MealieSchemaUserUserUserBase } from 'mealie-typescript';
-
-const instance: MealieSchemaUserUserUserBase = {
-    id,
-    username,
-    fullName,
-    email,
-    authMethod,
-    admin,
-    group,
-    household,
-    advanced,
-    canInvite,
-    canManage,
-    canManageHousehold,
-    canOrganize,
-};
-```
-
-[[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/MergeFood.md

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

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

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

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

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

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

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

@@ -1,40 +0,0 @@
-# Nutrition
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**calories** | **string** |  | [optional] [default to undefined]
-**carbohydrateContent** | **string** |  | [optional] [default to undefined]
-**cholesterolContent** | **string** |  | [optional] [default to undefined]
-**fatContent** | **string** |  | [optional] [default to undefined]
-**fiberContent** | **string** |  | [optional] [default to undefined]
-**proteinContent** | **string** |  | [optional] [default to undefined]
-**saturatedFatContent** | **string** |  | [optional] [default to undefined]
-**sodiumContent** | **string** |  | [optional] [default to undefined]
-**sugarContent** | **string** |  | [optional] [default to undefined]
-**transFatContent** | **string** |  | [optional] [default to undefined]
-**unsaturatedFatContent** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Nutrition } from 'mealie-typescript';
-
-const instance: Nutrition = {
-    calories,
-    carbohydrateContent,
-    cholesterolContent,
-    fatContent,
-    fiberContent,
-    proteinContent,
-    saturatedFatContent,
-    sodiumContent,
-    sugarContent,
-    transFatContent,
-    unsaturatedFatContent,
-};
-```
-
-[[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/OrderByNullPosition.md

@@ -1,10 +0,0 @@
-# OrderByNullPosition
-
-
-## Enum
-
-* `First` (value: `'first'`)
-
-* `Last` (value: `'last'`)
-
-[[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/OrderDirection.md

@@ -1,10 +0,0 @@
-# OrderDirection
-
-
-## Enum
-
-* `Asc` (value: `'asc'`)
-
-* `Desc` (value: `'desc'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)