mealie-typescript 1.0.5 → 1.0.7

package/docs/SeederConfig.md

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

@@ -1,28 +0,0 @@
-# SetPermissions
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**userId** | **string** |  | [default to undefined]
-**canManageHousehold** | **boolean** |  | [optional] [default to false]
-**canManage** | **boolean** |  | [optional] [default to false]
-**canInvite** | **boolean** |  | [optional] [default to false]
-**canOrganize** | **boolean** |  | [optional] [default to false]
-
-## Example
-
-```typescript
-import { SetPermissions } from 'mealie-typescript';
-
-const instance: SetPermissions = {
-    userId,
-    canManageHousehold,
-    canManage,
-    canInvite,
-    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/SharedRecipesApi.md

@@ -1,228 +0,0 @@
-# SharedRecipesApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createOneApiSharedRecipesPost**](#createoneapisharedrecipespost) | **POST** /api/shared/recipes | Create One|
-|[**deleteOneApiSharedRecipesItemIdDelete**](#deleteoneapisharedrecipesitemiddelete) | **DELETE** /api/shared/recipes/{item_id} | Delete One|
-|[**getAllApiSharedRecipesGet**](#getallapisharedrecipesget) | **GET** /api/shared/recipes | Get All|
-|[**getOneApiSharedRecipesItemIdGet**](#getoneapisharedrecipesitemidget) | **GET** /api/shared/recipes/{item_id} | Get One|
-
-# **createOneApiSharedRecipesPost**
-> RecipeShareToken createOneApiSharedRecipesPost(recipeShareTokenCreate)
-
-
-### Example
-
-```typescript
-import {
-    SharedRecipesApi,
-    Configuration,
-    RecipeShareTokenCreate
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new SharedRecipesApi(configuration);
-
-let recipeShareTokenCreate: RecipeShareTokenCreate; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.createOneApiSharedRecipesPost(
-    recipeShareTokenCreate,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **recipeShareTokenCreate** | **RecipeShareTokenCreate**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**RecipeShareToken**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | 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)
-
-# **deleteOneApiSharedRecipesItemIdDelete**
-> any deleteOneApiSharedRecipesItemIdDelete()
-
-
-### Example
-
-```typescript
-import {
-    SharedRecipesApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new SharedRecipesApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.deleteOneApiSharedRecipesItemIdDelete(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**any**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-
-# **getAllApiSharedRecipesGet**
-> Array<RecipeShareTokenSummary> getAllApiSharedRecipesGet()
-
-
-### Example
-
-```typescript
-import {
-    SharedRecipesApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new SharedRecipesApi(configuration);
-
-let recipeId: string; // (optional) (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getAllApiSharedRecipesGet(
-    recipeId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **recipeId** | [**string**] |  | (optional) defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<RecipeShareTokenSummary>**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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)
-
-# **getOneApiSharedRecipesItemIdGet**
-> RecipeShareToken getOneApiSharedRecipesItemIdGet()
-
-
-### Example
-
-```typescript
-import {
-    SharedRecipesApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new SharedRecipesApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getOneApiSharedRecipesItemIdGet(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**RecipeShareToken**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### 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/ShoppingListAddRecipeParams.md

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

@@ -1,24 +0,0 @@
-# ShoppingListAddRecipeParamsBulk
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipeIncrementQuantity** | **number** |  | [optional] [default to 1]
-**recipeIngredients** | [**Array<RecipeIngredientInput>**](RecipeIngredientInput.md) |  | [optional] [default to undefined]
-**recipeId** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListAddRecipeParamsBulk } from 'mealie-typescript';
-
-const instance: ShoppingListAddRecipeParamsBulk = {
-    recipeIncrementQuantity,
-    recipeIngredients,
-    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/ShoppingListCreate.md

@@ -1,26 +0,0 @@
-# ShoppingListCreate
-
-
-## 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]
-
-## Example
-
-```typescript
-import { ShoppingListCreate } from 'mealie-typescript';
-
-const instance: ShoppingListCreate = {
-    name,
-    extras,
-    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/ShoppingListItemCreate.md

@@ -1,48 +0,0 @@
-# ShoppingListItemCreate
-
-
-## 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]
-**id** | **string** |  | [optional] [default to undefined]
-**recipeReferences** | [**Array<ShoppingListItemRecipeRefCreate>**](ShoppingListItemRecipeRefCreate.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListItemCreate } from 'mealie-typescript';
-
-const instance: ShoppingListItemCreate = {
-    quantity,
-    unit,
-    food,
-    referencedRecipe,
-    note,
-    display,
-    shoppingListId,
-    checked,
-    position,
-    foodId,
-    labelId,
-    unitId,
-    extras,
-    id,
-    recipeReferences,
-};
-```
-
-[[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/ShoppingListItemOutInput.md

@@ -1,58 +0,0 @@
-# ShoppingListItemOutInput
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quantity** | **number** |  | [optional] [default to 1]
-**unit** | [**IngredientUnitInput**](IngredientUnitInput.md) |  | [optional] [default to undefined]
-**food** | [**IngredientFoodInput**](IngredientFoodInput.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]
-**id** | **string** |  | [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**label** | [**MultiPurposeLabelSummary**](MultiPurposeLabelSummary.md) |  | [optional] [default to undefined]
-**recipeReferences** | [**Array<ShoppingListItemRecipeRefOut>**](ShoppingListItemRecipeRefOut.md) |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**update_at** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListItemOutInput } from 'mealie-typescript';
-
-const instance: ShoppingListItemOutInput = {
-    quantity,
-    unit,
-    food,
-    referencedRecipe,
-    note,
-    display,
-    shoppingListId,
-    checked,
-    position,
-    foodId,
-    labelId,
-    unitId,
-    extras,
-    id,
-    groupId,
-    householdId,
-    label,
-    recipeReferences,
-    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/ShoppingListItemOutOutput.md

@@ -1,58 +0,0 @@
-# ShoppingListItemOutOutput
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quantity** | **number** |  | [optional] [default to 1]
-**unit** | [**IngredientUnitOutput**](IngredientUnitOutput.md) |  | [optional] [default to undefined]
-**food** | [**IngredientFoodOutput**](IngredientFoodOutput.md) |  | [optional] [default to undefined]
-**referencedRecipe** | [**RecipeOutput**](RecipeOutput.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]
-**id** | **string** |  | [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**label** | [**MultiPurposeLabelSummary**](MultiPurposeLabelSummary.md) |  | [optional] [default to undefined]
-**recipeReferences** | [**Array<ShoppingListItemRecipeRefOut>**](ShoppingListItemRecipeRefOut.md) |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShoppingListItemOutOutput } from 'mealie-typescript';
-
-const instance: ShoppingListItemOutOutput = {
-    quantity,
-    unit,
-    food,
-    referencedRecipe,
-    note,
-    display,
-    shoppingListId,
-    checked,
-    position,
-    foodId,
-    labelId,
-    unitId,
-    extras,
-    id,
-    groupId,
-    householdId,
-    label,
-    recipeReferences,
-    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/ShoppingListItemPagination.md

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

@@ -1,26 +0,0 @@
-# ShoppingListItemRecipeRefCreate
-
-
-## 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]
-
-## Example
-
-```typescript
-import { ShoppingListItemRecipeRefCreate } from 'mealie-typescript';
-
-const instance: ShoppingListItemRecipeRefCreate = {
-    recipeId,
-    recipeQuantity,
-    recipeScale,
-    recipeNote,
-};
-```
-
-[[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/ShoppingListItemRecipeRefOut.md

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

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

@@ -1,46 +0,0 @@
-# ShoppingListItemUpdate
-
-
-## 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]
-
-## Example
-
-```typescript
-import { ShoppingListItemUpdate } from 'mealie-typescript';
-
-const instance: ShoppingListItemUpdate = {
-    quantity,
-    unit,
-    food,
-    referencedRecipe,
-    note,
-    display,
-    shoppingListId,
-    checked,
-    position,
-    foodId,
-    labelId,
-    unitId,
-    extras,
-    recipeReferences,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)