mealie-typescript 1.0.0

package/docs/UsersRatingsApi.md

@@ -0,0 +1,300 @@
+# 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

@@ -0,0 +1,63 @@
+# 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

@@ -0,0 +1,120 @@
+# 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

@@ -0,0 +1,60 @@
+# 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

@@ -0,0 +1,24 @@
+# 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

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,32 @@
+# 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

@@ -0,0 +1,8 @@
+# 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/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'