mealie-typescript 1.0.5 → 1.0.7

package/docs/HouseholdsWebhooksApi.md

@@ -1,413 +0,0 @@
-# HouseholdsWebhooksApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createOneApiHouseholdsWebhooksPost**](#createoneapihouseholdswebhookspost) | **POST** /api/households/webhooks | Create One|
-|[**deleteOneApiHouseholdsWebhooksItemIdDelete**](#deleteoneapihouseholdswebhooksitemiddelete) | **DELETE** /api/households/webhooks/{item_id} | Delete One|
-|[**getAllApiHouseholdsWebhooksGet**](#getallapihouseholdswebhooksget) | **GET** /api/households/webhooks | Get All|
-|[**getOneApiHouseholdsWebhooksItemIdGet**](#getoneapihouseholdswebhooksitemidget) | **GET** /api/households/webhooks/{item_id} | Get One|
-|[**rerunWebhooksApiHouseholdsWebhooksRerunPost**](#rerunwebhooksapihouseholdswebhooksrerunpost) | **POST** /api/households/webhooks/rerun | Rerun Webhooks|
-|[**testOneApiHouseholdsWebhooksItemIdTestPost**](#testoneapihouseholdswebhooksitemidtestpost) | **POST** /api/households/webhooks/{item_id}/test | Test One|
-|[**updateOneApiHouseholdsWebhooksItemIdPut**](#updateoneapihouseholdswebhooksitemidput) | **PUT** /api/households/webhooks/{item_id} | Update One|
-
-# **createOneApiHouseholdsWebhooksPost**
-> ReadWebhook createOneApiHouseholdsWebhooksPost(createWebhook)
-
-
-### Example
-
-```typescript
-import {
-    HouseholdsWebhooksApi,
-    Configuration,
-    CreateWebhook
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new HouseholdsWebhooksApi(configuration);
-
-let createWebhook: CreateWebhook; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.createOneApiHouseholdsWebhooksPost(
-    createWebhook,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createWebhook** | **CreateWebhook**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ReadWebhook**
-
-### 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)
-
-# **deleteOneApiHouseholdsWebhooksItemIdDelete**
-> ReadWebhook deleteOneApiHouseholdsWebhooksItemIdDelete()
-
-
-### Example
-
-```typescript
-import {
-    HouseholdsWebhooksApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new HouseholdsWebhooksApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.deleteOneApiHouseholdsWebhooksItemIdDelete(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ReadWebhook**
-
-### 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)
-
-# **getAllApiHouseholdsWebhooksGet**
-> WebhookPagination getAllApiHouseholdsWebhooksGet()
-
-
-### Example
-
-```typescript
-import {
-    HouseholdsWebhooksApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new HouseholdsWebhooksApi(configuration);
-
-let orderBy: string; // (optional) (default to undefined)
-let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
-let orderDirection: OrderDirection; // (optional) (default to undefined)
-let queryFilter: string; // (optional) (default to undefined)
-let paginationSeed: string; // (optional) (default to undefined)
-let page: number; // (optional) (default to 1)
-let perPage: number; // (optional) (default to 50)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getAllApiHouseholdsWebhooksGet(
-    orderBy,
-    orderByNullPosition,
-    orderDirection,
-    queryFilter,
-    paginationSeed,
-    page,
-    perPage,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **orderBy** | [**string**] |  | (optional) defaults to undefined|
-| **orderByNullPosition** | **OrderByNullPosition** |  | (optional) defaults to undefined|
-| **orderDirection** | **OrderDirection** |  | (optional) defaults to undefined|
-| **queryFilter** | [**string**] |  | (optional) defaults to undefined|
-| **paginationSeed** | [**string**] |  | (optional) defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to 1|
-| **perPage** | [**number**] |  | (optional) defaults to 50|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**WebhookPagination**
-
-### 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)
-
-# **getOneApiHouseholdsWebhooksItemIdGet**
-> ReadWebhook getOneApiHouseholdsWebhooksItemIdGet()
-
-
-### Example
-
-```typescript
-import {
-    HouseholdsWebhooksApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new HouseholdsWebhooksApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getOneApiHouseholdsWebhooksItemIdGet(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ReadWebhook**
-
-### 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)
-
-# **rerunWebhooksApiHouseholdsWebhooksRerunPost**
-> any rerunWebhooksApiHouseholdsWebhooksRerunPost()
-
-Manually re-fires all previously scheduled webhooks for today
-
-### Example
-
-```typescript
-import {
-    HouseholdsWebhooksApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new HouseholdsWebhooksApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.rerunWebhooksApiHouseholdsWebhooksRerunPost(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **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)
-
-# **testOneApiHouseholdsWebhooksItemIdTestPost**
-> any testOneApiHouseholdsWebhooksItemIdTestPost()
-
-
-### Example
-
-```typescript
-import {
-    HouseholdsWebhooksApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new HouseholdsWebhooksApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.testOneApiHouseholdsWebhooksItemIdTestPost(
-    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)
-
-# **updateOneApiHouseholdsWebhooksItemIdPut**
-> ReadWebhook updateOneApiHouseholdsWebhooksItemIdPut(createWebhook)
-
-
-### Example
-
-```typescript
-import {
-    HouseholdsWebhooksApi,
-    Configuration,
-    CreateWebhook
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new HouseholdsWebhooksApi(configuration);
-
-let itemId: string; // (default to undefined)
-let createWebhook: CreateWebhook; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.updateOneApiHouseholdsWebhooksItemIdPut(
-    itemId,
-    createWebhook,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createWebhook** | **CreateWebhook**|  | |
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ReadWebhook**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **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/ImageType.md

@@ -1,12 +0,0 @@
-# ImageType
-
-
-## Enum
-
-* `OriginalWebp` (value: `'original.webp'`)
-
-* `MinOriginalWebp` (value: `'min-original.webp'`)
-
-* `TinyOriginalWebp` (value: `'tiny-original.webp'`)
-
-[[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/IngredientConfidence.md

@@ -1,30 +0,0 @@
-# IngredientConfidence
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**average** | **number** |  | [optional] [default to undefined]
-**comment** | **number** |  | [optional] [default to undefined]
-**name** | **number** |  | [optional] [default to undefined]
-**unit** | **number** |  | [optional] [default to undefined]
-**quantity** | **number** |  | [optional] [default to undefined]
-**food** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IngredientConfidence } from 'mealie-typescript';
-
-const instance: IngredientConfidence = {
-    average,
-    comment,
-    name,
-    unit,
-    quantity,
-    food,
-};
-```
-
-[[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/IngredientFoodAlias.md

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

@@ -1,40 +0,0 @@
-# IngredientFoodInput
-
-
-## 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]
-**labelId** | **string** |  | [optional] [default to undefined]
-**aliases** | [**Array<IngredientFoodAlias>**](IngredientFoodAlias.md) |  | [optional] [default to undefined]
-**householdsWithIngredientFood** | **Array<string>** |  | [optional] [default to undefined]
-**label** | [**MultiPurposeLabelSummary**](MultiPurposeLabelSummary.md) |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**update_at** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IngredientFoodInput } from 'mealie-typescript';
-
-const instance: IngredientFoodInput = {
-    id,
-    name,
-    pluralName,
-    description,
-    extras,
-    labelId,
-    aliases,
-    householdsWithIngredientFood,
-    label,
-    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/IngredientFoodOutput.md

@@ -1,40 +0,0 @@
-# IngredientFoodOutput
-
-
-## 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]
-**labelId** | **string** |  | [optional] [default to undefined]
-**aliases** | [**Array<IngredientFoodAlias>**](IngredientFoodAlias.md) |  | [optional] [default to undefined]
-**householdsWithIngredientFood** | **Array<string>** |  | [optional] [default to undefined]
-**label** | [**MultiPurposeLabelSummary**](MultiPurposeLabelSummary.md) |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IngredientFoodOutput } from 'mealie-typescript';
-
-const instance: IngredientFoodOutput = {
-    id,
-    name,
-    pluralName,
-    description,
-    extras,
-    labelId,
-    aliases,
-    householdsWithIngredientFood,
-    label,
-    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/IngredientFoodPagination.md

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

@@ -1,21 +0,0 @@
-# IngredientReferences
-
-A list of ingredient references.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**referenceId** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IngredientReferences } from 'mealie-typescript';
-
-const instance: IngredientReferences = {
-    referenceId,
-};
-```
-
-[[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/IngredientRequest.md

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

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

@@ -1,42 +0,0 @@
-# IngredientUnitInput
-
-
-## 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]
-**update_at** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IngredientUnitInput } from 'mealie-typescript';
-
-const instance: IngredientUnitInput = {
-    id,
-    name,
-    pluralName,
-    description,
-    extras,
-    fraction,
-    abbreviation,
-    pluralAbbreviation,
-    useAbbreviation,
-    aliases,
-    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)