mealie-typescript 1.0.5 → 1.0.7

package/docs/RecipeInput.md

@@ -1,84 +0,0 @@
-# RecipeInput
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**userId** | **string** |  | [optional] [default to undefined]
-**householdId** | **string** |  | [optional] [default to undefined]
-**groupId** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**slug** | **string** |  | [optional] [default to '']
-**image** | [****](.md) |  | [optional] [default to undefined]
-**recipeServings** | **number** |  | [optional] [default to 0]
-**recipeYieldQuantity** | **number** |  | [optional] [default to 0]
-**recipeYield** | **string** |  | [optional] [default to undefined]
-**totalTime** | **string** |  | [optional] [default to undefined]
-**prepTime** | **string** |  | [optional] [default to undefined]
-**cookTime** | **string** |  | [optional] [default to undefined]
-**performTime** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
-**recipeCategory** | [**Array<RecipeCategory>**](RecipeCategory.md) |  | [optional] [default to undefined]
-**tags** | [**Array<RecipeTag>**](RecipeTag.md) |  | [optional] [default to undefined]
-**tools** | [**Array<RecipeTool>**](RecipeTool.md) |  | [optional] [default to undefined]
-**rating** | **number** |  | [optional] [default to undefined]
-**orgURL** | **string** |  | [optional] [default to undefined]
-**dateAdded** | **string** |  | [optional] [default to undefined]
-**dateUpdated** | **string** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**update_at** | **string** |  | [optional] [default to undefined]
-**lastMade** | **string** |  | [optional] [default to undefined]
-**recipeIngredient** | [**Array<RecipeIngredientInput>**](RecipeIngredientInput.md) |  | [optional] [default to undefined]
-**recipeInstructions** | [**Array<RecipeStep>**](RecipeStep.md) |  | [optional] [default to undefined]
-**nutrition** | [**Nutrition**](Nutrition.md) |  | [optional] [default to undefined]
-**settings** | [**RecipeSettings**](RecipeSettings.md) |  | [optional] [default to undefined]
-**assets** | [**Array<RecipeAsset>**](RecipeAsset.md) |  | [optional] [default to undefined]
-**notes** | [**Array<RecipeNote>**](RecipeNote.md) |  | [optional] [default to undefined]
-**extras** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
-**comments** | [**Array<RecipeCommentOutInput>**](RecipeCommentOutInput.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeInput } from 'mealie-typescript';
-
-const instance: RecipeInput = {
-    id,
-    userId,
-    householdId,
-    groupId,
-    name,
-    slug,
-    image,
-    recipeServings,
-    recipeYieldQuantity,
-    recipeYield,
-    totalTime,
-    prepTime,
-    cookTime,
-    performTime,
-    description,
-    recipeCategory,
-    tags,
-    tools,
-    rating,
-    orgURL,
-    dateAdded,
-    dateUpdated,
-    createdAt,
-    update_at,
-    lastMade,
-    recipeIngredient,
-    recipeInstructions,
-    nutrition,
-    settings,
-    assets,
-    notes,
-    extras,
-    comments,
-};
-```
-
-[[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/RecipeLastMade.md

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

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

@@ -1,84 +0,0 @@
-# RecipeOutput
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**userId** | **string** |  | [optional] [default to undefined]
-**householdId** | **string** |  | [optional] [default to undefined]
-**groupId** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**slug** | **string** |  | [optional] [default to '']
-**image** | [****](.md) |  | [optional] [default to undefined]
-**recipeServings** | **number** |  | [optional] [default to 0]
-**recipeYieldQuantity** | **number** |  | [optional] [default to 0]
-**recipeYield** | **string** |  | [optional] [default to undefined]
-**totalTime** | **string** |  | [optional] [default to undefined]
-**prepTime** | **string** |  | [optional] [default to undefined]
-**cookTime** | **string** |  | [optional] [default to undefined]
-**performTime** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
-**recipeCategory** | [**Array<RecipeCategory>**](RecipeCategory.md) |  | [optional] [default to undefined]
-**tags** | [**Array<RecipeTag>**](RecipeTag.md) |  | [optional] [default to undefined]
-**tools** | [**Array<RecipeTool>**](RecipeTool.md) |  | [optional] [default to undefined]
-**rating** | **number** |  | [optional] [default to undefined]
-**orgURL** | **string** |  | [optional] [default to undefined]
-**dateAdded** | **string** |  | [optional] [default to undefined]
-**dateUpdated** | **string** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-**lastMade** | **string** |  | [optional] [default to undefined]
-**recipeIngredient** | [**Array<RecipeIngredientOutput>**](RecipeIngredientOutput.md) |  | [optional] [default to undefined]
-**recipeInstructions** | [**Array<RecipeStep>**](RecipeStep.md) |  | [optional] [default to undefined]
-**nutrition** | [**Nutrition**](Nutrition.md) |  | [optional] [default to undefined]
-**settings** | [**RecipeSettings**](RecipeSettings.md) |  | [optional] [default to undefined]
-**assets** | [**Array<RecipeAsset>**](RecipeAsset.md) |  | [optional] [default to undefined]
-**notes** | [**Array<RecipeNote>**](RecipeNote.md) |  | [optional] [default to undefined]
-**extras** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
-**comments** | [**Array<RecipeCommentOutOutput>**](RecipeCommentOutOutput.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeOutput } from 'mealie-typescript';
-
-const instance: RecipeOutput = {
-    id,
-    userId,
-    householdId,
-    groupId,
-    name,
-    slug,
-    image,
-    recipeServings,
-    recipeYieldQuantity,
-    recipeYield,
-    totalTime,
-    prepTime,
-    cookTime,
-    performTime,
-    description,
-    recipeCategory,
-    tags,
-    tools,
-    rating,
-    orgURL,
-    dateAdded,
-    dateUpdated,
-    createdAt,
-    updatedAt,
-    lastMade,
-    recipeIngredient,
-    recipeInstructions,
-    nutrition,
-    settings,
-    assets,
-    notes,
-    extras,
-    comments,
-};
-```
-
-[[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/RecipeSettings.md

@@ -1,30 +0,0 @@
-# RecipeSettings
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_public** | **boolean** |  | [optional] [default to false]
-**showNutrition** | **boolean** |  | [optional] [default to false]
-**showAssets** | **boolean** |  | [optional] [default to false]
-**landscapeView** | **boolean** |  | [optional] [default to false]
-**disableComments** | **boolean** |  | [optional] [default to true]
-**locked** | **boolean** |  | [optional] [default to false]
-
-## Example
-
-```typescript
-import { RecipeSettings } from 'mealie-typescript';
-
-const instance: RecipeSettings = {
-    _public,
-    showNutrition,
-    showAssets,
-    landscapeView,
-    disableComments,
-    locked,
-};
-```
-
-[[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/RecipeShareToken.md

@@ -1,30 +0,0 @@
-# RecipeShareToken
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipeId** | **string** |  | [default to undefined]
-**expiresAt** | **string** |  | [optional] [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
-**recipe** | [**RecipeOutput**](RecipeOutput.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeShareToken } from 'mealie-typescript';
-
-const instance: RecipeShareToken = {
-    recipeId,
-    expiresAt,
-    groupId,
-    id,
-    createdAt,
-    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/RecipeShareTokenCreate.md

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

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

@@ -1,112 +0,0 @@
-# RecipeSharedApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getSharedRecipeApiRecipesSharedTokenIdGet**](#getsharedrecipeapirecipessharedtokenidget) | **GET** /api/recipes/shared/{token_id} | Get Shared Recipe|
-|[**getSharedRecipeAsZipApiRecipesSharedTokenIdZipGet**](#getsharedrecipeaszipapirecipessharedtokenidzipget) | **GET** /api/recipes/shared/{token_id}/zip | Get Shared Recipe As Zip|
-
-# **getSharedRecipeApiRecipesSharedTokenIdGet**
-> RecipeOutput getSharedRecipeApiRecipesSharedTokenIdGet()
-
-
-### Example
-
-```typescript
-import {
-    RecipeSharedApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeSharedApi(configuration);
-
-let tokenId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.getSharedRecipeApiRecipesSharedTokenIdGet(
-    tokenId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **tokenId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**RecipeOutput**
-
-### 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 |  -  |
-|**422** | Validation Error |  -  |
-
-[[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)
-
-# **getSharedRecipeAsZipApiRecipesSharedTokenIdZipGet**
-> getSharedRecipeAsZipApiRecipesSharedTokenIdZipGet()
-
-Get a recipe and its original image as a Zip file
-
-### Example
-
-```typescript
-import {
-    RecipeSharedApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeSharedApi(configuration);
-
-let tokenId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.getSharedRecipeAsZipApiRecipesSharedTokenIdZipGet(
-    tokenId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **tokenId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### 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 |  -  |
-|**422** | Validation Error |  -  |
-
-[[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/RecipeStep.md

@@ -1,28 +0,0 @@
-# RecipeStep
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to undefined]
-**summary** | **string** |  | [optional] [default to undefined]
-**text** | **string** |  | [default to undefined]
-**ingredientReferences** | [**Array<IngredientReferences>**](IngredientReferences.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeStep } from 'mealie-typescript';
-
-const instance: RecipeStep = {
-    id,
-    title,
-    summary,
-    text,
-    ingredientReferences,
-};
-```
-
-[[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/RecipeSuggestionResponse.md

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

@@ -1,24 +0,0 @@
-# RecipeSuggestionResponseItem
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipe** | [**RecipeSummary**](RecipeSummary.md) |  | [default to undefined]
-**missingFoods** | [**Array<IngredientFoodOutput>**](IngredientFoodOutput.md) |  | [default to undefined]
-**missingTools** | [**Array<RecipeTool>**](RecipeTool.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeSuggestionResponseItem } from 'mealie-typescript';
-
-const instance: RecipeSuggestionResponseItem = {
-    recipe,
-    missingFoods,
-    missingTools,
-};
-```
-
-[[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/RecipeSummary.md

@@ -1,68 +0,0 @@
-# RecipeSummary
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**userId** | **string** |  | [optional] [default to undefined]
-**householdId** | **string** |  | [optional] [default to undefined]
-**groupId** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**slug** | **string** |  | [optional] [default to '']
-**image** | [****](.md) |  | [optional] [default to undefined]
-**recipeServings** | **number** |  | [optional] [default to 0]
-**recipeYieldQuantity** | **number** |  | [optional] [default to 0]
-**recipeYield** | **string** |  | [optional] [default to undefined]
-**totalTime** | **string** |  | [optional] [default to undefined]
-**prepTime** | **string** |  | [optional] [default to undefined]
-**cookTime** | **string** |  | [optional] [default to undefined]
-**performTime** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
-**recipeCategory** | [**Array<RecipeCategory>**](RecipeCategory.md) |  | [optional] [default to undefined]
-**tags** | [**Array<RecipeTag>**](RecipeTag.md) |  | [optional] [default to undefined]
-**tools** | [**Array<RecipeTool>**](RecipeTool.md) |  | [optional] [default to undefined]
-**rating** | **number** |  | [optional] [default to undefined]
-**orgURL** | **string** |  | [optional] [default to undefined]
-**dateAdded** | **string** |  | [optional] [default to undefined]
-**dateUpdated** | **string** |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-**lastMade** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeSummary } from 'mealie-typescript';
-
-const instance: RecipeSummary = {
-    id,
-    userId,
-    householdId,
-    groupId,
-    name,
-    slug,
-    image,
-    recipeServings,
-    recipeYieldQuantity,
-    recipeYield,
-    totalTime,
-    prepTime,
-    cookTime,
-    performTime,
-    description,
-    recipeCategory,
-    tags,
-    tools,
-    rating,
-    orgURL,
-    dateAdded,
-    dateUpdated,
-    createdAt,
-    updatedAt,
-    lastMade,
-};
-```
-
-[[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/RecipeTag.md

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

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

@@ -1,28 +0,0 @@
-# RecipeTagResponse
-
-
-## 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]
-**recipes** | [**Array<RecipeSummary>**](RecipeSummary.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeTagResponse } from 'mealie-typescript';
-
-const instance: RecipeTagResponse = {
-    name,
-    id,
-    groupId,
-    slug,
-    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)