mealie-typescript 1.0.5 → 1.0.7

package/docs/ForgotPassword.md

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

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

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

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

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

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

@@ -1,32 +0,0 @@
-# GroupDataExport
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**name** | **string** |  | [default to undefined]
-**filename** | **string** |  | [default to undefined]
-**path** | **string** |  | [default to undefined]
-**size** | **string** |  | [default to undefined]
-**expires** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { GroupDataExport } from 'mealie-typescript';
-
-const instance: GroupDataExport = {
-    id,
-    groupId,
-    name,
-    filename,
-    path,
-    size,
-    expires,
-};
-```
-
-[[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/GroupEventNotifierCreate.md

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

@@ -1,69 +0,0 @@
-# GroupEventNotifierOptions
-
-These events are in-sync with the EventTypes found in the EventBusService. If you modify this, make sure to update the EventBusService as well.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**testMessage** | **boolean** |  | [optional] [default to false]
-**webhookTask** | **boolean** |  | [optional] [default to false]
-**recipeCreated** | **boolean** |  | [optional] [default to false]
-**recipeUpdated** | **boolean** |  | [optional] [default to false]
-**recipeDeleted** | **boolean** |  | [optional] [default to false]
-**userSignup** | **boolean** |  | [optional] [default to false]
-**dataMigrations** | **boolean** |  | [optional] [default to false]
-**dataExport** | **boolean** |  | [optional] [default to false]
-**dataImport** | **boolean** |  | [optional] [default to false]
-**mealplanEntryCreated** | **boolean** |  | [optional] [default to false]
-**shoppingListCreated** | **boolean** |  | [optional] [default to false]
-**shoppingListUpdated** | **boolean** |  | [optional] [default to false]
-**shoppingListDeleted** | **boolean** |  | [optional] [default to false]
-**cookbookCreated** | **boolean** |  | [optional] [default to false]
-**cookbookUpdated** | **boolean** |  | [optional] [default to false]
-**cookbookDeleted** | **boolean** |  | [optional] [default to false]
-**tagCreated** | **boolean** |  | [optional] [default to false]
-**tagUpdated** | **boolean** |  | [optional] [default to false]
-**tagDeleted** | **boolean** |  | [optional] [default to false]
-**categoryCreated** | **boolean** |  | [optional] [default to false]
-**categoryUpdated** | **boolean** |  | [optional] [default to false]
-**categoryDeleted** | **boolean** |  | [optional] [default to false]
-**labelCreated** | **boolean** |  | [optional] [default to false]
-**labelUpdated** | **boolean** |  | [optional] [default to false]
-**labelDeleted** | **boolean** |  | [optional] [default to false]
-
-## Example
-
-```typescript
-import { GroupEventNotifierOptions } from 'mealie-typescript';
-
-const instance: GroupEventNotifierOptions = {
-    testMessage,
-    webhookTask,
-    recipeCreated,
-    recipeUpdated,
-    recipeDeleted,
-    userSignup,
-    dataMigrations,
-    dataExport,
-    dataImport,
-    mealplanEntryCreated,
-    shoppingListCreated,
-    shoppingListUpdated,
-    shoppingListDeleted,
-    cookbookCreated,
-    cookbookUpdated,
-    cookbookDeleted,
-    tagCreated,
-    tagUpdated,
-    tagDeleted,
-    categoryCreated,
-    categoryUpdated,
-    categoryDeleted,
-    labelCreated,
-    labelUpdated,
-    labelDeleted,
-};
-```
-
-[[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/GroupEventNotifierOptionsOut.md

@@ -1,70 +0,0 @@
-# GroupEventNotifierOptionsOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**testMessage** | **boolean** |  | [optional] [default to false]
-**webhookTask** | **boolean** |  | [optional] [default to false]
-**recipeCreated** | **boolean** |  | [optional] [default to false]
-**recipeUpdated** | **boolean** |  | [optional] [default to false]
-**recipeDeleted** | **boolean** |  | [optional] [default to false]
-**userSignup** | **boolean** |  | [optional] [default to false]
-**dataMigrations** | **boolean** |  | [optional] [default to false]
-**dataExport** | **boolean** |  | [optional] [default to false]
-**dataImport** | **boolean** |  | [optional] [default to false]
-**mealplanEntryCreated** | **boolean** |  | [optional] [default to false]
-**shoppingListCreated** | **boolean** |  | [optional] [default to false]
-**shoppingListUpdated** | **boolean** |  | [optional] [default to false]
-**shoppingListDeleted** | **boolean** |  | [optional] [default to false]
-**cookbookCreated** | **boolean** |  | [optional] [default to false]
-**cookbookUpdated** | **boolean** |  | [optional] [default to false]
-**cookbookDeleted** | **boolean** |  | [optional] [default to false]
-**tagCreated** | **boolean** |  | [optional] [default to false]
-**tagUpdated** | **boolean** |  | [optional] [default to false]
-**tagDeleted** | **boolean** |  | [optional] [default to false]
-**categoryCreated** | **boolean** |  | [optional] [default to false]
-**categoryUpdated** | **boolean** |  | [optional] [default to false]
-**categoryDeleted** | **boolean** |  | [optional] [default to false]
-**labelCreated** | **boolean** |  | [optional] [default to false]
-**labelUpdated** | **boolean** |  | [optional] [default to false]
-**labelDeleted** | **boolean** |  | [optional] [default to false]
-**id** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { GroupEventNotifierOptionsOut } from 'mealie-typescript';
-
-const instance: GroupEventNotifierOptionsOut = {
-    testMessage,
-    webhookTask,
-    recipeCreated,
-    recipeUpdated,
-    recipeDeleted,
-    userSignup,
-    dataMigrations,
-    dataExport,
-    dataImport,
-    mealplanEntryCreated,
-    shoppingListCreated,
-    shoppingListUpdated,
-    shoppingListDeleted,
-    cookbookCreated,
-    cookbookUpdated,
-    cookbookDeleted,
-    tagCreated,
-    tagUpdated,
-    tagDeleted,
-    categoryCreated,
-    categoryUpdated,
-    categoryDeleted,
-    labelCreated,
-    labelUpdated,
-    labelDeleted,
-    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/GroupEventNotifierOut.md

@@ -1,30 +0,0 @@
-# GroupEventNotifierOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**name** | **string** |  | [default to undefined]
-**enabled** | **boolean** |  | [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**_options** | [**GroupEventNotifierOptionsOut**](GroupEventNotifierOptionsOut.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { GroupEventNotifierOut } from 'mealie-typescript';
-
-const instance: GroupEventNotifierOut = {
-    id,
-    name,
-    enabled,
-    groupId,
-    householdId,
-    _options,
-};
-```
-
-[[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/GroupEventNotifierUpdate.md

@@ -1,32 +0,0 @@
-# GroupEventNotifierUpdate
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [default to undefined]
-**appriseUrl** | **string** |  | [optional] [default to undefined]
-**enabled** | **boolean** |  | [optional] [default to true]
-**groupId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**_options** | [**GroupEventNotifierOptions**](GroupEventNotifierOptions.md) |  | [optional] [default to undefined]
-**id** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { GroupEventNotifierUpdate } from 'mealie-typescript';
-
-const instance: GroupEventNotifierUpdate = {
-    name,
-    appriseUrl,
-    enabled,
-    groupId,
-    householdId,
-    _options,
-    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/GroupEventPagination.md

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

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

@@ -1,34 +0,0 @@
-# GroupInDB
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**slug** | **string** |  | [default to undefined]
-**categories** | [**Array<CategoryBase>**](CategoryBase.md) |  | [optional] [default to undefined]
-**webhooks** | [**Array<ReadWebhook>**](ReadWebhook.md) |  | [optional] [default to undefined]
-**households** | [**Array<GroupHouseholdSummary>**](GroupHouseholdSummary.md) |  | [optional] [default to undefined]
-**users** | [**Array<UserSummary>**](UserSummary.md) |  | [optional] [default to undefined]
-**preferences** | [**ReadGroupPreferences**](ReadGroupPreferences.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GroupInDB } from 'mealie-typescript';
-
-const instance: GroupInDB = {
-    name,
-    id,
-    slug,
-    categories,
-    webhooks,
-    households,
-    users,
-    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/GroupPagination.md

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

@@ -1,30 +0,0 @@
-# GroupRecipeActionOut
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**actionType** | [**GroupRecipeActionType**](GroupRecipeActionType.md) |  | [default to undefined]
-**title** | **string** |  | [default to undefined]
-**url** | **string** |  | [default to undefined]
-**groupId** | **string** |  | [default to undefined]
-**householdId** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { GroupRecipeActionOut } from 'mealie-typescript';
-
-const instance: GroupRecipeActionOut = {
-    actionType,
-    title,
-    url,
-    groupId,
-    householdId,
-    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/GroupRecipeActionPagination.md

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

@@ -1,10 +0,0 @@
-# GroupRecipeActionType
-
-
-## Enum
-
-* `Link` (value: `'link'`)
-
-* `Post` (value: `'post'`)
-
-[[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/GroupStorage.md

@@ -1,26 +0,0 @@
-# GroupStorage
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**usedStorageBytes** | **number** |  | [default to undefined]
-**usedStorageStr** | **string** |  | [default to undefined]
-**totalStorageBytes** | **number** |  | [default to undefined]
-**totalStorageStr** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { GroupStorage } from 'mealie-typescript';
-
-const instance: GroupStorage = {
-    usedStorageBytes,
-    usedStorageStr,
-    totalStorageBytes,
-    totalStorageStr,
-};
-```
-
-[[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/GroupSummary.md

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