mealie-typescript 1.0.0

package/docs/UsersCRUDApi.md

@@ -0,0 +1,334 @@
+# UsersCRUDApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getLoggedInUserApiUsersSelfGet**](#getloggedinuserapiusersselfget) | **GET** /api/users/self | Get Logged In User|
+|[**getLoggedInUserFavoritesApiUsersSelfFavoritesGet**](#getloggedinuserfavoritesapiusersselffavoritesget) | **GET** /api/users/self/favorites | Get Logged In User Favorites|
+|[**getLoggedInUserRatingForRecipeApiUsersSelfRatingsRecipeIdGet**](#getloggedinuserratingforrecipeapiusersselfratingsrecipeidget) | **GET** /api/users/self/ratings/{recipe_id} | Get Logged In User Rating For Recipe|
+|[**getLoggedInUserRatingsApiUsersSelfRatingsGet**](#getloggedinuserratingsapiusersselfratingsget) | **GET** /api/users/self/ratings | Get Logged In User Ratings|
+|[**updatePasswordApiUsersPasswordPut**](#updatepasswordapiuserspasswordput) | **PUT** /api/users/password | Update Password|
+|[**updateUserApiUsersItemIdPut**](#updateuserapiusersitemidput) | **PUT** /api/users/{item_id} | Update User|
+
+# **getLoggedInUserApiUsersSelfGet**
+> UserOut getLoggedInUserApiUsersSelfGet()
+
+
+### Example
+
+```typescript
+import {
+    UsersCRUDApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new UsersCRUDApi(configuration);
+
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getLoggedInUserApiUsersSelfGet(
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserOut**
+
+### 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)
+
+# **getLoggedInUserFavoritesApiUsersSelfFavoritesGet**
+> UserRatingsUserRatingSummary getLoggedInUserFavoritesApiUsersSelfFavoritesGet()
+
+
+### Example
+
+```typescript
+import {
+    UsersCRUDApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new UsersCRUDApi(configuration);
+
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getLoggedInUserFavoritesApiUsersSelfFavoritesGet(
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserRatingsUserRatingSummary**
+
+### 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)
+
+# **getLoggedInUserRatingForRecipeApiUsersSelfRatingsRecipeIdGet**
+> UserRatingSummary getLoggedInUserRatingForRecipeApiUsersSelfRatingsRecipeIdGet()
+
+
+### Example
+
+```typescript
+import {
+    UsersCRUDApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new UsersCRUDApi(configuration);
+
+let recipeId: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getLoggedInUserRatingForRecipeApiUsersSelfRatingsRecipeIdGet(
+    recipeId,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **recipeId** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserRatingSummary**
+
+### 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)
+
+# **getLoggedInUserRatingsApiUsersSelfRatingsGet**
+> UserRatingsUserRatingSummary getLoggedInUserRatingsApiUsersSelfRatingsGet()
+
+
+### Example
+
+```typescript
+import {
+    UsersCRUDApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new UsersCRUDApi(configuration);
+
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getLoggedInUserRatingsApiUsersSelfRatingsGet(
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**UserRatingsUserRatingSummary**
+
+### 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)
+
+# **updatePasswordApiUsersPasswordPut**
+> any updatePasswordApiUsersPasswordPut(changePassword)
+
+Resets the User Password
+
+### Example
+
+```typescript
+import {
+    UsersCRUDApi,
+    Configuration,
+    ChangePassword
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new UsersCRUDApi(configuration);
+
+let changePassword: ChangePassword; //
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.updatePasswordApiUsersPasswordPut(
+    changePassword,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **changePassword** | **ChangePassword**|  | |
+| **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)
+
+# **updateUserApiUsersItemIdPut**
+> any updateUserApiUsersItemIdPut(mealieSchemaUserUserUserBase)
+
+
+### Example
+
+```typescript
+import {
+    UsersCRUDApi,
+    Configuration,
+    MealieSchemaUserUserUserBase
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new UsersCRUDApi(configuration);
+
+let itemId: string; // (default to undefined)
+let mealieSchemaUserUserUserBase: MealieSchemaUserUserUserBase; //
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.updateUserApiUsersItemIdPut(
+    itemId,
+    mealieSchemaUserUserUserBase,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mealieSchemaUserUserUserBase** | **MealieSchemaUserUserUserBase**|  | |
+| **itemId** | [**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/UsersImagesApi.md

@@ -0,0 +1,66 @@
+# UsersImagesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**updateUserImageApiUsersIdImagePost**](#updateuserimageapiusersidimagepost) | **POST** /api/users/{id}/image | Update User Image|
+
+# **updateUserImageApiUsersIdImagePost**
+> any updateUserImageApiUsersIdImagePost()
+
+Updates a User Image
+
+### Example
+
+```typescript
+import {
+    UsersImagesApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new UsersImagesApi(configuration);
+
+let id: string; // (default to undefined)
+let profile: File; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.updateUserImageApiUsersIdImagePost(
+    id,
+    profile,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+| **profile** | [**File**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**any**
+
+### 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)
+

package/docs/UsersPasswordsApi.md

@@ -0,0 +1,118 @@
+# UsersPasswordsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**forgotPasswordApiUsersForgotPasswordPost**](#forgotpasswordapiusersforgotpasswordpost) | **POST** /api/users/forgot-password | Forgot Password|
+|[**resetPasswordApiUsersResetPasswordPost**](#resetpasswordapiusersresetpasswordpost) | **POST** /api/users/reset-password | Reset Password|
+
+# **forgotPasswordApiUsersForgotPasswordPost**
+> any forgotPasswordApiUsersForgotPasswordPost(forgotPassword)
+
+Sends an email with a reset link to the user
+
+### Example
+
+```typescript
+import {
+    UsersPasswordsApi,
+    Configuration,
+    ForgotPassword
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new UsersPasswordsApi(configuration);
+
+let forgotPassword: ForgotPassword; //
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.forgotPasswordApiUsersForgotPasswordPost(
+    forgotPassword,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **forgotPassword** | **ForgotPassword**|  | |
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+No authorization required
+
+### 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)
+
+# **resetPasswordApiUsersResetPasswordPost**
+> any resetPasswordApiUsersResetPasswordPost(resetPassword)
+
+Resets the user password
+
+### Example
+
+```typescript
+import {
+    UsersPasswordsApi,
+    Configuration,
+    ResetPassword
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new UsersPasswordsApi(configuration);
+
+let resetPassword: ResetPassword; //
+
+const { status, data } = await apiInstance.resetPasswordApiUsersResetPasswordPost(
+    resetPassword
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **resetPassword** | **ResetPassword**|  | |
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+No authorization required
+
+### 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)
+