mealie-typescript 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/package.json +25 -11
- package/.openapi-generator/FILES +0 -303
- package/.openapi-generator/VERSION +0 -1
- package/.openapi-generator-ignore +0 -26
- package/api.ts +0 -28987
- package/base.ts +0 -62
- package/common.ts +0 -113
- package/configuration.ts +0 -121
- package/docs/AdminAboutApi.md +0 -164
- package/docs/AdminAboutInfo.md +0 -62
- package/docs/AdminBackupsApi.md +0 -333
- package/docs/AdminDebugApi.md +0 -62
- package/docs/AdminEmailApi.md +0 -116
- package/docs/AdminMaintenanceApi.md +0 -270
- package/docs/AdminManageGroupsApi.md +0 -305
- package/docs/AdminManageHouseholdsApi.md +0 -305
- package/docs/AdminManageUsersApi.md +0 -417
- package/docs/AllBackups.md +0 -22
- package/docs/AppAboutApi.md +0 -142
- package/docs/AppInfo.md +0 -44
- package/docs/AppStartupInfo.md +0 -22
- package/docs/AppStatistics.md +0 -30
- package/docs/AppTheme.md +0 -46
- package/docs/AssignCategories.md +0 -22
- package/docs/AssignSettings.md +0 -22
- package/docs/AssignTags.md +0 -22
- package/docs/AuthMethod.md +0 -12
- package/docs/BackupFile.md +0 -24
- package/docs/BodyTriggerActionApiHouseholdsRecipeActionsItemIdTriggerRecipeSlugPost.md +0 -20
- package/docs/CategoryBase.md +0 -26
- package/docs/CategoryIn.md +0 -20
- package/docs/CategoryOut.md +0 -26
- package/docs/CategorySummary.md +0 -24
- package/docs/ChangePassword.md +0 -22
- package/docs/CheckAppConfig.md +0 -30
- package/docs/CookBookPagination.md +0 -32
- package/docs/Cookbook.md +0 -18
- package/docs/Cookbook1.md +0 -18
- package/docs/CookbookHousehold.md +0 -22
- package/docs/CreateCookBook.md +0 -30
- package/docs/CreateGroupRecipeAction.md +0 -24
- package/docs/CreateIngredientFood.md +0 -34
- package/docs/CreateIngredientFoodAlias.md +0 -20
- package/docs/CreateIngredientUnit.md +0 -38
- package/docs/CreateIngredientUnitAlias.md +0 -20
- package/docs/CreateInviteToken.md +0 -24
- package/docs/CreatePlanEntry.md +0 -28
- package/docs/CreateRandomEntry.md +0 -22
- package/docs/CreateRecipe.md +0 -20
- package/docs/CreateRecipeBulk.md +0 -24
- package/docs/CreateRecipeByUrlBulk.md +0 -20
- package/docs/CreateUserRegistration.md +0 -42
- package/docs/CreateWebhook.md +0 -28
- package/docs/DebugResponse.md +0 -22
- package/docs/DeleteRecipes.md +0 -20
- package/docs/DeleteTokenResponse.md +0 -20
- package/docs/EmailInitationResponse.md +0 -22
- package/docs/EmailInvitation.md +0 -22
- package/docs/EmailReady.md +0 -20
- package/docs/EmailSuccess.md +0 -22
- package/docs/EmailTest.md +0 -20
- package/docs/ExploreCategoriesApi.md +0 -144
- package/docs/ExploreCookbooksApi.md +0 -145
- package/docs/ExploreFoodsApi.md +0 -144
- package/docs/ExploreHouseholdsApi.md +0 -141
- package/docs/ExploreRecipesApi.md +0 -266
- package/docs/ExploreTagsApi.md +0 -144
- package/docs/ExploreToolsApi.md +0 -144
- package/docs/ExportRecipes.md +0 -22
- package/docs/ExportTypes.md +0 -8
- package/docs/FileTokenResponse.md +0 -20
- package/docs/Food.md +0 -40
- package/docs/Food1.md +0 -40
- package/docs/ForgotPassword.md +0 -20
- package/docs/FormatResponse.md +0 -22
- package/docs/GetAllApiRecipesGetCategoriesParameterInner.md +0 -18
- package/docs/GetAllApiRecipesGetTagsParameterInner.md +0 -18
- package/docs/GroupAdminUpdate.md +0 -24
- package/docs/GroupBase.md +0 -20
- package/docs/GroupDataExport.md +0 -32
- package/docs/GroupEventNotifierCreate.md +0 -22
- package/docs/GroupEventNotifierOptions.md +0 -69
- package/docs/GroupEventNotifierOptionsOut.md +0 -70
- package/docs/GroupEventNotifierOut.md +0 -30
- package/docs/GroupEventNotifierUpdate.md +0 -32
- package/docs/GroupEventPagination.md +0 -32
- package/docs/GroupHouseholdSummary.md +0 -22
- package/docs/GroupInDB.md +0 -34
- package/docs/GroupPagination.md +0 -32
- package/docs/GroupRecipeActionOut.md +0 -30
- package/docs/GroupRecipeActionPagination.md +0 -32
- package/docs/GroupRecipeActionType.md +0 -10
- package/docs/GroupStorage.md +0 -26
- package/docs/GroupSummary.md +0 -26
- package/docs/GroupsHouseholdsApi.md +0 -135
- package/docs/GroupsMigrationsApi.md +0 -68
- package/docs/GroupsMultiPurposeLabelsApi.md +0 -308
- package/docs/GroupsReportsApi.md +0 -172
- package/docs/GroupsSeedersApi.md +0 -175
- package/docs/GroupsSelfServiceApi.md +0 -351
- package/docs/HTTPValidationError.md +0 -20
- package/docs/HouseholdCreate.md +0 -22
- package/docs/HouseholdInDB.md +0 -34
- package/docs/HouseholdPagination.md +0 -32
- package/docs/HouseholdRecipeSummary.md +0 -22
- package/docs/HouseholdStatistics.md +0 -28
- package/docs/HouseholdSummary.md +0 -28
- package/docs/HouseholdUserSummary.md +0 -22
- package/docs/HouseholdsCookbooksApi.md +0 -361
- package/docs/HouseholdsEventNotificationsApi.md +0 -360
- package/docs/HouseholdsInvitationsApi.md +0 -171
- package/docs/HouseholdsMealplanRulesApi.md +0 -305
- package/docs/HouseholdsMealplansApi.md +0 -420
- package/docs/HouseholdsRecipeActionsApi.md +0 -367
- package/docs/HouseholdsSelfServiceApi.md +0 -406
- package/docs/HouseholdsShoppingListItemsApi.md +0 -470
- package/docs/HouseholdsShoppingListsApi.md +0 -545
- package/docs/HouseholdsWebhooksApi.md +0 -413
- package/docs/ImageType.md +0 -12
- package/docs/IngredientConfidence.md +0 -30
- package/docs/IngredientFoodAlias.md +0 -20
- package/docs/IngredientFoodInput.md +0 -40
- package/docs/IngredientFoodOutput.md +0 -40
- package/docs/IngredientFoodPagination.md +0 -32
- package/docs/IngredientReferences.md +0 -21
- package/docs/IngredientRequest.md +0 -22
- package/docs/IngredientUnitAlias.md +0 -20
- package/docs/IngredientUnitInput.md +0 -42
- package/docs/IngredientUnitOutput.md +0 -42
- package/docs/IngredientUnitPagination.md +0 -32
- package/docs/IngredientsRequest.md +0 -22
- package/docs/ItemId.md +0 -18
- package/docs/ItemId1.md +0 -18
- package/docs/LogicalOperator.md +0 -10
- package/docs/LongLiveTokenCreateResponse.md +0 -27
- package/docs/LongLiveTokenIn.md +0 -22
- package/docs/LongLiveTokenOut.md +0 -24
- package/docs/MaintenanceStorageDetails.md +0 -28
- package/docs/MaintenanceSummary.md +0 -24
- package/docs/MealieSchemaRecipeRecipeCommentsUserBase.md +0 -26
- package/docs/MealieSchemaUserUserUserBase.md +0 -44
- package/docs/MergeFood.md +0 -22
- package/docs/MergeUnit.md +0 -22
- package/docs/MultiPurposeLabelCreate.md +0 -22
- package/docs/MultiPurposeLabelOut.md +0 -26
- package/docs/MultiPurposeLabelPagination.md +0 -32
- package/docs/MultiPurposeLabelSummary.md +0 -26
- package/docs/MultiPurposeLabelUpdate.md +0 -26
- package/docs/Nutrition.md +0 -40
- package/docs/OrderByNullPosition.md +0 -10
- package/docs/OrderDirection.md +0 -10
- package/docs/OrganizerCategoriesApi.md +0 -422
- package/docs/OrganizerTagsApi.md +0 -421
- package/docs/OrganizerToolsApi.md +0 -363
- package/docs/PaginationBaseHouseholdSummary.md +0 -32
- package/docs/PaginationBaseIngredientFood.md +0 -32
- package/docs/PaginationBaseReadCookBook.md +0 -32
- package/docs/PaginationBaseRecipeCategory.md +0 -32
- package/docs/PaginationBaseRecipeSummary.md +0 -32
- package/docs/PaginationBaseRecipeTag.md +0 -32
- package/docs/PaginationBaseRecipeTool.md +0 -32
- package/docs/PaginationBaseUserOut.md +0 -32
- package/docs/PaginationBaseUserSummary.md +0 -32
- package/docs/ParsedIngredient.md +0 -24
- package/docs/PasswordResetToken.md +0 -20
- package/docs/PlanEntryPagination.md +0 -32
- package/docs/PlanEntryType.md +0 -20
- package/docs/PlanRulesCreate.md +0 -24
- package/docs/PlanRulesDay.md +0 -22
- package/docs/PlanRulesOut.md +0 -32
- package/docs/PlanRulesPagination.md +0 -32
- package/docs/PlanRulesType.md +0 -22
- package/docs/QueryFilterJSON.md +0 -20
- package/docs/QueryFilterJSONPart.md +0 -30
- package/docs/ReadCookBook.md +0 -40
- package/docs/ReadGroupPreferences.md +0 -24
- package/docs/ReadHouseholdPreferences.md +0 -36
- package/docs/ReadInviteToken.md +0 -26
- package/docs/ReadPlanEntry.md +0 -38
- package/docs/ReadWebhook.md +0 -34
- package/docs/RecipeAsset.md +0 -24
- package/docs/RecipeBulkActionsApi.md +0 -448
- package/docs/RecipeCRUDApi.md +0 -1306
- package/docs/RecipeCategory.md +0 -26
- package/docs/RecipeCategoryPagination.md +0 -32
- package/docs/RecipeCommentCreate.md +0 -22
- package/docs/RecipeCommentOutInput.md +0 -32
- package/docs/RecipeCommentOutOutput.md +0 -32
- package/docs/RecipeCommentPagination.md +0 -32
- package/docs/RecipeCommentUpdate.md +0 -22
- package/docs/RecipeCommentsApi.md +0 -361
- package/docs/RecipeDuplicate.md +0 -20
- package/docs/RecipeExportsApi.md +0 -118
- package/docs/RecipeImagesAndAssetsApi.md +0 -521
- package/docs/RecipeIngredientInput.md +0 -36
- package/docs/RecipeIngredientOutput.md +0 -36
- package/docs/RecipeIngredientParserApi.md +0 -119
- package/docs/RecipeInput.md +0 -84
- package/docs/RecipeLastMade.md +0 -20
- package/docs/RecipeNote.md +0 -22
- package/docs/RecipeOutput.md +0 -84
- package/docs/RecipeSettings.md +0 -30
- package/docs/RecipeShareToken.md +0 -30
- package/docs/RecipeShareTokenCreate.md +0 -22
- package/docs/RecipeShareTokenSummary.md +0 -28
- package/docs/RecipeSharedApi.md +0 -112
- package/docs/RecipeStep.md +0 -28
- package/docs/RecipeSuggestionResponse.md +0 -20
- package/docs/RecipeSuggestionResponseItem.md +0 -24
- package/docs/RecipeSummary.md +0 -68
- package/docs/RecipeTag.md +0 -26
- package/docs/RecipeTagPagination.md +0 -32
- package/docs/RecipeTagResponse.md +0 -28
- package/docs/RecipeTimelineApi.md +0 -366
- package/docs/RecipeTimelineEventIn.md +0 -32
- package/docs/RecipeTimelineEventOut.md +0 -42
- package/docs/RecipeTimelineEventPagination.md +0 -32
- package/docs/RecipeTimelineEventUpdate.md +0 -24
- package/docs/RecipeTool.md +0 -28
- package/docs/RecipeToolCreate.md +0 -22
- package/docs/RecipeToolOut.md +0 -28
- package/docs/RecipeToolPagination.md +0 -32
- package/docs/RecipeToolResponse.md +0 -30
- package/docs/RecipesFoodsApi.md +0 -364
- package/docs/RecipesUnitsApi.md +0 -364
- package/docs/RegisteredParser.md +0 -12
- package/docs/RelationalKeyword.md +0 -20
- package/docs/RelationalOperator.md +0 -18
- package/docs/Relationaloperator.md +0 -18
- package/docs/ReportCategory.md +0 -14
- package/docs/ReportEntryOut.md +0 -30
- package/docs/ReportOut.md +0 -32
- package/docs/ReportSummary.md +0 -30
- package/docs/ReportSummaryStatus.md +0 -14
- package/docs/ResetPassword.md +0 -26
- package/docs/SaveGroupRecipeAction.md +0 -28
- package/docs/ScrapeRecipe.md +0 -22
- package/docs/ScrapeRecipeData.md +0 -22
- package/docs/ScrapeRecipeTest.md +0 -22
- package/docs/SeederConfig.md +0 -20
- package/docs/SetPermissions.md +0 -28
- package/docs/SharedRecipesApi.md +0 -228
- package/docs/ShoppingListAddRecipeParams.md +0 -22
- package/docs/ShoppingListAddRecipeParamsBulk.md +0 -24
- package/docs/ShoppingListCreate.md +0 -26
- package/docs/ShoppingListItemCreate.md +0 -48
- package/docs/ShoppingListItemOutInput.md +0 -58
- package/docs/ShoppingListItemOutOutput.md +0 -58
- package/docs/ShoppingListItemPagination.md +0 -32
- package/docs/ShoppingListItemRecipeRefCreate.md +0 -26
- package/docs/ShoppingListItemRecipeRefOut.md +0 -30
- package/docs/ShoppingListItemRecipeRefUpdate.md +0 -30
- package/docs/ShoppingListItemUpdate.md +0 -46
- package/docs/ShoppingListItemUpdateBulk.md +0 -49
- package/docs/ShoppingListItemUpdateRecipeReferencesInner.md +0 -30
- package/docs/ShoppingListItemsCollectionOut.md +0 -25
- package/docs/ShoppingListMultiPurposeLabelOut.md +0 -28
- package/docs/ShoppingListMultiPurposeLabelUpdate.md +0 -26
- package/docs/ShoppingListOut.md +0 -40
- package/docs/ShoppingListPagination.md +0 -32
- package/docs/ShoppingListRecipeRefOut.md +0 -28
- package/docs/ShoppingListRemoveRecipeParams.md +0 -20
- package/docs/ShoppingListSummary.md +0 -38
- package/docs/ShoppingListUpdate.md +0 -34
- package/docs/SuccessResponse.md +0 -22
- package/docs/SupportedMigrations.md +0 -26
- package/docs/TagBase.md +0 -26
- package/docs/TagIn.md +0 -20
- package/docs/TagOut.md +0 -26
- package/docs/TimelineEventImage.md +0 -10
- package/docs/TimelineEventType.md +0 -12
- package/docs/Unit.md +0 -42
- package/docs/Unit1.md +0 -42
- package/docs/UnlockResults.md +0 -20
- package/docs/UpdateCookBook.md +0 -36
- package/docs/UpdateGroupPreferences.md +0 -20
- package/docs/UpdateHouseholdAdmin.md +0 -26
- package/docs/UpdateHouseholdPreferences.md +0 -34
- package/docs/UpdateImageResponse.md +0 -20
- package/docs/UpdatePlanEntry.md +0 -34
- package/docs/UserIn.md +0 -46
- package/docs/UserOut.md +0 -56
- package/docs/UserPagination.md +0 -32
- package/docs/UserRatingOut.md +0 -28
- package/docs/UserRatingSummary.md +0 -24
- package/docs/UserRatingUpdate.md +0 -22
- package/docs/UserRatingsUserRatingOut.md +0 -20
- package/docs/UserRatingsUserRatingSummary.md +0 -20
- package/docs/UserSummary.md +0 -28
- package/docs/UsernameOrId.md +0 -18
- package/docs/UsersAuthenticationApi.md +0 -250
- package/docs/UsersCRUDApi.md +0 -334
- package/docs/UsersImagesApi.md +0 -66
- package/docs/UsersPasswordsApi.md +0 -118
- package/docs/UsersRatingsApi.md +0 -300
- package/docs/UsersRegistrationApi.md +0 -63
- package/docs/UsersTokensApi.md +0 -120
- package/docs/UtilsApi.md +0 -60
- package/docs/ValidationError.md +0 -24
- package/docs/ValidationErrorLocInner.md +0 -18
- package/docs/Value.md +0 -18
- package/docs/WebhookPagination.md +0 -32
- package/docs/WebhookType.md +0 -8
- package/index.ts +0 -18
- package/tsconfig.json +0 -21
|
@@ -1,266 +0,0 @@
|
|
|
1
|
-
# ExploreRecipesApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
|Method | HTTP request | Description|
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getAllApiExploreGroupsGroupSlugRecipesGet**](#getallapiexploregroupsgroupslugrecipesget) | **GET** /api/explore/groups/{group_slug}/recipes | Get All|
|
|
8
|
-
|[**getRecipeApiExploreGroupsGroupSlugRecipesRecipeSlugGet**](#getrecipeapiexploregroupsgroupslugrecipesrecipeslugget) | **GET** /api/explore/groups/{group_slug}/recipes/{recipe_slug} | Get Recipe|
|
|
9
|
-
|[**suggestRecipesApiExploreGroupsGroupSlugRecipesSuggestionsGet**](#suggestrecipesapiexploregroupsgroupslugrecipessuggestionsget) | **GET** /api/explore/groups/{group_slug}/recipes/suggestions | Suggest Recipes|
|
|
10
|
-
|
|
11
|
-
# **getAllApiExploreGroupsGroupSlugRecipesGet**
|
|
12
|
-
> PaginationBaseRecipeSummary getAllApiExploreGroupsGroupSlugRecipesGet()
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
### Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import {
|
|
19
|
-
ExploreRecipesApi,
|
|
20
|
-
Configuration,
|
|
21
|
-
Cookbook1
|
|
22
|
-
} from 'mealie-typescript';
|
|
23
|
-
|
|
24
|
-
const configuration = new Configuration();
|
|
25
|
-
const apiInstance = new ExploreRecipesApi(configuration);
|
|
26
|
-
|
|
27
|
-
let groupSlug: string; // (default to undefined)
|
|
28
|
-
let categories: Array<GetAllApiRecipesGetTagsParameterInner>; // (optional) (default to undefined)
|
|
29
|
-
let tags: Array<GetAllApiRecipesGetTagsParameterInner>; // (optional) (default to undefined)
|
|
30
|
-
let tools: Array<GetAllApiRecipesGetTagsParameterInner>; // (optional) (default to undefined)
|
|
31
|
-
let foods: Array<GetAllApiRecipesGetTagsParameterInner>; // (optional) (default to undefined)
|
|
32
|
-
let households: Array<GetAllApiRecipesGetTagsParameterInner>; // (optional) (default to undefined)
|
|
33
|
-
let orderBy: string; // (optional) (default to undefined)
|
|
34
|
-
let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
|
|
35
|
-
let orderDirection: OrderDirection; // (optional) (default to undefined)
|
|
36
|
-
let queryFilter: string; // (optional) (default to undefined)
|
|
37
|
-
let paginationSeed: string; // (optional) (default to undefined)
|
|
38
|
-
let page: number; // (optional) (default to 1)
|
|
39
|
-
let perPage: number; // (optional) (default to 50)
|
|
40
|
-
let cookbook: Cookbook1; // (optional) (default to undefined)
|
|
41
|
-
let requireAllCategories: boolean; // (optional) (default to false)
|
|
42
|
-
let requireAllTags: boolean; // (optional) (default to false)
|
|
43
|
-
let requireAllTools: boolean; // (optional) (default to false)
|
|
44
|
-
let requireAllFoods: boolean; // (optional) (default to false)
|
|
45
|
-
let search: string; // (optional) (default to undefined)
|
|
46
|
-
let acceptLanguage: string; // (optional) (default to undefined)
|
|
47
|
-
|
|
48
|
-
const { status, data } = await apiInstance.getAllApiExploreGroupsGroupSlugRecipesGet(
|
|
49
|
-
groupSlug,
|
|
50
|
-
categories,
|
|
51
|
-
tags,
|
|
52
|
-
tools,
|
|
53
|
-
foods,
|
|
54
|
-
households,
|
|
55
|
-
orderBy,
|
|
56
|
-
orderByNullPosition,
|
|
57
|
-
orderDirection,
|
|
58
|
-
queryFilter,
|
|
59
|
-
paginationSeed,
|
|
60
|
-
page,
|
|
61
|
-
perPage,
|
|
62
|
-
cookbook,
|
|
63
|
-
requireAllCategories,
|
|
64
|
-
requireAllTags,
|
|
65
|
-
requireAllTools,
|
|
66
|
-
requireAllFoods,
|
|
67
|
-
search,
|
|
68
|
-
acceptLanguage
|
|
69
|
-
);
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
### Parameters
|
|
73
|
-
|
|
74
|
-
|Name | Type | Description | Notes|
|
|
75
|
-
|------------- | ------------- | ------------- | -------------|
|
|
76
|
-
| **groupSlug** | [**string**] | | defaults to undefined|
|
|
77
|
-
| **categories** | **Array<GetAllApiRecipesGetTagsParameterInner>** | | (optional) defaults to undefined|
|
|
78
|
-
| **tags** | **Array<GetAllApiRecipesGetTagsParameterInner>** | | (optional) defaults to undefined|
|
|
79
|
-
| **tools** | **Array<GetAllApiRecipesGetTagsParameterInner>** | | (optional) defaults to undefined|
|
|
80
|
-
| **foods** | **Array<GetAllApiRecipesGetTagsParameterInner>** | | (optional) defaults to undefined|
|
|
81
|
-
| **households** | **Array<GetAllApiRecipesGetTagsParameterInner>** | | (optional) defaults to undefined|
|
|
82
|
-
| **orderBy** | [**string**] | | (optional) defaults to undefined|
|
|
83
|
-
| **orderByNullPosition** | **OrderByNullPosition** | | (optional) defaults to undefined|
|
|
84
|
-
| **orderDirection** | **OrderDirection** | | (optional) defaults to undefined|
|
|
85
|
-
| **queryFilter** | [**string**] | | (optional) defaults to undefined|
|
|
86
|
-
| **paginationSeed** | [**string**] | | (optional) defaults to undefined|
|
|
87
|
-
| **page** | [**number**] | | (optional) defaults to 1|
|
|
88
|
-
| **perPage** | [**number**] | | (optional) defaults to 50|
|
|
89
|
-
| **cookbook** | **Cookbook1** | | (optional) defaults to undefined|
|
|
90
|
-
| **requireAllCategories** | [**boolean**] | | (optional) defaults to false|
|
|
91
|
-
| **requireAllTags** | [**boolean**] | | (optional) defaults to false|
|
|
92
|
-
| **requireAllTools** | [**boolean**] | | (optional) defaults to false|
|
|
93
|
-
| **requireAllFoods** | [**boolean**] | | (optional) defaults to false|
|
|
94
|
-
| **search** | [**string**] | | (optional) defaults to undefined|
|
|
95
|
-
| **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
### Return type
|
|
99
|
-
|
|
100
|
-
**PaginationBaseRecipeSummary**
|
|
101
|
-
|
|
102
|
-
### Authorization
|
|
103
|
-
|
|
104
|
-
No authorization required
|
|
105
|
-
|
|
106
|
-
### HTTP request headers
|
|
107
|
-
|
|
108
|
-
- **Content-Type**: Not defined
|
|
109
|
-
- **Accept**: application/json
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
### HTTP response details
|
|
113
|
-
| Status code | Description | Response headers |
|
|
114
|
-
|-------------|-------------|------------------|
|
|
115
|
-
|**200** | Successful Response | - |
|
|
116
|
-
|**422** | Validation Error | - |
|
|
117
|
-
|
|
118
|
-
[[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)
|
|
119
|
-
|
|
120
|
-
# **getRecipeApiExploreGroupsGroupSlugRecipesRecipeSlugGet**
|
|
121
|
-
> RecipeOutput getRecipeApiExploreGroupsGroupSlugRecipesRecipeSlugGet()
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
### Example
|
|
125
|
-
|
|
126
|
-
```typescript
|
|
127
|
-
import {
|
|
128
|
-
ExploreRecipesApi,
|
|
129
|
-
Configuration
|
|
130
|
-
} from 'mealie-typescript';
|
|
131
|
-
|
|
132
|
-
const configuration = new Configuration();
|
|
133
|
-
const apiInstance = new ExploreRecipesApi(configuration);
|
|
134
|
-
|
|
135
|
-
let recipeSlug: string; // (default to undefined)
|
|
136
|
-
let groupSlug: string; // (default to undefined)
|
|
137
|
-
let acceptLanguage: string; // (optional) (default to undefined)
|
|
138
|
-
|
|
139
|
-
const { status, data } = await apiInstance.getRecipeApiExploreGroupsGroupSlugRecipesRecipeSlugGet(
|
|
140
|
-
recipeSlug,
|
|
141
|
-
groupSlug,
|
|
142
|
-
acceptLanguage
|
|
143
|
-
);
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
### Parameters
|
|
147
|
-
|
|
148
|
-
|Name | Type | Description | Notes|
|
|
149
|
-
|------------- | ------------- | ------------- | -------------|
|
|
150
|
-
| **recipeSlug** | [**string**] | | defaults to undefined|
|
|
151
|
-
| **groupSlug** | [**string**] | | defaults to undefined|
|
|
152
|
-
| **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
### Return type
|
|
156
|
-
|
|
157
|
-
**RecipeOutput**
|
|
158
|
-
|
|
159
|
-
### Authorization
|
|
160
|
-
|
|
161
|
-
No authorization required
|
|
162
|
-
|
|
163
|
-
### HTTP request headers
|
|
164
|
-
|
|
165
|
-
- **Content-Type**: Not defined
|
|
166
|
-
- **Accept**: application/json
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
### HTTP response details
|
|
170
|
-
| Status code | Description | Response headers |
|
|
171
|
-
|-------------|-------------|------------------|
|
|
172
|
-
|**200** | Successful Response | - |
|
|
173
|
-
|**422** | Validation Error | - |
|
|
174
|
-
|
|
175
|
-
[[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)
|
|
176
|
-
|
|
177
|
-
# **suggestRecipesApiExploreGroupsGroupSlugRecipesSuggestionsGet**
|
|
178
|
-
> RecipeSuggestionResponse suggestRecipesApiExploreGroupsGroupSlugRecipesSuggestionsGet()
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
### Example
|
|
182
|
-
|
|
183
|
-
```typescript
|
|
184
|
-
import {
|
|
185
|
-
ExploreRecipesApi,
|
|
186
|
-
Configuration
|
|
187
|
-
} from 'mealie-typescript';
|
|
188
|
-
|
|
189
|
-
const configuration = new Configuration();
|
|
190
|
-
const apiInstance = new ExploreRecipesApi(configuration);
|
|
191
|
-
|
|
192
|
-
let groupSlug: string; // (default to undefined)
|
|
193
|
-
let foods: Array<string>; // (optional) (default to undefined)
|
|
194
|
-
let tools: Array<string>; // (optional) (default to undefined)
|
|
195
|
-
let orderBy: string; // (optional) (default to undefined)
|
|
196
|
-
let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
|
|
197
|
-
let orderDirection: OrderDirection; // (optional) (default to undefined)
|
|
198
|
-
let queryFilter: string; // (optional) (default to undefined)
|
|
199
|
-
let paginationSeed: string; // (optional) (default to undefined)
|
|
200
|
-
let limit: number; // (optional) (default to 10)
|
|
201
|
-
let maxMissingFoods: number; // (optional) (default to 5)
|
|
202
|
-
let maxMissingTools: number; // (optional) (default to 5)
|
|
203
|
-
let includeFoodsOnHand: boolean; // (optional) (default to true)
|
|
204
|
-
let includeToolsOnHand: boolean; // (optional) (default to true)
|
|
205
|
-
let acceptLanguage: string; // (optional) (default to undefined)
|
|
206
|
-
|
|
207
|
-
const { status, data } = await apiInstance.suggestRecipesApiExploreGroupsGroupSlugRecipesSuggestionsGet(
|
|
208
|
-
groupSlug,
|
|
209
|
-
foods,
|
|
210
|
-
tools,
|
|
211
|
-
orderBy,
|
|
212
|
-
orderByNullPosition,
|
|
213
|
-
orderDirection,
|
|
214
|
-
queryFilter,
|
|
215
|
-
paginationSeed,
|
|
216
|
-
limit,
|
|
217
|
-
maxMissingFoods,
|
|
218
|
-
maxMissingTools,
|
|
219
|
-
includeFoodsOnHand,
|
|
220
|
-
includeToolsOnHand,
|
|
221
|
-
acceptLanguage
|
|
222
|
-
);
|
|
223
|
-
```
|
|
224
|
-
|
|
225
|
-
### Parameters
|
|
226
|
-
|
|
227
|
-
|Name | Type | Description | Notes|
|
|
228
|
-
|------------- | ------------- | ------------- | -------------|
|
|
229
|
-
| **groupSlug** | [**string**] | | defaults to undefined|
|
|
230
|
-
| **foods** | **Array<string>** | | (optional) defaults to undefined|
|
|
231
|
-
| **tools** | **Array<string>** | | (optional) defaults to undefined|
|
|
232
|
-
| **orderBy** | [**string**] | | (optional) defaults to undefined|
|
|
233
|
-
| **orderByNullPosition** | **OrderByNullPosition** | | (optional) defaults to undefined|
|
|
234
|
-
| **orderDirection** | **OrderDirection** | | (optional) defaults to undefined|
|
|
235
|
-
| **queryFilter** | [**string**] | | (optional) defaults to undefined|
|
|
236
|
-
| **paginationSeed** | [**string**] | | (optional) defaults to undefined|
|
|
237
|
-
| **limit** | [**number**] | | (optional) defaults to 10|
|
|
238
|
-
| **maxMissingFoods** | [**number**] | | (optional) defaults to 5|
|
|
239
|
-
| **maxMissingTools** | [**number**] | | (optional) defaults to 5|
|
|
240
|
-
| **includeFoodsOnHand** | [**boolean**] | | (optional) defaults to true|
|
|
241
|
-
| **includeToolsOnHand** | [**boolean**] | | (optional) defaults to true|
|
|
242
|
-
| **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
### Return type
|
|
246
|
-
|
|
247
|
-
**RecipeSuggestionResponse**
|
|
248
|
-
|
|
249
|
-
### Authorization
|
|
250
|
-
|
|
251
|
-
No authorization required
|
|
252
|
-
|
|
253
|
-
### HTTP request headers
|
|
254
|
-
|
|
255
|
-
- **Content-Type**: Not defined
|
|
256
|
-
- **Accept**: application/json
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
### HTTP response details
|
|
260
|
-
| Status code | Description | Response headers |
|
|
261
|
-
|-------------|-------------|------------------|
|
|
262
|
-
|**200** | Successful Response | - |
|
|
263
|
-
|**422** | Validation Error | - |
|
|
264
|
-
|
|
265
|
-
[[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)
|
|
266
|
-
|
package/docs/ExploreTagsApi.md
DELETED
|
@@ -1,144 +0,0 @@
|
|
|
1
|
-
# ExploreTagsApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
|Method | HTTP request | Description|
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getAllApiExploreGroupsGroupSlugOrganizersTagsGet**](#getallapiexploregroupsgroupslugorganizerstagsget) | **GET** /api/explore/groups/{group_slug}/organizers/tags | Get All|
|
|
8
|
-
|[**getOneApiExploreGroupsGroupSlugOrganizersTagsItemIdGet**](#getoneapiexploregroupsgroupslugorganizerstagsitemidget) | **GET** /api/explore/groups/{group_slug}/organizers/tags/{item_id} | Get One|
|
|
9
|
-
|
|
10
|
-
# **getAllApiExploreGroupsGroupSlugOrganizersTagsGet**
|
|
11
|
-
> PaginationBaseRecipeTag getAllApiExploreGroupsGroupSlugOrganizersTagsGet()
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
### Example
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
import {
|
|
18
|
-
ExploreTagsApi,
|
|
19
|
-
Configuration
|
|
20
|
-
} from 'mealie-typescript';
|
|
21
|
-
|
|
22
|
-
const configuration = new Configuration();
|
|
23
|
-
const apiInstance = new ExploreTagsApi(configuration);
|
|
24
|
-
|
|
25
|
-
let groupSlug: string; // (default to undefined)
|
|
26
|
-
let search: string; // (optional) (default to undefined)
|
|
27
|
-
let orderBy: string; // (optional) (default to undefined)
|
|
28
|
-
let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
|
|
29
|
-
let orderDirection: OrderDirection; // (optional) (default to undefined)
|
|
30
|
-
let queryFilter: string; // (optional) (default to undefined)
|
|
31
|
-
let paginationSeed: string; // (optional) (default to undefined)
|
|
32
|
-
let page: number; // (optional) (default to 1)
|
|
33
|
-
let perPage: number; // (optional) (default to 50)
|
|
34
|
-
let acceptLanguage: string; // (optional) (default to undefined)
|
|
35
|
-
|
|
36
|
-
const { status, data } = await apiInstance.getAllApiExploreGroupsGroupSlugOrganizersTagsGet(
|
|
37
|
-
groupSlug,
|
|
38
|
-
search,
|
|
39
|
-
orderBy,
|
|
40
|
-
orderByNullPosition,
|
|
41
|
-
orderDirection,
|
|
42
|
-
queryFilter,
|
|
43
|
-
paginationSeed,
|
|
44
|
-
page,
|
|
45
|
-
perPage,
|
|
46
|
-
acceptLanguage
|
|
47
|
-
);
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### Parameters
|
|
51
|
-
|
|
52
|
-
|Name | Type | Description | Notes|
|
|
53
|
-
|------------- | ------------- | ------------- | -------------|
|
|
54
|
-
| **groupSlug** | [**string**] | | defaults to undefined|
|
|
55
|
-
| **search** | [**string**] | | (optional) defaults to undefined|
|
|
56
|
-
| **orderBy** | [**string**] | | (optional) defaults to undefined|
|
|
57
|
-
| **orderByNullPosition** | **OrderByNullPosition** | | (optional) defaults to undefined|
|
|
58
|
-
| **orderDirection** | **OrderDirection** | | (optional) defaults to undefined|
|
|
59
|
-
| **queryFilter** | [**string**] | | (optional) defaults to undefined|
|
|
60
|
-
| **paginationSeed** | [**string**] | | (optional) defaults to undefined|
|
|
61
|
-
| **page** | [**number**] | | (optional) defaults to 1|
|
|
62
|
-
| **perPage** | [**number**] | | (optional) defaults to 50|
|
|
63
|
-
| **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
### Return type
|
|
67
|
-
|
|
68
|
-
**PaginationBaseRecipeTag**
|
|
69
|
-
|
|
70
|
-
### Authorization
|
|
71
|
-
|
|
72
|
-
No authorization required
|
|
73
|
-
|
|
74
|
-
### HTTP request headers
|
|
75
|
-
|
|
76
|
-
- **Content-Type**: Not defined
|
|
77
|
-
- **Accept**: application/json
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
### HTTP response details
|
|
81
|
-
| Status code | Description | Response headers |
|
|
82
|
-
|-------------|-------------|------------------|
|
|
83
|
-
|**200** | Successful Response | - |
|
|
84
|
-
|**422** | Validation Error | - |
|
|
85
|
-
|
|
86
|
-
[[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)
|
|
87
|
-
|
|
88
|
-
# **getOneApiExploreGroupsGroupSlugOrganizersTagsItemIdGet**
|
|
89
|
-
> TagOut getOneApiExploreGroupsGroupSlugOrganizersTagsItemIdGet()
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
### Example
|
|
93
|
-
|
|
94
|
-
```typescript
|
|
95
|
-
import {
|
|
96
|
-
ExploreTagsApi,
|
|
97
|
-
Configuration
|
|
98
|
-
} from 'mealie-typescript';
|
|
99
|
-
|
|
100
|
-
const configuration = new Configuration();
|
|
101
|
-
const apiInstance = new ExploreTagsApi(configuration);
|
|
102
|
-
|
|
103
|
-
let itemId: string; // (default to undefined)
|
|
104
|
-
let groupSlug: string; // (default to undefined)
|
|
105
|
-
let acceptLanguage: string; // (optional) (default to undefined)
|
|
106
|
-
|
|
107
|
-
const { status, data } = await apiInstance.getOneApiExploreGroupsGroupSlugOrganizersTagsItemIdGet(
|
|
108
|
-
itemId,
|
|
109
|
-
groupSlug,
|
|
110
|
-
acceptLanguage
|
|
111
|
-
);
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### Parameters
|
|
115
|
-
|
|
116
|
-
|Name | Type | Description | Notes|
|
|
117
|
-
|------------- | ------------- | ------------- | -------------|
|
|
118
|
-
| **itemId** | [**string**] | | defaults to undefined|
|
|
119
|
-
| **groupSlug** | [**string**] | | defaults to undefined|
|
|
120
|
-
| **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
### Return type
|
|
124
|
-
|
|
125
|
-
**TagOut**
|
|
126
|
-
|
|
127
|
-
### Authorization
|
|
128
|
-
|
|
129
|
-
No authorization required
|
|
130
|
-
|
|
131
|
-
### HTTP request headers
|
|
132
|
-
|
|
133
|
-
- **Content-Type**: Not defined
|
|
134
|
-
- **Accept**: application/json
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
### HTTP response details
|
|
138
|
-
| Status code | Description | Response headers |
|
|
139
|
-
|-------------|-------------|------------------|
|
|
140
|
-
|**200** | Successful Response | - |
|
|
141
|
-
|**422** | Validation Error | - |
|
|
142
|
-
|
|
143
|
-
[[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)
|
|
144
|
-
|
package/docs/ExploreToolsApi.md
DELETED
|
@@ -1,144 +0,0 @@
|
|
|
1
|
-
# ExploreToolsApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
|Method | HTTP request | Description|
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getAllApiExploreGroupsGroupSlugOrganizersToolsGet**](#getallapiexploregroupsgroupslugorganizerstoolsget) | **GET** /api/explore/groups/{group_slug}/organizers/tools | Get All|
|
|
8
|
-
|[**getOneApiExploreGroupsGroupSlugOrganizersToolsItemIdGet**](#getoneapiexploregroupsgroupslugorganizerstoolsitemidget) | **GET** /api/explore/groups/{group_slug}/organizers/tools/{item_id} | Get One|
|
|
9
|
-
|
|
10
|
-
# **getAllApiExploreGroupsGroupSlugOrganizersToolsGet**
|
|
11
|
-
> PaginationBaseRecipeTool getAllApiExploreGroupsGroupSlugOrganizersToolsGet()
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
### Example
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
import {
|
|
18
|
-
ExploreToolsApi,
|
|
19
|
-
Configuration
|
|
20
|
-
} from 'mealie-typescript';
|
|
21
|
-
|
|
22
|
-
const configuration = new Configuration();
|
|
23
|
-
const apiInstance = new ExploreToolsApi(configuration);
|
|
24
|
-
|
|
25
|
-
let groupSlug: string; // (default to undefined)
|
|
26
|
-
let search: string; // (optional) (default to undefined)
|
|
27
|
-
let orderBy: string; // (optional) (default to undefined)
|
|
28
|
-
let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
|
|
29
|
-
let orderDirection: OrderDirection; // (optional) (default to undefined)
|
|
30
|
-
let queryFilter: string; // (optional) (default to undefined)
|
|
31
|
-
let paginationSeed: string; // (optional) (default to undefined)
|
|
32
|
-
let page: number; // (optional) (default to 1)
|
|
33
|
-
let perPage: number; // (optional) (default to 50)
|
|
34
|
-
let acceptLanguage: string; // (optional) (default to undefined)
|
|
35
|
-
|
|
36
|
-
const { status, data } = await apiInstance.getAllApiExploreGroupsGroupSlugOrganizersToolsGet(
|
|
37
|
-
groupSlug,
|
|
38
|
-
search,
|
|
39
|
-
orderBy,
|
|
40
|
-
orderByNullPosition,
|
|
41
|
-
orderDirection,
|
|
42
|
-
queryFilter,
|
|
43
|
-
paginationSeed,
|
|
44
|
-
page,
|
|
45
|
-
perPage,
|
|
46
|
-
acceptLanguage
|
|
47
|
-
);
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### Parameters
|
|
51
|
-
|
|
52
|
-
|Name | Type | Description | Notes|
|
|
53
|
-
|------------- | ------------- | ------------- | -------------|
|
|
54
|
-
| **groupSlug** | [**string**] | | defaults to undefined|
|
|
55
|
-
| **search** | [**string**] | | (optional) defaults to undefined|
|
|
56
|
-
| **orderBy** | [**string**] | | (optional) defaults to undefined|
|
|
57
|
-
| **orderByNullPosition** | **OrderByNullPosition** | | (optional) defaults to undefined|
|
|
58
|
-
| **orderDirection** | **OrderDirection** | | (optional) defaults to undefined|
|
|
59
|
-
| **queryFilter** | [**string**] | | (optional) defaults to undefined|
|
|
60
|
-
| **paginationSeed** | [**string**] | | (optional) defaults to undefined|
|
|
61
|
-
| **page** | [**number**] | | (optional) defaults to 1|
|
|
62
|
-
| **perPage** | [**number**] | | (optional) defaults to 50|
|
|
63
|
-
| **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
### Return type
|
|
67
|
-
|
|
68
|
-
**PaginationBaseRecipeTool**
|
|
69
|
-
|
|
70
|
-
### Authorization
|
|
71
|
-
|
|
72
|
-
No authorization required
|
|
73
|
-
|
|
74
|
-
### HTTP request headers
|
|
75
|
-
|
|
76
|
-
- **Content-Type**: Not defined
|
|
77
|
-
- **Accept**: application/json
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
### HTTP response details
|
|
81
|
-
| Status code | Description | Response headers |
|
|
82
|
-
|-------------|-------------|------------------|
|
|
83
|
-
|**200** | Successful Response | - |
|
|
84
|
-
|**422** | Validation Error | - |
|
|
85
|
-
|
|
86
|
-
[[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)
|
|
87
|
-
|
|
88
|
-
# **getOneApiExploreGroupsGroupSlugOrganizersToolsItemIdGet**
|
|
89
|
-
> RecipeToolOut getOneApiExploreGroupsGroupSlugOrganizersToolsItemIdGet()
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
### Example
|
|
93
|
-
|
|
94
|
-
```typescript
|
|
95
|
-
import {
|
|
96
|
-
ExploreToolsApi,
|
|
97
|
-
Configuration
|
|
98
|
-
} from 'mealie-typescript';
|
|
99
|
-
|
|
100
|
-
const configuration = new Configuration();
|
|
101
|
-
const apiInstance = new ExploreToolsApi(configuration);
|
|
102
|
-
|
|
103
|
-
let itemId: string; // (default to undefined)
|
|
104
|
-
let groupSlug: string; // (default to undefined)
|
|
105
|
-
let acceptLanguage: string; // (optional) (default to undefined)
|
|
106
|
-
|
|
107
|
-
const { status, data } = await apiInstance.getOneApiExploreGroupsGroupSlugOrganizersToolsItemIdGet(
|
|
108
|
-
itemId,
|
|
109
|
-
groupSlug,
|
|
110
|
-
acceptLanguage
|
|
111
|
-
);
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### Parameters
|
|
115
|
-
|
|
116
|
-
|Name | Type | Description | Notes|
|
|
117
|
-
|------------- | ------------- | ------------- | -------------|
|
|
118
|
-
| **itemId** | [**string**] | | defaults to undefined|
|
|
119
|
-
| **groupSlug** | [**string**] | | defaults to undefined|
|
|
120
|
-
| **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
### Return type
|
|
124
|
-
|
|
125
|
-
**RecipeToolOut**
|
|
126
|
-
|
|
127
|
-
### Authorization
|
|
128
|
-
|
|
129
|
-
No authorization required
|
|
130
|
-
|
|
131
|
-
### HTTP request headers
|
|
132
|
-
|
|
133
|
-
- **Content-Type**: Not defined
|
|
134
|
-
- **Accept**: application/json
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
### HTTP response details
|
|
138
|
-
| Status code | Description | Response headers |
|
|
139
|
-
|-------------|-------------|------------------|
|
|
140
|
-
|**200** | Successful Response | - |
|
|
141
|
-
|**422** | Validation Error | - |
|
|
142
|
-
|
|
143
|
-
[[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)
|
|
144
|
-
|
package/docs/ExportRecipes.md
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# ExportRecipes
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**recipes** | **Array<string>** | | [default to undefined]
|
|
9
|
-
**exportType** | [**ExportTypes**](ExportTypes.md) | | [optional] [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { ExportRecipes } from 'mealie-typescript';
|
|
15
|
-
|
|
16
|
-
const instance: ExportRecipes = {
|
|
17
|
-
recipes,
|
|
18
|
-
exportType,
|
|
19
|
-
};
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
[[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/ExportTypes.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# FileTokenResponse
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**fileToken** | **string** | | [default to undefined]
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
import { FileTokenResponse } from 'mealie-typescript';
|
|
14
|
-
|
|
15
|
-
const instance: FileTokenResponse = {
|
|
16
|
-
fileToken,
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
[[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/Food.md
DELETED
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
# Food
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | | [default to undefined]
|
|
9
|
-
**name** | **string** | | [default to undefined]
|
|
10
|
-
**pluralName** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**description** | **string** | | [optional] [default to '']
|
|
12
|
-
**extras** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
13
|
-
**labelId** | **string** | | [optional] [default to undefined]
|
|
14
|
-
**aliases** | [**Array<CreateIngredientFoodAlias>**](CreateIngredientFoodAlias.md) | | [optional] [default to undefined]
|
|
15
|
-
**householdsWithIngredientFood** | **Array<string>** | | [optional] [default to undefined]
|
|
16
|
-
**label** | [**MultiPurposeLabelSummary**](MultiPurposeLabelSummary.md) | | [optional] [default to undefined]
|
|
17
|
-
**createdAt** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**update_at** | **string** | | [optional] [default to undefined]
|
|
19
|
-
|
|
20
|
-
## Example
|
|
21
|
-
|
|
22
|
-
```typescript
|
|
23
|
-
import { Food } from 'mealie-typescript';
|
|
24
|
-
|
|
25
|
-
const instance: Food = {
|
|
26
|
-
id,
|
|
27
|
-
name,
|
|
28
|
-
pluralName,
|
|
29
|
-
description,
|
|
30
|
-
extras,
|
|
31
|
-
labelId,
|
|
32
|
-
aliases,
|
|
33
|
-
householdsWithIngredientFood,
|
|
34
|
-
label,
|
|
35
|
-
createdAt,
|
|
36
|
-
update_at,
|
|
37
|
-
};
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
[[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/Food1.md
DELETED
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
# Food1
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | | [default to undefined]
|
|
9
|
-
**name** | **string** | | [default to undefined]
|
|
10
|
-
**pluralName** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**description** | **string** | | [optional] [default to '']
|
|
12
|
-
**extras** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
13
|
-
**labelId** | **string** | | [optional] [default to undefined]
|
|
14
|
-
**aliases** | [**Array<CreateIngredientFoodAlias>**](CreateIngredientFoodAlias.md) | | [optional] [default to undefined]
|
|
15
|
-
**householdsWithIngredientFood** | **Array<string>** | | [optional] [default to undefined]
|
|
16
|
-
**label** | [**MultiPurposeLabelSummary**](MultiPurposeLabelSummary.md) | | [optional] [default to undefined]
|
|
17
|
-
**createdAt** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**updatedAt** | **string** | | [optional] [default to undefined]
|
|
19
|
-
|
|
20
|
-
## Example
|
|
21
|
-
|
|
22
|
-
```typescript
|
|
23
|
-
import { Food1 } from 'mealie-typescript';
|
|
24
|
-
|
|
25
|
-
const instance: Food1 = {
|
|
26
|
-
id,
|
|
27
|
-
name,
|
|
28
|
-
pluralName,
|
|
29
|
-
description,
|
|
30
|
-
extras,
|
|
31
|
-
labelId,
|
|
32
|
-
aliases,
|
|
33
|
-
householdsWithIngredientFood,
|
|
34
|
-
label,
|
|
35
|
-
createdAt,
|
|
36
|
-
updatedAt,
|
|
37
|
-
};
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|