mealie-typescript 1.0.6 → 1.0.8

package/docs/GroupsSeedersApi.md

@@ -1,175 +0,0 @@
-# GroupsSeedersApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**seedFoodsApiGroupsSeedersFoodsPost**](#seedfoodsapigroupsseedersfoodspost) | **POST** /api/groups/seeders/foods | Seed Foods|
-|[**seedLabelsApiGroupsSeedersLabelsPost**](#seedlabelsapigroupsseederslabelspost) | **POST** /api/groups/seeders/labels | Seed Labels|
-|[**seedUnitsApiGroupsSeedersUnitsPost**](#seedunitsapigroupsseedersunitspost) | **POST** /api/groups/seeders/units | Seed Units|
-
-# **seedFoodsApiGroupsSeedersFoodsPost**
-> SuccessResponse seedFoodsApiGroupsSeedersFoodsPost(seederConfig)
-
-
-### Example
-
-```typescript
-import {
-    GroupsSeedersApi,
-    Configuration,
-    SeederConfig
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new GroupsSeedersApi(configuration);
-
-let seederConfig: SeederConfig; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.seedFoodsApiGroupsSeedersFoodsPost(
-    seederConfig,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **seederConfig** | **SeederConfig**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**SuccessResponse**
-
-### 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)
-
-# **seedLabelsApiGroupsSeedersLabelsPost**
-> SuccessResponse seedLabelsApiGroupsSeedersLabelsPost(seederConfig)
-
-
-### Example
-
-```typescript
-import {
-    GroupsSeedersApi,
-    Configuration,
-    SeederConfig
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new GroupsSeedersApi(configuration);
-
-let seederConfig: SeederConfig; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.seedLabelsApiGroupsSeedersLabelsPost(
-    seederConfig,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **seederConfig** | **SeederConfig**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**SuccessResponse**
-
-### 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)
-
-# **seedUnitsApiGroupsSeedersUnitsPost**
-> SuccessResponse seedUnitsApiGroupsSeedersUnitsPost(seederConfig)
-
-
-### Example
-
-```typescript
-import {
-    GroupsSeedersApi,
-    Configuration,
-    SeederConfig
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new GroupsSeedersApi(configuration);
-
-let seederConfig: SeederConfig; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.seedUnitsApiGroupsSeedersUnitsPost(
-    seederConfig,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **seederConfig** | **SeederConfig**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**SuccessResponse**
-
-### 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/GroupsSelfServiceApi.md

@@ -1,351 +0,0 @@
-# GroupsSelfServiceApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getGroupMemberApiGroupsMembersUsernameOrIdGet**](#getgroupmemberapigroupsmembersusernameoridget) | **GET** /api/groups/members/{username_or_id} | Get Group Member|
-|[**getGroupMembersApiGroupsMembersGet**](#getgroupmembersapigroupsmembersget) | **GET** /api/groups/members | Get Group Members|
-|[**getGroupPreferencesApiGroupsPreferencesGet**](#getgrouppreferencesapigroupspreferencesget) | **GET** /api/groups/preferences | Get Group Preferences|
-|[**getLoggedInUserGroupApiGroupsSelfGet**](#getloggedinusergroupapigroupsselfget) | **GET** /api/groups/self | Get Logged In User Group|
-|[**getStorageApiGroupsStorageGet**](#getstorageapigroupsstorageget) | **GET** /api/groups/storage | Get Storage|
-|[**updateGroupPreferencesApiGroupsPreferencesPut**](#updategrouppreferencesapigroupspreferencesput) | **PUT** /api/groups/preferences | Update Group Preferences|
-
-# **getGroupMemberApiGroupsMembersUsernameOrIdGet**
-> UserSummary getGroupMemberApiGroupsMembersUsernameOrIdGet()
-
-Returns a single user belonging to the current group
-
-### Example
-
-```typescript
-import {
-    GroupsSelfServiceApi,
-    Configuration,
-    UsernameOrId
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new GroupsSelfServiceApi(configuration);
-
-let usernameOrId: UsernameOrId; // (default to undefined)
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getGroupMemberApiGroupsMembersUsernameOrIdGet(
-    usernameOrId,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **usernameOrId** | **UsernameOrId** |  | defaults to undefined|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**UserSummary**
-
-### 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)
-
-# **getGroupMembersApiGroupsMembersGet**
-> PaginationBaseUserSummary getGroupMembersApiGroupsMembersGet()
-
-Returns all users belonging to the current group
-
-### Example
-
-```typescript
-import {
-    GroupsSelfServiceApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new GroupsSelfServiceApi(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.getGroupMembersApiGroupsMembersGet(
-    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
-
-**PaginationBaseUserSummary**
-
-### 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)
-
-# **getGroupPreferencesApiGroupsPreferencesGet**
-> ReadGroupPreferences getGroupPreferencesApiGroupsPreferencesGet()
-
-
-### Example
-
-```typescript
-import {
-    GroupsSelfServiceApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new GroupsSelfServiceApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getGroupPreferencesApiGroupsPreferencesGet(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ReadGroupPreferences**
-
-### 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)
-
-# **getLoggedInUserGroupApiGroupsSelfGet**
-> GroupSummary getLoggedInUserGroupApiGroupsSelfGet()
-
-Returns the Group Data for the Current User
-
-### Example
-
-```typescript
-import {
-    GroupsSelfServiceApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new GroupsSelfServiceApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getLoggedInUserGroupApiGroupsSelfGet(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**GroupSummary**
-
-### 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)
-
-# **getStorageApiGroupsStorageGet**
-> GroupStorage getStorageApiGroupsStorageGet()
-
-
-### Example
-
-```typescript
-import {
-    GroupsSelfServiceApi,
-    Configuration
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new GroupsSelfServiceApi(configuration);
-
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getStorageApiGroupsStorageGet(
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**GroupStorage**
-
-### 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)
-
-# **updateGroupPreferencesApiGroupsPreferencesPut**
-> ReadGroupPreferences updateGroupPreferencesApiGroupsPreferencesPut(updateGroupPreferences)
-
-
-### Example
-
-```typescript
-import {
-    GroupsSelfServiceApi,
-    Configuration,
-    UpdateGroupPreferences
-} from 'mealie-typescript';
-
-const configuration = new Configuration();
-const apiInstance = new GroupsSelfServiceApi(configuration);
-
-let updateGroupPreferences: UpdateGroupPreferences; //
-let acceptLanguage: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.updateGroupPreferencesApiGroupsPreferencesPut(
-    updateGroupPreferences,
-    acceptLanguage
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **updateGroupPreferences** | **UpdateGroupPreferences**|  | |
-| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ReadGroupPreferences**
-
-### 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/HTTPValidationError.md

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

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

@@ -1,34 +0,0 @@
-# HouseholdInDB
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**groupId** | **string** |  | [default to undefined]
-**name** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**slug** | **string** |  | [default to undefined]
-**preferences** | [**ReadHouseholdPreferences**](ReadHouseholdPreferences.md) |  | [optional] [default to undefined]
-**group** | **string** |  | [default to undefined]
-**users** | [**Array<HouseholdUserSummary>**](HouseholdUserSummary.md) |  | [optional] [default to undefined]
-**webhooks** | [**Array<ReadWebhook>**](ReadWebhook.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { HouseholdInDB } from 'mealie-typescript';
-
-const instance: HouseholdInDB = {
-    groupId,
-    name,
-    id,
-    slug,
-    preferences,
-    group,
-    users,
-    webhooks,
-};
-```
-
-[[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/HouseholdPagination.md

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

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

@@ -1,28 +0,0 @@
-# HouseholdStatistics
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**totalRecipes** | **number** |  | [default to undefined]
-**totalUsers** | **number** |  | [default to undefined]
-**totalCategories** | **number** |  | [default to undefined]
-**totalTags** | **number** |  | [default to undefined]
-**totalTools** | **number** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { HouseholdStatistics } from 'mealie-typescript';
-
-const instance: HouseholdStatistics = {
-    totalRecipes,
-    totalUsers,
-    totalCategories,
-    totalTags,
-    totalTools,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)