mealie-typescript 1.0.6 → 1.0.8

package/docs/RecipeCategory.md

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

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

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

@@ -1,32 +0,0 @@
-# RecipeCommentOutInput
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipeId** | **string** |  | [default to undefined]
-**text** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
-**update_at** | **string** |  | [default to undefined]
-**userId** | **string** |  | [default to undefined]
-**user** | [**MealieSchemaRecipeRecipeCommentsUserBase**](MealieSchemaRecipeRecipeCommentsUserBase.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeCommentOutInput } from 'mealie-typescript';
-
-const instance: RecipeCommentOutInput = {
-    recipeId,
-    text,
-    id,
-    createdAt,
-    update_at,
-    userId,
-    user,
-};
-```
-
-[[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/RecipeCommentOutOutput.md

@@ -1,32 +0,0 @@
-# RecipeCommentOutOutput
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipeId** | **string** |  | [default to undefined]
-**text** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
-**updatedAt** | **string** |  | [default to undefined]
-**userId** | **string** |  | [default to undefined]
-**user** | [**MealieSchemaRecipeRecipeCommentsUserBase**](MealieSchemaRecipeRecipeCommentsUserBase.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { RecipeCommentOutOutput } from 'mealie-typescript';
-
-const instance: RecipeCommentOutOutput = {
-    recipeId,
-    text,
-    id,
-    createdAt,
-    updatedAt,
-    userId,
-    user,
-};
-```
-
-[[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/RecipeCommentPagination.md

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

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

@@ -1,361 +0,0 @@
-# RecipeCommentsApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createOneApiCommentsPost**](#createoneapicommentspost) | **POST** /api/comments | Create One|
-|[**deleteOneApiCommentsItemIdDelete**](#deleteoneapicommentsitemiddelete) | **DELETE** /api/comments/{item_id} | Delete One|
-|[**getAllApiCommentsGet**](#getallapicommentsget) | **GET** /api/comments | Get All|
-|[**getOneApiCommentsItemIdGet**](#getoneapicommentsitemidget) | **GET** /api/comments/{item_id} | Get One|
-|[**getRecipeCommentsApiRecipesSlugCommentsGet**](#getrecipecommentsapirecipesslugcommentsget) | **GET** /api/recipes/{slug}/comments | Get Recipe Comments|
-|[**updateOneApiCommentsItemIdPut**](#updateoneapicommentsitemidput) | **PUT** /api/comments/{item_id} | Update One|
-
-# **createOneApiCommentsPost**
-> RecipeCommentOutOutput createOneApiCommentsPost(recipeCommentCreate)
-
-
-### Example
-
-```typescript
-import {
-    RecipeCommentsApi,
-    Configuration,
-    RecipeCommentCreate
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeCommentsApi(configuration);
-
-let recipeCommentCreate: RecipeCommentCreate; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.createOneApiCommentsPost(
-    recipeCommentCreate,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **recipeCommentCreate** | **RecipeCommentCreate**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**RecipeCommentOutOutput**
-
-### 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)
-
-# **deleteOneApiCommentsItemIdDelete**
-> SuccessResponse deleteOneApiCommentsItemIdDelete()
-
-
-### Example
-
-```typescript
-import {
-    RecipeCommentsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeCommentsApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.deleteOneApiCommentsItemIdDelete(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**SuccessResponse**
-
-### 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)
-
-# **getAllApiCommentsGet**
-> RecipeCommentPagination getAllApiCommentsGet()
-
-
-### Example
-
-```typescript
-import {
-    RecipeCommentsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeCommentsApi(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.getAllApiCommentsGet(
-    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
-
-**RecipeCommentPagination**
-
-### 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)
-
-# **getOneApiCommentsItemIdGet**
-> RecipeCommentOutOutput getOneApiCommentsItemIdGet()
-
-
-### Example
-
-```typescript
-import {
-    RecipeCommentsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeCommentsApi(configuration);
-
-let itemId: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getOneApiCommentsItemIdGet(
-    itemId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**RecipeCommentOutOutput**
-
-### 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)
-
-# **getRecipeCommentsApiRecipesSlugCommentsGet**
-> Array<RecipeCommentOutOutput> getRecipeCommentsApiRecipesSlugCommentsGet()
-
-Get all comments for a recipe
-
-### Example
-
-```typescript
-import {
-    RecipeCommentsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeCommentsApi(configuration);
-
-let slug: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getRecipeCommentsApiRecipesSlugCommentsGet(
-    slug,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **slug** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<RecipeCommentOutOutput>**
-
-### 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)
-
-# **updateOneApiCommentsItemIdPut**
-> RecipeCommentOutOutput updateOneApiCommentsItemIdPut(recipeCommentUpdate)
-
-
-### Example
-
-```typescript
-import {
-    RecipeCommentsApi,
-    Configuration,
-    RecipeCommentUpdate
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeCommentsApi(configuration);
-
-let itemId: string; // (default to undefined)
-let recipeCommentUpdate: RecipeCommentUpdate; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.updateOneApiCommentsItemIdPut(
-    itemId,
-    recipeCommentUpdate,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **recipeCommentUpdate** | **RecipeCommentUpdate**|  | |
-| **itemId** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**RecipeCommentOutOutput**
-
-### 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/RecipeDuplicate.md

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

@@ -1,118 +0,0 @@
-# RecipeExportsApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getRecipeAsFormatApiRecipesSlugExportsGet**](#getrecipeasformatapirecipesslugexportsget) | **GET** /api/recipes/{slug}/exports | Get Recipe As Format|
-|[**getRecipeFormatsAndTemplatesApiRecipesExportsGet**](#getrecipeformatsandtemplatesapirecipesexportsget) | **GET** /api/recipes/exports | Get Recipe Formats And Templates|
-
-# **getRecipeAsFormatApiRecipesSlugExportsGet**
-> getRecipeAsFormatApiRecipesSlugExportsGet()
-
-## Parameters `template_name`: The name of the template to use to use in the exports listed. Template type will automatically be set on the backend. Because of this, it\'s important that your templates have unique names. See available names and formats in the /api/recipes/exports endpoint.
-
-### Example
-
-```typescript
-import {
-    RecipeExportsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeExportsApi(configuration);
-
-let slug: string; // (default to undefined)
-let templateName: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getRecipeAsFormatApiRecipesSlugExportsGet(
-    slug,
-    templateName,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **slug** | [**string**] |  | defaults to undefined|
-| **templateName** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### 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)
-
-# **getRecipeFormatsAndTemplatesApiRecipesExportsGet**
-> FormatResponse getRecipeFormatsAndTemplatesApiRecipesExportsGet()
-
-
-### Example
-
-```typescript
-import {
-    RecipeExportsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new RecipeExportsApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getRecipeFormatsAndTemplatesApiRecipesExportsGet(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**FormatResponse**
-
-### 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)
-