mealie-typescript 1.0.5 → 1.0.7

package/docs/UsersRatingsApi.md

@@ -1,300 +0,0 @@
-# UsersRatingsApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**addFavoriteApiUsersIdFavoritesSlugPost**](#addfavoriteapiusersidfavoritesslugpost) | **POST** /api/users/{id}/favorites/{slug} | Add Favorite|
-|[**getFavoritesApiUsersIdFavoritesGet**](#getfavoritesapiusersidfavoritesget) | **GET** /api/users/{id}/favorites | Get Favorites|
-|[**getRatingsApiUsersIdRatingsGet**](#getratingsapiusersidratingsget) | **GET** /api/users/{id}/ratings | Get Ratings|
-|[**removeFavoriteApiUsersIdFavoritesSlugDelete**](#removefavoriteapiusersidfavoritesslugdelete) | **DELETE** /api/users/{id}/favorites/{slug} | Remove Favorite|
-|[**setRatingApiUsersIdRatingsSlugPost**](#setratingapiusersidratingsslugpost) | **POST** /api/users/{id}/ratings/{slug} | Set Rating|
-
-# **addFavoriteApiUsersIdFavoritesSlugPost**
-> any addFavoriteApiUsersIdFavoritesSlugPost()
-
-Adds a recipe to the user\'s favorites
-
-### Example
-
-```typescript
-import {
-    UsersRatingsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersRatingsApi(configuration);
-
-let id: string; // (default to undefined)
-let slug: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.addFavoriteApiUsersIdFavoritesSlugPost(
-    id,
-    slug,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-| **slug** | [**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)
-
-# **getFavoritesApiUsersIdFavoritesGet**
-> UserRatingsUserRatingOut getFavoritesApiUsersIdFavoritesGet()
-
-Get user\'s favorited recipes
-
-### Example
-
-```typescript
-import {
-    UsersRatingsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersRatingsApi(configuration);
-
-let id: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getFavoritesApiUsersIdFavoritesGet(
-    id,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**UserRatingsUserRatingOut**
-
-### 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)
-
-# **getRatingsApiUsersIdRatingsGet**
-> UserRatingsUserRatingOut getRatingsApiUsersIdRatingsGet()
-
-Get user\'s rated recipes
-
-### Example
-
-```typescript
-import {
-    UsersRatingsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersRatingsApi(configuration);
-
-let id: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getRatingsApiUsersIdRatingsGet(
-    id,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**UserRatingsUserRatingOut**
-
-### 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)
-
-# **removeFavoriteApiUsersIdFavoritesSlugDelete**
-> any removeFavoriteApiUsersIdFavoritesSlugDelete()
-
-Removes a recipe from the user\'s favorites
-
-### Example
-
-```typescript
-import {
-    UsersRatingsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersRatingsApi(configuration);
-
-let id: string; // (default to undefined)
-let slug: string; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.removeFavoriteApiUsersIdFavoritesSlugDelete(
-    id,
-    slug,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-| **slug** | [**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)
-
-# **setRatingApiUsersIdRatingsSlugPost**
-> any setRatingApiUsersIdRatingsSlugPost(userRatingUpdate)
-
-Sets the user\'s rating for a recipe
-
-### Example
-
-```typescript
-import {
-    UsersRatingsApi,
-    Configuration,
-    UserRatingUpdate
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersRatingsApi(configuration);
-
-let id: string; // (default to undefined)
-let slug: string; // (default to undefined)
-let userRatingUpdate: UserRatingUpdate; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.setRatingApiUsersIdRatingsSlugPost(
-    id,
-    slug,
-    userRatingUpdate,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **userRatingUpdate** | **UserRatingUpdate**|  | |
-| **id** | [**string**] |  | defaults to undefined|
-| **slug** | [**string**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**any**
-
-### 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/UsersRegistrationApi.md

@@ -1,63 +0,0 @@
-# UsersRegistrationApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**registerNewUserApiUsersRegisterPost**](#registernewuserapiusersregisterpost) | **POST** /api/users/register | Register New User|
-
-# **registerNewUserApiUsersRegisterPost**
-> UserOut registerNewUserApiUsersRegisterPost(createUserRegistration)
-
-
-### Example
-
-```typescript
-import {
-    UsersRegistrationApi,
-    Configuration,
-    CreateUserRegistration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersRegistrationApi(configuration);
-
-let createUserRegistration: CreateUserRegistration; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.registerNewUserApiUsersRegisterPost(
-    createUserRegistration,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createUserRegistration** | **CreateUserRegistration**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**UserOut**
-
-### Authorization
-
-No authorization required
-
-### 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)
-

package/docs/UsersTokensApi.md

@@ -1,120 +0,0 @@
-# UsersTokensApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createApiTokenApiUsersApiTokensPost**](#createapitokenapiusersapitokenspost) | **POST** /api/users/api-tokens | Create Api Token|
-|[**deleteApiTokenApiUsersApiTokensTokenIdDelete**](#deleteapitokenapiusersapitokenstokeniddelete) | **DELETE** /api/users/api-tokens/{token_id} | Delete Api Token|
-
-# **createApiTokenApiUsersApiTokensPost**
-> LongLiveTokenCreateResponse createApiTokenApiUsersApiTokensPost(longLiveTokenIn)
-
-Create api_token in the Database
-
-### Example
-
-```typescript
-import {
-    UsersTokensApi,
-    Configuration,
-    LongLiveTokenIn
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersTokensApi(configuration);
-
-let longLiveTokenIn: LongLiveTokenIn; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.createApiTokenApiUsersApiTokensPost(
-    longLiveTokenIn,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **longLiveTokenIn** | **LongLiveTokenIn**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**LongLiveTokenCreateResponse**
-
-### 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)
-
-# **deleteApiTokenApiUsersApiTokensTokenIdDelete**
-> DeleteTokenResponse deleteApiTokenApiUsersApiTokensTokenIdDelete()
-
-Delete api_token from the Database
-
-### Example
-
-```typescript
-import {
-    UsersTokensApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersTokensApi(configuration);
-
-let tokenId: number; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.deleteApiTokenApiUsersApiTokensTokenIdDelete(
-    tokenId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **tokenId** | [**number**] |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**DeleteTokenResponse**
-
-### 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/UtilsApi.md

@@ -1,60 +0,0 @@
-# UtilsApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**downloadFileApiUtilsDownloadGet**](#downloadfileapiutilsdownloadget) | **GET** /api/utils/download | Download File|
-
-# **downloadFileApiUtilsDownloadGet**
-> any downloadFileApiUtilsDownloadGet()
-
-Uses a file token obtained by an active user to retrieve a file from the operating system.
-
-### Example
-
-```typescript
-import {
-    UtilsApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UtilsApi(configuration);
-
-let token: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.downloadFileApiUtilsDownloadGet(
-    token
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **token** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**any**
-
-### Authorization
-
-No authorization required
-
-### 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/ValidationError.md

@@ -1,24 +0,0 @@
-# ValidationError
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**loc** | [**Array<ValidationErrorLocInner>**](ValidationErrorLocInner.md) |  | [default to undefined]
-**msg** | **string** |  | [default to undefined]
-**type** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ValidationError } from 'mealie-typescript';
-
-const instance: ValidationError = {
-    loc,
-    msg,
-    type,
-};
-```
-
-[[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/ValidationErrorLocInner.md

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

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

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

@@ -1,8 +0,0 @@
-# WebhookType
-
-
-## Enum
-
-* `Mealplan` (value: `'mealplan'`)
-
-[[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/index.ts

@@ -1,18 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Mealie
- *  Mealie is a web application for managing your recipes, meal plans, and shopping lists. This is the Restful API interactive documentation that can be used to explore the API. If you\'re justing getting started with the API and want to get started quickly, you can use the [API Usage | Mealie Docs](https://docs.mealie.io/documentation/getting-started/api-usage/) as a reference for how to get started.   If you have any questions or comments about mealie, please use the discord server to talk to the developers or other community members. If you\'d like to file an issue, please use the [GitHub Issue Tracker | Mealie](https://github.com/mealie-recipes/mealie/issues/new/choose)   ## Helpful Links - [Home Page](https://mealie.io) - [Documentation](https://docs.mealie.io) - [Discord](https://discord.gg/QuStdQGSGK) - [Demo](https://demo.mealie.io) 
- *
- * The version of the OpenAPI document: nightly
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-export * from "./api";
-export * from "./configuration";
-

package/tsconfig.json

@@ -1,21 +0,0 @@
-{
-  "compilerOptions": {
-    "declaration": true,
-    "target": "ES5",
-    "module": "commonjs",
-    "noImplicitAny": true,
-    "outDir": "dist",
-    "rootDir": ".",
-    "lib": [
-      "es2017",
-      "dom"
-    ],
-    "typeRoots": [
-      "node_modules/@types"
-    ]
-  },
-  "exclude": [
-    "dist",
-    "node_modules"
-  ]
-}