mealie-typescript 1.0.0

package/docs/CreateCookBook.md

@@ -0,0 +1,30 @@
+# CreateCookBook
+
+
+## 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 '']
+
+## Example
+
+```typescript
+import { CreateCookBook } from 'mealie-typescript';
+
+const instance: CreateCookBook = {
+    name,
+    description,
+    slug,
+    position,
+    _public,
+    queryFilterString,
+};
+```
+
+[[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/CreateGroupRecipeAction.md

@@ -0,0 +1,24 @@
+# CreateGroupRecipeAction
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**actionType** | [**GroupRecipeActionType**](GroupRecipeActionType.md) |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**url** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateGroupRecipeAction } from 'mealie-typescript';
+
+const instance: CreateGroupRecipeAction = {
+    actionType,
+    title,
+    url,
+};
+```
+
+[[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/CreateIngredientFood.md

@@ -0,0 +1,34 @@
+# CreateIngredientFood
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [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]
+**labelId** | **string** |  | [optional] [default to undefined]
+**aliases** | [**Array<CreateIngredientFoodAlias>**](CreateIngredientFoodAlias.md) |  | [optional] [default to undefined]
+**householdsWithIngredientFood** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateIngredientFood } from 'mealie-typescript';
+
+const instance: CreateIngredientFood = {
+    id,
+    name,
+    pluralName,
+    description,
+    extras,
+    labelId,
+    aliases,
+    householdsWithIngredientFood,
+};
+```
+
+[[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/CreateIngredientFoodAlias.md

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

@@ -0,0 +1,38 @@
+# CreateIngredientUnit
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [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]
+
+## Example
+
+```typescript
+import { CreateIngredientUnit } from 'mealie-typescript';
+
+const instance: CreateIngredientUnit = {
+    id,
+    name,
+    pluralName,
+    description,
+    extras,
+    fraction,
+    abbreviation,
+    pluralAbbreviation,
+    useAbbreviation,
+    aliases,
+};
+```
+
+[[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/CreateIngredientUnitAlias.md

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

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

@@ -0,0 +1,28 @@
+# CreatePlanEntry
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **string** |  | [default to undefined]
+**entryType** | [**PlanEntryType**](PlanEntryType.md) |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to '']
+**text** | **string** |  | [optional] [default to '']
+**recipeId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreatePlanEntry } from 'mealie-typescript';
+
+const instance: CreatePlanEntry = {
+    date,
+    entryType,
+    title,
+    text,
+    recipeId,
+};
+```
+
+[[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/CreateRandomEntry.md

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

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

@@ -0,0 +1,24 @@
+# CreateRecipeBulk
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [default to undefined]
+**categories** | [**Array<RecipeCategory>**](RecipeCategory.md) |  | [optional] [default to undefined]
+**tags** | [**Array<RecipeTag>**](RecipeTag.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateRecipeBulk } from 'mealie-typescript';
+
+const instance: CreateRecipeBulk = {
+    url,
+    categories,
+    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/CreateRecipeByUrlBulk.md

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

@@ -0,0 +1,42 @@
+# CreateUserRegistration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group** | **string** |  | [optional] [default to undefined]
+**household** | **string** |  | [optional] [default to undefined]
+**groupToken** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [default to undefined]
+**username** | **string** |  | [default to undefined]
+**fullName** | **string** |  | [default to undefined]
+**password** | **string** |  | [default to undefined]
+**passwordConfirm** | **string** |  | [default to undefined]
+**advanced** | **boolean** |  | [optional] [default to false]
+**_private** | **boolean** |  | [optional] [default to false]
+**seedData** | **boolean** |  | [optional] [default to false]
+**locale** | **string** |  | [optional] [default to 'en-US']
+
+## Example
+
+```typescript
+import { CreateUserRegistration } from 'mealie-typescript';
+
+const instance: CreateUserRegistration = {
+    group,
+    household,
+    groupToken,
+    email,
+    username,
+    fullName,
+    password,
+    passwordConfirm,
+    advanced,
+    _private,
+    seedData,
+    locale,
+};
+```
+
+[[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/CreateWebhook.md

@@ -0,0 +1,28 @@
+# CreateWebhook
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** |  | [optional] [default to true]
+**name** | **string** |  | [optional] [default to '']
+**url** | **string** |  | [optional] [default to '']
+**webhookType** | [**WebhookType**](WebhookType.md) |  | [optional] [default to undefined]
+**scheduledTime** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateWebhook } from 'mealie-typescript';
+
+const instance: CreateWebhook = {
+    enabled,
+    name,
+    url,
+    webhookType,
+    scheduledTime,
+};
+```
+
+[[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/DebugResponse.md

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

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

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

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

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

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

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

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