mealie-typescript 1.0.5 → 1.0.7

package/docs/UpdateHouseholdAdmin.md

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

@@ -1,34 +0,0 @@
-# UpdateHouseholdPreferences
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**privateHousehold** | **boolean** |  | [optional] [default to true]
-**lockRecipeEditsFromOtherHouseholds** | **boolean** |  | [optional] [default to true]
-**firstDayOfWeek** | **number** |  | [optional] [default to 0]
-**recipePublic** | **boolean** |  | [optional] [default to true]
-**recipeShowNutrition** | **boolean** |  | [optional] [default to false]
-**recipeShowAssets** | **boolean** |  | [optional] [default to false]
-**recipeLandscapeView** | **boolean** |  | [optional] [default to false]
-**recipeDisableComments** | **boolean** |  | [optional] [default to false]
-
-## Example
-
-```typescript
-import { UpdateHouseholdPreferences } from 'mealie-typescript';
-
-const instance: UpdateHouseholdPreferences = {
-    privateHousehold,
-    lockRecipeEditsFromOtherHouseholds,
-    firstDayOfWeek,
-    recipePublic,
-    recipeShowNutrition,
-    recipeShowAssets,
-    recipeLandscapeView,
-    recipeDisableComments,
-};
-```
-
-[[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/UpdateImageResponse.md

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

@@ -1,34 +0,0 @@
-# UpdatePlanEntry
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**date** | **string** |  | [default to undefined]
-**entryType** | [**PlanEntryType**](PlanEntryType.md) |  | [optional] [default to undefined]
-**title** | **string** |  | [optional] [default to '']
-**text** | **string** |  | [optional] [default to '']
-**recipeId** | **string** |  | [optional] [default to undefined]
-**id** | **number** |  | [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**userId** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { UpdatePlanEntry } from 'mealie-typescript';
-
-const instance: UpdatePlanEntry = {
-    date,
-    entryType,
-    title,
-    text,
-    recipeId,
-    id,
-    groupId,
-    userId,
-};
-```
-
-[[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/UserIn.md

@@ -1,46 +0,0 @@
-# UserIn
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**username** | **string** |  | [default to undefined]
-**fullName** | **string** |  | [default to undefined]
-**email** | **string** |  | [default to undefined]
-**authMethod** | [**AuthMethod**](AuthMethod.md) |  | [optional] [default to undefined]
-**admin** | **boolean** |  | [optional] [default to false]
-**group** | **string** |  | [optional] [default to undefined]
-**household** | **string** |  | [optional] [default to undefined]
-**advanced** | **boolean** |  | [optional] [default to false]
-**canInvite** | **boolean** |  | [optional] [default to false]
-**canManage** | **boolean** |  | [optional] [default to false]
-**canManageHousehold** | **boolean** |  | [optional] [default to false]
-**canOrganize** | **boolean** |  | [optional] [default to false]
-**password** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { UserIn } from 'mealie-typescript';
-
-const instance: UserIn = {
-    id,
-    username,
-    fullName,
-    email,
-    authMethod,
-    admin,
-    group,
-    household,
-    advanced,
-    canInvite,
-    canManage,
-    canManageHousehold,
-    canOrganize,
-    password,
-};
-```
-
-[[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/UserOut.md

@@ -1,56 +0,0 @@
-# UserOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**username** | **string** |  | [optional] [default to undefined]
-**fullName** | **string** |  | [optional] [default to undefined]
-**email** | **string** |  | [default to undefined]
-**authMethod** | [**AuthMethod**](AuthMethod.md) |  | [optional] [default to undefined]
-**admin** | **boolean** |  | [optional] [default to false]
-**group** | **string** |  | [default to undefined]
-**household** | **string** |  | [default to undefined]
-**advanced** | **boolean** |  | [optional] [default to false]
-**canInvite** | **boolean** |  | [optional] [default to false]
-**canManage** | **boolean** |  | [optional] [default to false]
-**canManageHousehold** | **boolean** |  | [optional] [default to false]
-**canOrganize** | **boolean** |  | [optional] [default to false]
-**groupId** | **string** |  | [default to undefined]
-**groupSlug** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**householdSlug** | **string** |  | [default to undefined]
-**tokens** | [**Array<LongLiveTokenOut>**](LongLiveTokenOut.md) |  | [optional] [default to undefined]
-**cacheKey** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { UserOut } from 'mealie-typescript';
-
-const instance: UserOut = {
-    id,
-    username,
-    fullName,
-    email,
-    authMethod,
-    admin,
-    group,
-    household,
-    advanced,
-    canInvite,
-    canManage,
-    canManageHousehold,
-    canOrganize,
-    groupId,
-    groupSlug,
-    householdId,
-    householdSlug,
-    tokens,
-    cacheKey,
-};
-```
-
-[[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/UserPagination.md

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

@@ -1,28 +0,0 @@
-# UserRatingOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipeId** | **string** |  | [default to undefined]
-**rating** | **number** |  | [optional] [default to undefined]
-**isFavorite** | **boolean** |  | [optional] [default to false]
-**userId** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { UserRatingOut } from 'mealie-typescript';
-
-const instance: UserRatingOut = {
-    recipeId,
-    rating,
-    isFavorite,
-    userId,
-    id,
-};
-```
-
-[[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/UserRatingSummary.md

@@ -1,24 +0,0 @@
-# UserRatingSummary
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**recipeId** | **string** |  | [default to undefined]
-**rating** | **number** |  | [optional] [default to undefined]
-**isFavorite** | **boolean** |  | [optional] [default to false]
-
-## Example
-
-```typescript
-import { UserRatingSummary } from 'mealie-typescript';
-
-const instance: UserRatingSummary = {
-    recipeId,
-    rating,
-    isFavorite,
-};
-```
-
-[[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/UserRatingUpdate.md

@@ -1,22 +0,0 @@
-# UserRatingUpdate
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rating** | **number** |  | [optional] [default to undefined]
-**isFavorite** | **boolean** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { UserRatingUpdate } from 'mealie-typescript';
-
-const instance: UserRatingUpdate = {
-    rating,
-    isFavorite,
-};
-```
-
-[[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/UserRatingsUserRatingOut.md

@@ -1,20 +0,0 @@
-# UserRatingsUserRatingOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ratings** | [**Array<UserRatingOut>**](UserRatingOut.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { UserRatingsUserRatingOut } from 'mealie-typescript';
-
-const instance: UserRatingsUserRatingOut = {
-    ratings,
-};
-```
-
-[[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/UserRatingsUserRatingSummary.md

@@ -1,20 +0,0 @@
-# UserRatingsUserRatingSummary
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ratings** | [**Array<UserRatingSummary>**](UserRatingSummary.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { UserRatingsUserRatingSummary } from 'mealie-typescript';
-
-const instance: UserRatingsUserRatingSummary = {
-    ratings,
-};
-```
-
-[[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/UserSummary.md

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

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

@@ -1,250 +0,0 @@
-# UsersAuthenticationApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getTokenApiAuthTokenPost**](#gettokenapiauthtokenpost) | **POST** /api/auth/token | Get Token|
-|[**logoutApiAuthLogoutPost**](#logoutapiauthlogoutpost) | **POST** /api/auth/logout | Logout|
-|[**oauthCallbackApiAuthOauthCallbackGet**](#oauthcallbackapiauthoauthcallbackget) | **GET** /api/auth/oauth/callback | Oauth Callback|
-|[**oauthLoginApiAuthOauthGet**](#oauthloginapiauthoauthget) | **GET** /api/auth/oauth | Oauth Login|
-|[**refreshTokenApiAuthRefreshGet**](#refreshtokenapiauthrefreshget) | **GET** /api/auth/refresh | Refresh Token|
-
-# **getTokenApiAuthTokenPost**
-> any getTokenApiAuthTokenPost()
-
-
-### Example
-
-```typescript
-import {
-    UsersAuthenticationApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersAuthenticationApi(configuration);
-
-let username: string; // (optional) (default to '')
-let password: string; // (optional) (default to '')
-let rememberMe: boolean; // (optional) (default to false)
-
-const { status, data } = await apiInstance.getTokenApiAuthTokenPost(
-    username,
-    password,
-    rememberMe
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **username** | [**string**] |  | (optional) defaults to ''|
-| **password** | [**string**] |  | (optional) defaults to ''|
-| **rememberMe** | [**boolean**] |  | (optional) defaults to false|
-
-
-### Return type
-
-**any**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/x-www-form-urlencoded
- - **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)
-
-# **logoutApiAuthLogoutPost**
-> any logoutApiAuthLogoutPost()
-
-
-### Example
-
-```typescript
-import {
-    UsersAuthenticationApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersAuthenticationApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.logoutApiAuthLogoutPost(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **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)
-
-# **oauthCallbackApiAuthOauthCallbackGet**
-> any oauthCallbackApiAuthOauthCallbackGet()
-
-
-### Example
-
-```typescript
-import {
-    UsersAuthenticationApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersAuthenticationApi(configuration);
-
-const { status, data } = await apiInstance.oauthCallbackApiAuthOauthCallbackGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### 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 |  -  |
-
-[[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)
-
-# **oauthLoginApiAuthOauthGet**
-> any oauthLoginApiAuthOauthGet()
-
-
-### Example
-
-```typescript
-import {
-    UsersAuthenticationApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersAuthenticationApi(configuration);
-
-const { status, data } = await apiInstance.oauthLoginApiAuthOauthGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### 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 |  -  |
-
-[[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)
-
-# **refreshTokenApiAuthRefreshGet**
-> any refreshTokenApiAuthRefreshGet()
-
-Use a valid token to get another token
-
-### Example
-
-```typescript
-import {
-    UsersAuthenticationApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new UsersAuthenticationApi(configuration);
-
-const { status, data } = await apiInstance.refreshTokenApiAuthRefreshGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### 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 |  -  |
-
-[[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)
-