mealie-typescript 1.0.0

package/docs/RecipesUnitsApi.md

@@ -0,0 +1,364 @@
+# RecipesUnitsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createOneApiUnitsPost**](#createoneapiunitspost) | **POST** /api/units | Create One|
+|[**deleteOneApiUnitsItemIdDelete**](#deleteoneapiunitsitemiddelete) | **DELETE** /api/units/{item_id} | Delete One|
+|[**getAllApiUnitsGet**](#getallapiunitsget) | **GET** /api/units | Get All|
+|[**getOneApiUnitsItemIdGet**](#getoneapiunitsitemidget) | **GET** /api/units/{item_id} | Get One|
+|[**mergeOneApiUnitsMergePut**](#mergeoneapiunitsmergeput) | **PUT** /api/units/merge | Merge One|
+|[**updateOneApiUnitsItemIdPut**](#updateoneapiunitsitemidput) | **PUT** /api/units/{item_id} | Update One|
+
+# **createOneApiUnitsPost**
+> IngredientUnitOutput createOneApiUnitsPost(createIngredientUnit)
+
+
+### Example
+
+```typescript
+import {
+    RecipesUnitsApi,
+    Configuration,
+    CreateIngredientUnit
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new RecipesUnitsApi(configuration);
+
+let createIngredientUnit: CreateIngredientUnit; //
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.createOneApiUnitsPost(
+    createIngredientUnit,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createIngredientUnit** | **CreateIngredientUnit**|  | |
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**IngredientUnitOutput**
+
+### 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)
+
+# **deleteOneApiUnitsItemIdDelete**
+> IngredientUnitOutput deleteOneApiUnitsItemIdDelete()
+
+
+### Example
+
+```typescript
+import {
+    RecipesUnitsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new RecipesUnitsApi(configuration);
+
+let itemId: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.deleteOneApiUnitsItemIdDelete(
+    itemId,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **itemId** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**IngredientUnitOutput**
+
+### 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)
+
+# **getAllApiUnitsGet**
+> IngredientUnitPagination getAllApiUnitsGet()
+
+
+### Example
+
+```typescript
+import {
+    RecipesUnitsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new RecipesUnitsApi(configuration);
+
+let search: string; // (optional) (default to undefined)
+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.getAllApiUnitsGet(
+    search,
+    orderBy,
+    orderByNullPosition,
+    orderDirection,
+    queryFilter,
+    paginationSeed,
+    page,
+    perPage,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] |  | (optional) defaults to undefined|
+| **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
+
+**IngredientUnitPagination**
+
+### 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)
+
+# **getOneApiUnitsItemIdGet**
+> IngredientUnitOutput getOneApiUnitsItemIdGet()
+
+
+### Example
+
+```typescript
+import {
+    RecipesUnitsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new RecipesUnitsApi(configuration);
+
+let itemId: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getOneApiUnitsItemIdGet(
+    itemId,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **itemId** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**IngredientUnitOutput**
+
+### 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)
+
+# **mergeOneApiUnitsMergePut**
+> SuccessResponse mergeOneApiUnitsMergePut(mergeUnit)
+
+
+### Example
+
+```typescript
+import {
+    RecipesUnitsApi,
+    Configuration,
+    MergeUnit
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new RecipesUnitsApi(configuration);
+
+let mergeUnit: MergeUnit; //
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.mergeOneApiUnitsMergePut(
+    mergeUnit,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mergeUnit** | **MergeUnit**|  | |
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### 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)
+
+# **updateOneApiUnitsItemIdPut**
+> IngredientUnitOutput updateOneApiUnitsItemIdPut(createIngredientUnit)
+
+
+### Example
+
+```typescript
+import {
+    RecipesUnitsApi,
+    Configuration,
+    CreateIngredientUnit
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new RecipesUnitsApi(configuration);
+
+let itemId: string; // (default to undefined)
+let createIngredientUnit: CreateIngredientUnit; //
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.updateOneApiUnitsItemIdPut(
+    itemId,
+    createIngredientUnit,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createIngredientUnit** | **CreateIngredientUnit**|  | |
+| **itemId** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**IngredientUnitOutput**
+
+### 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/RegisteredParser.md

@@ -0,0 +1,12 @@
+# RegisteredParser
+
+
+## Enum
+
+* `Nlp` (value: `'nlp'`)
+
+* `Brute` (value: `'brute'`)
+
+* `Openai` (value: `'openai'`)
+
+[[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/RelationalKeyword.md

@@ -0,0 +1,20 @@
+# RelationalKeyword
+
+
+## Enum
+
+* `Is` (value: `'IS'`)
+
+* `IsNot` (value: `'IS NOT'`)
+
+* `In` (value: `'IN'`)
+
+* `NotIn` (value: `'NOT IN'`)
+
+* `ContainsAll` (value: `'CONTAINS ALL'`)
+
+* `Like` (value: `'LIKE'`)
+
+* `NotLike` (value: `'NOT LIKE'`)
+
+[[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/RelationalOperator.md

@@ -0,0 +1,18 @@
+# RelationalOperator
+
+
+## Enum
+
+* `Equal` (value: `'='`)
+
+* `NotEqual` (value: `'<>'`)
+
+* `GreaterThan` (value: `'>'`)
+
+* `LessThan` (value: `'<'`)
+
+* `GreaterThanOrEqualTo` (value: `'>='`)
+
+* `LessThanOrEqualTo` (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/Relationaloperator.md

@@ -0,0 +1,18 @@
+# Relationaloperator
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { Relationaloperator } from 'mealie-typescript';
+
+const instance: Relationaloperator = {
+};
+```
+
+[[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/ReportCategory.md

@@ -0,0 +1,14 @@
+# ReportCategory
+
+
+## Enum
+
+* `Backup` (value: `'backup'`)
+
+* `Restore` (value: `'restore'`)
+
+* `Migration` (value: `'migration'`)
+
+* `BulkImport` (value: `'bulk_import'`)
+
+[[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/ReportEntryOut.md

@@ -0,0 +1,30 @@
+# ReportEntryOut
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reportId** | **string** |  | [default to undefined]
+**timestamp** | **string** |  | [optional] [default to undefined]
+**success** | **boolean** |  | [optional] [default to true]
+**message** | **string** |  | [default to undefined]
+**exception** | **string** |  | [optional] [default to '']
+**id** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReportEntryOut } from 'mealie-typescript';
+
+const instance: ReportEntryOut = {
+    reportId,
+    timestamp,
+    success,
+    message,
+    exception,
+    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/ReportOut.md

@@ -0,0 +1,32 @@
+# ReportOut
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **string** |  | [optional] [default to undefined]
+**category** | [**ReportCategory**](ReportCategory.md) |  | [default to undefined]
+**groupId** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**status** | [**ReportSummaryStatus**](ReportSummaryStatus.md) |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**entries** | [**Array<ReportEntryOut>**](ReportEntryOut.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReportOut } from 'mealie-typescript';
+
+const instance: ReportOut = {
+    timestamp,
+    category,
+    groupId,
+    name,
+    status,
+    id,
+    entries,
+};
+```
+
+[[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/ReportSummary.md

@@ -0,0 +1,30 @@
+# ReportSummary
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **string** |  | [optional] [default to undefined]
+**category** | [**ReportCategory**](ReportCategory.md) |  | [default to undefined]
+**groupId** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**status** | [**ReportSummaryStatus**](ReportSummaryStatus.md) |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReportSummary } from 'mealie-typescript';
+
+const instance: ReportSummary = {
+    timestamp,
+    category,
+    groupId,
+    name,
+    status,
+    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/ReportSummaryStatus.md

@@ -0,0 +1,14 @@
+# ReportSummaryStatus
+
+
+## Enum
+
+* `InProgress` (value: `'in-progress'`)
+
+* `Success` (value: `'success'`)
+
+* `Failure` (value: `'failure'`)
+
+* `Partial` (value: `'partial'`)
+
+[[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/ResetPassword.md

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

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

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

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

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