mealie-typescript 1.0.6 → 1.0.8

package/docs/PasswordResetToken.md

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

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

@@ -1,20 +0,0 @@
-# PlanEntryType
-
-
-## Enum
-
-* `Breakfast` (value: `'breakfast'`)
-
-* `Lunch` (value: `'lunch'`)
-
-* `Dinner` (value: `'dinner'`)
-
-* `Side` (value: `'side'`)
-
-* `Snack` (value: `'snack'`)
-
-* `Drink` (value: `'drink'`)
-
-* `Dessert` (value: `'dessert'`)
-
-[[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/PlanRulesCreate.md

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

@@ -1,22 +0,0 @@
-# PlanRulesDay
-
-
-## Enum
-
-* `Monday` (value: `'monday'`)
-
-* `Tuesday` (value: `'tuesday'`)
-
-* `Wednesday` (value: `'wednesday'`)
-
-* `Thursday` (value: `'thursday'`)
-
-* `Friday` (value: `'friday'`)
-
-* `Saturday` (value: `'saturday'`)
-
-* `Sunday` (value: `'sunday'`)
-
-* `Unset` (value: `'unset'`)
-
-[[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/PlanRulesOut.md

@@ -1,32 +0,0 @@
-# PlanRulesOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**day** | [**PlanRulesDay**](PlanRulesDay.md) |  | [optional] [default to undefined]
-**entryType** | [**PlanRulesType**](PlanRulesType.md) |  | [optional] [default to undefined]
-**queryFilterString** | **string** |  | [optional] [default to '']
-**groupId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**queryFilter** | [**QueryFilterJSON**](QueryFilterJSON.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PlanRulesOut } from 'mealie-typescript';
-
-const instance: PlanRulesOut = {
-    day,
-    entryType,
-    queryFilterString,
-    groupId,
-    householdId,
-    id,
-    queryFilter,
-};
-```
-
-[[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/PlanRulesPagination.md

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

@@ -1,22 +0,0 @@
-# PlanRulesType
-
-
-## Enum
-
-* `Breakfast` (value: `'breakfast'`)
-
-* `Lunch` (value: `'lunch'`)
-
-* `Dinner` (value: `'dinner'`)
-
-* `Side` (value: `'side'`)
-
-* `Snack` (value: `'snack'`)
-
-* `Drink` (value: `'drink'`)
-
-* `Dessert` (value: `'dessert'`)
-
-* `Unset` (value: `'unset'`)
-
-[[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/QueryFilterJSON.md

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

@@ -1,30 +0,0 @@
-# QueryFilterJSONPart
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**leftParenthesis** | **string** |  | [optional] [default to undefined]
-**rightParenthesis** | **string** |  | [optional] [default to undefined]
-**logicalOperator** | [**LogicalOperator**](LogicalOperator.md) |  | [optional] [default to undefined]
-**attributeName** | **string** |  | [optional] [default to undefined]
-**relationalOperator** | [**Relationaloperator**](Relationaloperator.md) |  | [optional] [default to undefined]
-**value** | [**Value**](Value.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { QueryFilterJSONPart } from 'mealie-typescript';
-
-const instance: QueryFilterJSONPart = {
-    leftParenthesis,
-    rightParenthesis,
-    logicalOperator,
-    attributeName,
-    relationalOperator,
-    value,
-};
-```
-
-[[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/ReadCookBook.md

@@ -1,40 +0,0 @@
-# ReadCookBook
-
-
-## 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]
-**queryFilter** | [**QueryFilterJSON**](QueryFilterJSON.md) |  | [optional] [default to undefined]
-**household** | [**CookbookHousehold**](CookbookHousehold.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ReadCookBook } from 'mealie-typescript';
-
-const instance: ReadCookBook = {
-    name,
-    description,
-    slug,
-    position,
-    _public,
-    queryFilterString,
-    groupId,
-    householdId,
-    id,
-    queryFilter,
-    household,
-};
-```
-
-[[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/ReadGroupPreferences.md

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

@@ -1,36 +0,0 @@
-# ReadHouseholdPreferences
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**privateHousehold** | **boolean** |  | [optional] [default to true]
-**lockRecipeEditsFromOtherHouseholds** | **boolean** |  | [optional] [default to true]
-**firstDayOfWeek** | **number** |  | [optional] [default to 0]
-**recipePublic** | **boolean** |  | [optional] [default to true]
-**recipeShowNutrition** | **boolean** |  | [optional] [default to false]
-**recipeShowAssets** | **boolean** |  | [optional] [default to false]
-**recipeLandscapeView** | **boolean** |  | [optional] [default to false]
-**recipeDisableComments** | **boolean** |  | [optional] [default to false]
-**id** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ReadHouseholdPreferences } from 'mealie-typescript';
-
-const instance: ReadHouseholdPreferences = {
-    privateHousehold,
-    lockRecipeEditsFromOtherHouseholds,
-    firstDayOfWeek,
-    recipePublic,
-    recipeShowNutrition,
-    recipeShowAssets,
-    recipeLandscapeView,
-    recipeDisableComments,
-    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/ReadInviteToken.md

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

@@ -1,38 +0,0 @@
-# ReadPlanEntry
-
-
-## 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]
-**id** | **number** |  | [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**userId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**recipe** | [**RecipeSummary**](RecipeSummary.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ReadPlanEntry } from 'mealie-typescript';
-
-const instance: ReadPlanEntry = {
-    date,
-    entryType,
-    title,
-    text,
-    recipeId,
-    id,
-    groupId,
-    userId,
-    householdId,
-    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/ReadWebhook.md

@@ -1,34 +0,0 @@
-# ReadWebhook
-
-
-## 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]
-**groupId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ReadWebhook } from 'mealie-typescript';
-
-const instance: ReadWebhook = {
-    enabled,
-    name,
-    url,
-    webhookType,
-    scheduledTime,
-    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/RecipeAsset.md

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