mealie-typescript 1.0.6 → 1.0.8

package/docs/RecipeTimelineApi.md

@@ -1,366 +0,0 @@
-# RecipeTimelineApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createOneApiRecipesTimelineEventsPost**](#createoneapirecipestimelineeventspost) | **POST** /api/recipes/timeline/events | Create One|
-|[**deleteOneApiRecipesTimelineEventsItemIdDelete**](#deleteoneapirecipestimelineeventsitemiddelete) | **DELETE** /api/recipes/timeline/events/{item_id} | Delete One|
-|[**getAllApiRecipesTimelineEventsGet**](#getallapirecipestimelineeventsget) | **GET** /api/recipes/timeline/events | Get All|
-|[**getOneApiRecipesTimelineEventsItemIdGet**](#getoneapirecipestimelineeventsitemidget) | **GET** /api/recipes/timeline/events/{item_id} | Get One|
-|[**updateEventImageApiRecipesTimelineEventsItemIdImagePut**](#updateeventimageapirecipestimelineeventsitemidimageput) | **PUT** /api/recipes/timeline/events/{item_id}/image | Update Event Image|
-|[**updateOneApiRecipesTimelineEventsItemIdPut**](#updateoneapirecipestimelineeventsitemidput) | **PUT** /api/recipes/timeline/events/{item_id} | Update One|
-
-# **createOneApiRecipesTimelineEventsPost**
-> RecipeTimelineEventOut createOneApiRecipesTimelineEventsPost(recipeTimelineEventIn)
-
-
-### Example
-
-```typescript
-import {
-    RecipeTimelineApi,
-    Configuration,
-    RecipeTimelineEventIn
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeTimelineApi(configuration);
-
-let recipeTimelineEventIn: RecipeTimelineEventIn; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.createOneApiRecipesTimelineEventsPost(
-    recipeTimelineEventIn,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **recipeTimelineEventIn** | **RecipeTimelineEventIn**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**RecipeTimelineEventOut**
-
-### 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)
-
-# **deleteOneApiRecipesTimelineEventsItemIdDelete**
-> RecipeTimelineEventOut deleteOneApiRecipesTimelineEventsItemIdDelete()
-
-
-### Example
-
-```typescript
-import {
-    RecipeTimelineApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeTimelineApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.deleteOneApiRecipesTimelineEventsItemIdDelete(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**RecipeTimelineEventOut**
-
-### 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)
-
-# **getAllApiRecipesTimelineEventsGet**
-> RecipeTimelineEventPagination getAllApiRecipesTimelineEventsGet()
-
-
-### Example
-
-```typescript
-import {
-    RecipeTimelineApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeTimelineApi(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.getAllApiRecipesTimelineEventsGet(
-    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
-
-**RecipeTimelineEventPagination**
-
-### 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)
-
-# **getOneApiRecipesTimelineEventsItemIdGet**
-> RecipeTimelineEventOut getOneApiRecipesTimelineEventsItemIdGet()
-
-
-### Example
-
-```typescript
-import {
-    RecipeTimelineApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeTimelineApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getOneApiRecipesTimelineEventsItemIdGet(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**RecipeTimelineEventOut**
-
-### 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)
-
-# **updateEventImageApiRecipesTimelineEventsItemIdImagePut**
-> UpdateImageResponse updateEventImageApiRecipesTimelineEventsItemIdImagePut()
-
-
-### Example
-
-```typescript
-import {
-    RecipeTimelineApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeTimelineApi(configuration);
-
-let itemId: string; // (default to undefined)
-let image: File; // (default to undefined)
-let extension: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.updateEventImageApiRecipesTimelineEventsItemIdImagePut(
-    itemId,
-    image,
-    extension,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **image** | [**File**] |  | defaults to undefined|
-| **extension** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**UpdateImageResponse**
-
-### Authorization
-
-[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **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)
-
-# **updateOneApiRecipesTimelineEventsItemIdPut**
-> RecipeTimelineEventOut updateOneApiRecipesTimelineEventsItemIdPut(recipeTimelineEventUpdate)
-
-
-### Example
-
-```typescript
-import {
-    RecipeTimelineApi,
-    Configuration,
-    RecipeTimelineEventUpdate
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeTimelineApi(configuration);
-
-let itemId: string; // (default to undefined)
-let recipeTimelineEventUpdate: RecipeTimelineEventUpdate; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.updateOneApiRecipesTimelineEventsItemIdPut(
-    itemId,
-    recipeTimelineEventUpdate,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **recipeTimelineEventUpdate** | **RecipeTimelineEventUpdate**|  | |
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**RecipeTimelineEventOut**
-
-### 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/RecipeTimelineEventIn.md

@@ -1,32 +0,0 @@
-# RecipeTimelineEventIn
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipeId** | **string** |  | [default to undefined]
-**userId** | **string** |  | [optional] [default to undefined]
-**subject** | **string** |  | [default to undefined]
-**eventType** | [**TimelineEventType**](TimelineEventType.md) |  | [default to undefined]
-**eventMessage** | **string** |  | [optional] [default to undefined]
-**image** | [**TimelineEventImage**](TimelineEventImage.md) |  | [optional] [default to undefined]
-**timestamp** | **string** |  | [optional] [default to 2025-12-07T04:02:33.960708Z]
-
-## Example
-
-```typescript
-import { RecipeTimelineEventIn } from 'mealie-typescript';
-
-const instance: RecipeTimelineEventIn = {
-    recipeId,
-    userId,
-    subject,
-    eventType,
-    eventMessage,
-    image,
-    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/RecipeTimelineEventOut.md

@@ -1,42 +0,0 @@
-# RecipeTimelineEventOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipeId** | **string** |  | [default to undefined]
-**userId** | **string** |  | [default to undefined]
-**subject** | **string** |  | [default to undefined]
-**eventType** | [**TimelineEventType**](TimelineEventType.md) |  | [default to undefined]
-**eventMessage** | **string** |  | [optional] [default to undefined]
-**image** | [**TimelineEventImage**](TimelineEventImage.md) |  | [optional] [default to undefined]
-**timestamp** | **string** |  | [optional] [default to 2025-12-07T04:02:33.960708Z]
-**id** | **string** |  | [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
-**updatedAt** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeTimelineEventOut } from 'mealie-typescript';
-
-const instance: RecipeTimelineEventOut = {
-    recipeId,
-    userId,
-    subject,
-    eventType,
-    eventMessage,
-    image,
-    timestamp,
-    id,
-    groupId,
-    householdId,
-    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/RecipeTimelineEventPagination.md

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

@@ -1,24 +0,0 @@
-# RecipeTimelineEventUpdate
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**subject** | **string** |  | [default to undefined]
-**eventMessage** | **string** |  | [optional] [default to undefined]
-**image** | [**TimelineEventImage**](TimelineEventImage.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeTimelineEventUpdate } from 'mealie-typescript';
-
-const instance: RecipeTimelineEventUpdate = {
-    subject,
-    eventMessage,
-    image,
-};
-```
-
-[[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/RecipeTool.md

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

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

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

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

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