mealie-typescript 1.0.0

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.
Files changed (317) hide show
  1. package/.openapi-generator/FILES +306 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +24 -0
  4. package/README.md +564 -0
  5. package/api.ts +28987 -0
  6. package/base.ts +62 -0
  7. package/common.ts +113 -0
  8. package/configuration.ts +121 -0
  9. package/dist/api.d.ts +15860 -0
  10. package/dist/api.js +28568 -0
  11. package/dist/base.d.ts +42 -0
  12. package/dist/base.js +67 -0
  13. package/dist/common.d.ts +28 -0
  14. package/dist/common.js +216 -0
  15. package/dist/configuration.d.ts +98 -0
  16. package/dist/configuration.js +57 -0
  17. package/dist/index.d.ts +13 -0
  18. package/dist/index.js +31 -0
  19. package/docs/AdminAboutApi.md +164 -0
  20. package/docs/AdminAboutInfo.md +62 -0
  21. package/docs/AdminBackupsApi.md +333 -0
  22. package/docs/AdminDebugApi.md +62 -0
  23. package/docs/AdminEmailApi.md +116 -0
  24. package/docs/AdminMaintenanceApi.md +270 -0
  25. package/docs/AdminManageGroupsApi.md +305 -0
  26. package/docs/AdminManageHouseholdsApi.md +305 -0
  27. package/docs/AdminManageUsersApi.md +417 -0
  28. package/docs/AllBackups.md +22 -0
  29. package/docs/AppAboutApi.md +142 -0
  30. package/docs/AppInfo.md +44 -0
  31. package/docs/AppStartupInfo.md +22 -0
  32. package/docs/AppStatistics.md +30 -0
  33. package/docs/AppTheme.md +46 -0
  34. package/docs/AssignCategories.md +22 -0
  35. package/docs/AssignSettings.md +22 -0
  36. package/docs/AssignTags.md +22 -0
  37. package/docs/AuthMethod.md +12 -0
  38. package/docs/BackupFile.md +24 -0
  39. package/docs/BodyTriggerActionApiHouseholdsRecipeActionsItemIdTriggerRecipeSlugPost.md +20 -0
  40. package/docs/CategoryBase.md +26 -0
  41. package/docs/CategoryIn.md +20 -0
  42. package/docs/CategoryOut.md +26 -0
  43. package/docs/CategorySummary.md +24 -0
  44. package/docs/ChangePassword.md +22 -0
  45. package/docs/CheckAppConfig.md +30 -0
  46. package/docs/CookBookPagination.md +32 -0
  47. package/docs/Cookbook.md +18 -0
  48. package/docs/Cookbook1.md +18 -0
  49. package/docs/CookbookHousehold.md +22 -0
  50. package/docs/CreateCookBook.md +30 -0
  51. package/docs/CreateGroupRecipeAction.md +24 -0
  52. package/docs/CreateIngredientFood.md +34 -0
  53. package/docs/CreateIngredientFoodAlias.md +20 -0
  54. package/docs/CreateIngredientUnit.md +38 -0
  55. package/docs/CreateIngredientUnitAlias.md +20 -0
  56. package/docs/CreateInviteToken.md +24 -0
  57. package/docs/CreatePlanEntry.md +28 -0
  58. package/docs/CreateRandomEntry.md +22 -0
  59. package/docs/CreateRecipe.md +20 -0
  60. package/docs/CreateRecipeBulk.md +24 -0
  61. package/docs/CreateRecipeByUrlBulk.md +20 -0
  62. package/docs/CreateUserRegistration.md +42 -0
  63. package/docs/CreateWebhook.md +28 -0
  64. package/docs/DebugResponse.md +22 -0
  65. package/docs/DeleteRecipes.md +20 -0
  66. package/docs/DeleteTokenResponse.md +20 -0
  67. package/docs/EmailInitationResponse.md +22 -0
  68. package/docs/EmailInvitation.md +22 -0
  69. package/docs/EmailReady.md +20 -0
  70. package/docs/EmailSuccess.md +22 -0
  71. package/docs/EmailTest.md +20 -0
  72. package/docs/ExploreCategoriesApi.md +144 -0
  73. package/docs/ExploreCookbooksApi.md +145 -0
  74. package/docs/ExploreFoodsApi.md +144 -0
  75. package/docs/ExploreHouseholdsApi.md +141 -0
  76. package/docs/ExploreRecipesApi.md +266 -0
  77. package/docs/ExploreTagsApi.md +144 -0
  78. package/docs/ExploreToolsApi.md +144 -0
  79. package/docs/ExportRecipes.md +22 -0
  80. package/docs/ExportTypes.md +8 -0
  81. package/docs/FileTokenResponse.md +20 -0
  82. package/docs/Food.md +40 -0
  83. package/docs/Food1.md +40 -0
  84. package/docs/ForgotPassword.md +20 -0
  85. package/docs/FormatResponse.md +22 -0
  86. package/docs/GetAllApiRecipesGetCategoriesParameterInner.md +18 -0
  87. package/docs/GetAllApiRecipesGetTagsParameterInner.md +18 -0
  88. package/docs/GroupAdminUpdate.md +24 -0
  89. package/docs/GroupBase.md +20 -0
  90. package/docs/GroupDataExport.md +32 -0
  91. package/docs/GroupEventNotifierCreate.md +22 -0
  92. package/docs/GroupEventNotifierOptions.md +69 -0
  93. package/docs/GroupEventNotifierOptionsOut.md +70 -0
  94. package/docs/GroupEventNotifierOut.md +30 -0
  95. package/docs/GroupEventNotifierUpdate.md +32 -0
  96. package/docs/GroupEventPagination.md +32 -0
  97. package/docs/GroupHouseholdSummary.md +22 -0
  98. package/docs/GroupInDB.md +34 -0
  99. package/docs/GroupPagination.md +32 -0
  100. package/docs/GroupRecipeActionOut.md +30 -0
  101. package/docs/GroupRecipeActionPagination.md +32 -0
  102. package/docs/GroupRecipeActionType.md +10 -0
  103. package/docs/GroupStorage.md +26 -0
  104. package/docs/GroupSummary.md +26 -0
  105. package/docs/GroupsHouseholdsApi.md +135 -0
  106. package/docs/GroupsMigrationsApi.md +68 -0
  107. package/docs/GroupsMultiPurposeLabelsApi.md +308 -0
  108. package/docs/GroupsReportsApi.md +172 -0
  109. package/docs/GroupsSeedersApi.md +175 -0
  110. package/docs/GroupsSelfServiceApi.md +351 -0
  111. package/docs/HTTPValidationError.md +20 -0
  112. package/docs/HouseholdCreate.md +22 -0
  113. package/docs/HouseholdInDB.md +34 -0
  114. package/docs/HouseholdPagination.md +32 -0
  115. package/docs/HouseholdRecipeSummary.md +22 -0
  116. package/docs/HouseholdStatistics.md +28 -0
  117. package/docs/HouseholdSummary.md +28 -0
  118. package/docs/HouseholdUserSummary.md +22 -0
  119. package/docs/HouseholdsCookbooksApi.md +361 -0
  120. package/docs/HouseholdsEventNotificationsApi.md +360 -0
  121. package/docs/HouseholdsInvitationsApi.md +171 -0
  122. package/docs/HouseholdsMealplanRulesApi.md +305 -0
  123. package/docs/HouseholdsMealplansApi.md +420 -0
  124. package/docs/HouseholdsRecipeActionsApi.md +367 -0
  125. package/docs/HouseholdsSelfServiceApi.md +406 -0
  126. package/docs/HouseholdsShoppingListItemsApi.md +470 -0
  127. package/docs/HouseholdsShoppingListsApi.md +545 -0
  128. package/docs/HouseholdsWebhooksApi.md +413 -0
  129. package/docs/ImageType.md +12 -0
  130. package/docs/IngredientConfidence.md +30 -0
  131. package/docs/IngredientFoodAlias.md +20 -0
  132. package/docs/IngredientFoodInput.md +40 -0
  133. package/docs/IngredientFoodOutput.md +40 -0
  134. package/docs/IngredientFoodPagination.md +32 -0
  135. package/docs/IngredientReferences.md +21 -0
  136. package/docs/IngredientRequest.md +22 -0
  137. package/docs/IngredientUnitAlias.md +20 -0
  138. package/docs/IngredientUnitInput.md +42 -0
  139. package/docs/IngredientUnitOutput.md +42 -0
  140. package/docs/IngredientUnitPagination.md +32 -0
  141. package/docs/IngredientsRequest.md +22 -0
  142. package/docs/ItemId.md +18 -0
  143. package/docs/ItemId1.md +18 -0
  144. package/docs/LogicalOperator.md +10 -0
  145. package/docs/LongLiveTokenCreateResponse.md +27 -0
  146. package/docs/LongLiveTokenIn.md +22 -0
  147. package/docs/LongLiveTokenOut.md +24 -0
  148. package/docs/MaintenanceStorageDetails.md +28 -0
  149. package/docs/MaintenanceSummary.md +24 -0
  150. package/docs/MealieSchemaRecipeRecipeCommentsUserBase.md +26 -0
  151. package/docs/MealieSchemaUserUserUserBase.md +44 -0
  152. package/docs/MergeFood.md +22 -0
  153. package/docs/MergeUnit.md +22 -0
  154. package/docs/MultiPurposeLabelCreate.md +22 -0
  155. package/docs/MultiPurposeLabelOut.md +26 -0
  156. package/docs/MultiPurposeLabelPagination.md +32 -0
  157. package/docs/MultiPurposeLabelSummary.md +26 -0
  158. package/docs/MultiPurposeLabelUpdate.md +26 -0
  159. package/docs/Nutrition.md +40 -0
  160. package/docs/OrderByNullPosition.md +10 -0
  161. package/docs/OrderDirection.md +10 -0
  162. package/docs/OrganizerCategoriesApi.md +422 -0
  163. package/docs/OrganizerTagsApi.md +421 -0
  164. package/docs/OrganizerToolsApi.md +363 -0
  165. package/docs/PaginationBaseHouseholdSummary.md +32 -0
  166. package/docs/PaginationBaseIngredientFood.md +32 -0
  167. package/docs/PaginationBaseReadCookBook.md +32 -0
  168. package/docs/PaginationBaseRecipeCategory.md +32 -0
  169. package/docs/PaginationBaseRecipeSummary.md +32 -0
  170. package/docs/PaginationBaseRecipeTag.md +32 -0
  171. package/docs/PaginationBaseRecipeTool.md +32 -0
  172. package/docs/PaginationBaseUserOut.md +32 -0
  173. package/docs/PaginationBaseUserSummary.md +32 -0
  174. package/docs/ParsedIngredient.md +24 -0
  175. package/docs/PasswordResetToken.md +20 -0
  176. package/docs/PlanEntryPagination.md +32 -0
  177. package/docs/PlanEntryType.md +20 -0
  178. package/docs/PlanRulesCreate.md +24 -0
  179. package/docs/PlanRulesDay.md +22 -0
  180. package/docs/PlanRulesOut.md +32 -0
  181. package/docs/PlanRulesPagination.md +32 -0
  182. package/docs/PlanRulesType.md +22 -0
  183. package/docs/QueryFilterJSON.md +20 -0
  184. package/docs/QueryFilterJSONPart.md +30 -0
  185. package/docs/ReadCookBook.md +40 -0
  186. package/docs/ReadGroupPreferences.md +24 -0
  187. package/docs/ReadHouseholdPreferences.md +36 -0
  188. package/docs/ReadInviteToken.md +26 -0
  189. package/docs/ReadPlanEntry.md +38 -0
  190. package/docs/ReadWebhook.md +34 -0
  191. package/docs/RecipeAsset.md +24 -0
  192. package/docs/RecipeBulkActionsApi.md +448 -0
  193. package/docs/RecipeCRUDApi.md +1306 -0
  194. package/docs/RecipeCategory.md +26 -0
  195. package/docs/RecipeCategoryPagination.md +32 -0
  196. package/docs/RecipeCommentCreate.md +22 -0
  197. package/docs/RecipeCommentOutInput.md +32 -0
  198. package/docs/RecipeCommentOutOutput.md +32 -0
  199. package/docs/RecipeCommentPagination.md +32 -0
  200. package/docs/RecipeCommentUpdate.md +22 -0
  201. package/docs/RecipeCommentsApi.md +361 -0
  202. package/docs/RecipeDuplicate.md +20 -0
  203. package/docs/RecipeExportsApi.md +118 -0
  204. package/docs/RecipeImagesAndAssetsApi.md +521 -0
  205. package/docs/RecipeIngredientInput.md +36 -0
  206. package/docs/RecipeIngredientOutput.md +36 -0
  207. package/docs/RecipeIngredientParserApi.md +119 -0
  208. package/docs/RecipeInput.md +84 -0
  209. package/docs/RecipeLastMade.md +20 -0
  210. package/docs/RecipeNote.md +22 -0
  211. package/docs/RecipeOutput.md +84 -0
  212. package/docs/RecipeSettings.md +30 -0
  213. package/docs/RecipeShareToken.md +30 -0
  214. package/docs/RecipeShareTokenCreate.md +22 -0
  215. package/docs/RecipeShareTokenSummary.md +28 -0
  216. package/docs/RecipeSharedApi.md +112 -0
  217. package/docs/RecipeStep.md +28 -0
  218. package/docs/RecipeSuggestionResponse.md +20 -0
  219. package/docs/RecipeSuggestionResponseItem.md +24 -0
  220. package/docs/RecipeSummary.md +68 -0
  221. package/docs/RecipeTag.md +26 -0
  222. package/docs/RecipeTagPagination.md +32 -0
  223. package/docs/RecipeTagResponse.md +28 -0
  224. package/docs/RecipeTimelineApi.md +366 -0
  225. package/docs/RecipeTimelineEventIn.md +32 -0
  226. package/docs/RecipeTimelineEventOut.md +42 -0
  227. package/docs/RecipeTimelineEventPagination.md +32 -0
  228. package/docs/RecipeTimelineEventUpdate.md +24 -0
  229. package/docs/RecipeTool.md +28 -0
  230. package/docs/RecipeToolCreate.md +22 -0
  231. package/docs/RecipeToolOut.md +28 -0
  232. package/docs/RecipeToolPagination.md +32 -0
  233. package/docs/RecipeToolResponse.md +30 -0
  234. package/docs/RecipesFoodsApi.md +364 -0
  235. package/docs/RecipesUnitsApi.md +364 -0
  236. package/docs/RegisteredParser.md +12 -0
  237. package/docs/RelationalKeyword.md +20 -0
  238. package/docs/RelationalOperator.md +18 -0
  239. package/docs/Relationaloperator.md +18 -0
  240. package/docs/ReportCategory.md +14 -0
  241. package/docs/ReportEntryOut.md +30 -0
  242. package/docs/ReportOut.md +32 -0
  243. package/docs/ReportSummary.md +30 -0
  244. package/docs/ReportSummaryStatus.md +14 -0
  245. package/docs/ResetPassword.md +26 -0
  246. package/docs/SaveGroupRecipeAction.md +28 -0
  247. package/docs/ScrapeRecipe.md +22 -0
  248. package/docs/ScrapeRecipeData.md +22 -0
  249. package/docs/ScrapeRecipeTest.md +22 -0
  250. package/docs/SeederConfig.md +20 -0
  251. package/docs/SetPermissions.md +28 -0
  252. package/docs/SharedRecipesApi.md +228 -0
  253. package/docs/ShoppingListAddRecipeParams.md +22 -0
  254. package/docs/ShoppingListAddRecipeParamsBulk.md +24 -0
  255. package/docs/ShoppingListCreate.md +26 -0
  256. package/docs/ShoppingListItemCreate.md +48 -0
  257. package/docs/ShoppingListItemOutInput.md +58 -0
  258. package/docs/ShoppingListItemOutOutput.md +58 -0
  259. package/docs/ShoppingListItemPagination.md +32 -0
  260. package/docs/ShoppingListItemRecipeRefCreate.md +26 -0
  261. package/docs/ShoppingListItemRecipeRefOut.md +30 -0
  262. package/docs/ShoppingListItemRecipeRefUpdate.md +30 -0
  263. package/docs/ShoppingListItemUpdate.md +46 -0
  264. package/docs/ShoppingListItemUpdateBulk.md +49 -0
  265. package/docs/ShoppingListItemUpdateRecipeReferencesInner.md +30 -0
  266. package/docs/ShoppingListItemsCollectionOut.md +25 -0
  267. package/docs/ShoppingListMultiPurposeLabelOut.md +28 -0
  268. package/docs/ShoppingListMultiPurposeLabelUpdate.md +26 -0
  269. package/docs/ShoppingListOut.md +40 -0
  270. package/docs/ShoppingListPagination.md +32 -0
  271. package/docs/ShoppingListRecipeRefOut.md +28 -0
  272. package/docs/ShoppingListRemoveRecipeParams.md +20 -0
  273. package/docs/ShoppingListSummary.md +38 -0
  274. package/docs/ShoppingListUpdate.md +34 -0
  275. package/docs/SuccessResponse.md +22 -0
  276. package/docs/SupportedMigrations.md +26 -0
  277. package/docs/TagBase.md +26 -0
  278. package/docs/TagIn.md +20 -0
  279. package/docs/TagOut.md +26 -0
  280. package/docs/TimelineEventImage.md +10 -0
  281. package/docs/TimelineEventType.md +12 -0
  282. package/docs/Unit.md +42 -0
  283. package/docs/Unit1.md +42 -0
  284. package/docs/UnlockResults.md +20 -0
  285. package/docs/UpdateCookBook.md +36 -0
  286. package/docs/UpdateGroupPreferences.md +20 -0
  287. package/docs/UpdateHouseholdAdmin.md +26 -0
  288. package/docs/UpdateHouseholdPreferences.md +34 -0
  289. package/docs/UpdateImageResponse.md +20 -0
  290. package/docs/UpdatePlanEntry.md +34 -0
  291. package/docs/UserIn.md +46 -0
  292. package/docs/UserOut.md +56 -0
  293. package/docs/UserPagination.md +32 -0
  294. package/docs/UserRatingOut.md +28 -0
  295. package/docs/UserRatingSummary.md +24 -0
  296. package/docs/UserRatingUpdate.md +22 -0
  297. package/docs/UserRatingsUserRatingOut.md +20 -0
  298. package/docs/UserRatingsUserRatingSummary.md +20 -0
  299. package/docs/UserSummary.md +28 -0
  300. package/docs/UsernameOrId.md +18 -0
  301. package/docs/UsersAuthenticationApi.md +250 -0
  302. package/docs/UsersCRUDApi.md +334 -0
  303. package/docs/UsersImagesApi.md +66 -0
  304. package/docs/UsersPasswordsApi.md +118 -0
  305. package/docs/UsersRatingsApi.md +300 -0
  306. package/docs/UsersRegistrationApi.md +63 -0
  307. package/docs/UsersTokensApi.md +120 -0
  308. package/docs/UtilsApi.md +60 -0
  309. package/docs/ValidationError.md +24 -0
  310. package/docs/ValidationErrorLocInner.md +18 -0
  311. package/docs/Value.md +18 -0
  312. package/docs/WebhookPagination.md +32 -0
  313. package/docs/WebhookType.md +8 -0
  314. package/git_push.sh +57 -0
  315. package/index.ts +18 -0
  316. package/package.json +31 -0
  317. package/tsconfig.json +21 -0
@@ -0,0 +1,1306 @@
1
+ # RecipeCRUDApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createOneApiRecipesPost**](#createoneapirecipespost) | **POST** /api/recipes | Create One|
8
+ |[**createRecipeFromHtmlOrJsonApiRecipesCreateHtmlOrJsonPost**](#createrecipefromhtmlorjsonapirecipescreatehtmlorjsonpost) | **POST** /api/recipes/create/html-or-json | Create Recipe From Html Or Json|
9
+ |[**createRecipeFromImageApiRecipesCreateImagePost**](#createrecipefromimageapirecipescreateimagepost) | **POST** /api/recipes/create/image | Create Recipe From Image|
10
+ |[**createRecipeFromZipApiRecipesCreateZipPost**](#createrecipefromzipapirecipescreatezippost) | **POST** /api/recipes/create/zip | Create Recipe From Zip|
11
+ |[**deleteOneApiRecipesSlugDelete**](#deleteoneapirecipesslugdelete) | **DELETE** /api/recipes/{slug} | Delete One|
12
+ |[**deleteRecipeImageApiRecipesSlugImageDelete**](#deleterecipeimageapirecipesslugimagedelete) | **DELETE** /api/recipes/{slug}/image | Delete Recipe Image|
13
+ |[**duplicateOneApiRecipesSlugDuplicatePost**](#duplicateoneapirecipesslugduplicatepost) | **POST** /api/recipes/{slug}/duplicate | Duplicate One|
14
+ |[**getAllApiRecipesGet**](#getallapirecipesget) | **GET** /api/recipes | Get All|
15
+ |[**getOneApiRecipesSlugGet**](#getoneapirecipesslugget) | **GET** /api/recipes/{slug} | Get One|
16
+ |[**parseRecipeUrlApiRecipesCreateUrlPost**](#parserecipeurlapirecipescreateurlpost) | **POST** /api/recipes/create/url | Parse Recipe Url|
17
+ |[**parseRecipeUrlBulkApiRecipesCreateUrlBulkPost**](#parserecipeurlbulkapirecipescreateurlbulkpost) | **POST** /api/recipes/create/url/bulk | Parse Recipe Url Bulk|
18
+ |[**patchManyApiRecipesPatch**](#patchmanyapirecipespatch) | **PATCH** /api/recipes | Patch Many|
19
+ |[**patchOneApiRecipesSlugPatch**](#patchoneapirecipesslugpatch) | **PATCH** /api/recipes/{slug} | Patch One|
20
+ |[**scrapeImageUrlApiRecipesSlugImagePost**](#scrapeimageurlapirecipesslugimagepost) | **POST** /api/recipes/{slug}/image | Scrape Image Url|
21
+ |[**suggestRecipesApiRecipesSuggestionsGet**](#suggestrecipesapirecipessuggestionsget) | **GET** /api/recipes/suggestions | Suggest Recipes|
22
+ |[**testParseRecipeUrlApiRecipesTestScrapeUrlPost**](#testparserecipeurlapirecipestestscrapeurlpost) | **POST** /api/recipes/test-scrape-url | Test Parse Recipe Url|
23
+ |[**updateLastMadeApiRecipesSlugLastMadePatch**](#updatelastmadeapirecipessluglastmadepatch) | **PATCH** /api/recipes/{slug}/last-made | Update Last Made|
24
+ |[**updateManyApiRecipesPut**](#updatemanyapirecipesput) | **PUT** /api/recipes | Update Many|
25
+ |[**updateOneApiRecipesSlugPut**](#updateoneapirecipesslugput) | **PUT** /api/recipes/{slug} | Update One|
26
+ |[**updateRecipeImageApiRecipesSlugImagePut**](#updaterecipeimageapirecipesslugimageput) | **PUT** /api/recipes/{slug}/image | Update Recipe Image|
27
+ |[**uploadRecipeAssetApiRecipesSlugAssetsPost**](#uploadrecipeassetapirecipesslugassetspost) | **POST** /api/recipes/{slug}/assets | Upload Recipe Asset|
28
+
29
+ # **createOneApiRecipesPost**
30
+ > string createOneApiRecipesPost(createRecipe)
31
+
32
+ Takes in a JSON string and loads data into the database as a new entry
33
+
34
+ ### Example
35
+
36
+ ```typescript
37
+ import {
38
+ RecipeCRUDApi,
39
+ Configuration,
40
+ CreateRecipe
41
+ } from 'mealie-typescript';
42
+
43
+ const configuration = new Configuration();
44
+ const apiInstance = new RecipeCRUDApi(configuration);
45
+
46
+ let createRecipe: CreateRecipe; //
47
+ let acceptLanguage: string; // (optional) (default to undefined)
48
+
49
+ const { status, data } = await apiInstance.createOneApiRecipesPost(
50
+ createRecipe,
51
+ acceptLanguage
52
+ );
53
+ ```
54
+
55
+ ### Parameters
56
+
57
+ |Name | Type | Description | Notes|
58
+ |------------- | ------------- | ------------- | -------------|
59
+ | **createRecipe** | **CreateRecipe**| | |
60
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
61
+
62
+
63
+ ### Return type
64
+
65
+ **string**
66
+
67
+ ### Authorization
68
+
69
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
70
+
71
+ ### HTTP request headers
72
+
73
+ - **Content-Type**: application/json
74
+ - **Accept**: application/json
75
+
76
+
77
+ ### HTTP response details
78
+ | Status code | Description | Response headers |
79
+ |-------------|-------------|------------------|
80
+ |**201** | Successful Response | - |
81
+ |**422** | Validation Error | - |
82
+
83
+ [[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)
84
+
85
+ # **createRecipeFromHtmlOrJsonApiRecipesCreateHtmlOrJsonPost**
86
+ > any createRecipeFromHtmlOrJsonApiRecipesCreateHtmlOrJsonPost(scrapeRecipeData)
87
+
88
+ Takes in raw HTML or a https://schema.org/Recipe object as a JSON string and parses it like a URL
89
+
90
+ ### Example
91
+
92
+ ```typescript
93
+ import {
94
+ RecipeCRUDApi,
95
+ Configuration,
96
+ ScrapeRecipeData
97
+ } from 'mealie-typescript';
98
+
99
+ const configuration = new Configuration();
100
+ const apiInstance = new RecipeCRUDApi(configuration);
101
+
102
+ let scrapeRecipeData: ScrapeRecipeData; //
103
+ let acceptLanguage: string; // (optional) (default to undefined)
104
+
105
+ const { status, data } = await apiInstance.createRecipeFromHtmlOrJsonApiRecipesCreateHtmlOrJsonPost(
106
+ scrapeRecipeData,
107
+ acceptLanguage
108
+ );
109
+ ```
110
+
111
+ ### Parameters
112
+
113
+ |Name | Type | Description | Notes|
114
+ |------------- | ------------- | ------------- | -------------|
115
+ | **scrapeRecipeData** | **ScrapeRecipeData**| | |
116
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
117
+
118
+
119
+ ### Return type
120
+
121
+ **any**
122
+
123
+ ### Authorization
124
+
125
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
126
+
127
+ ### HTTP request headers
128
+
129
+ - **Content-Type**: application/json
130
+ - **Accept**: application/json
131
+
132
+
133
+ ### HTTP response details
134
+ | Status code | Description | Response headers |
135
+ |-------------|-------------|------------------|
136
+ |**201** | Successful Response | - |
137
+ |**422** | Validation Error | - |
138
+
139
+ [[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)
140
+
141
+ # **createRecipeFromImageApiRecipesCreateImagePost**
142
+ > any createRecipeFromImageApiRecipesCreateImagePost()
143
+
144
+ Create a recipe from an image using OpenAI. Optionally specify a language for it to translate the recipe to.
145
+
146
+ ### Example
147
+
148
+ ```typescript
149
+ import {
150
+ RecipeCRUDApi,
151
+ Configuration
152
+ } from 'mealie-typescript';
153
+
154
+ const configuration = new Configuration();
155
+ const apiInstance = new RecipeCRUDApi(configuration);
156
+
157
+ let images: Array<File>; // (default to undefined)
158
+ let translateLanguage: string; // (optional) (default to undefined)
159
+ let acceptLanguage: string; // (optional) (default to undefined)
160
+
161
+ const { status, data } = await apiInstance.createRecipeFromImageApiRecipesCreateImagePost(
162
+ images,
163
+ translateLanguage,
164
+ acceptLanguage
165
+ );
166
+ ```
167
+
168
+ ### Parameters
169
+
170
+ |Name | Type | Description | Notes|
171
+ |------------- | ------------- | ------------- | -------------|
172
+ | **images** | **Array&lt;File&gt;** | | defaults to undefined|
173
+ | **translateLanguage** | [**string**] | | (optional) defaults to undefined|
174
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
175
+
176
+
177
+ ### Return type
178
+
179
+ **any**
180
+
181
+ ### Authorization
182
+
183
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
184
+
185
+ ### HTTP request headers
186
+
187
+ - **Content-Type**: multipart/form-data
188
+ - **Accept**: application/json
189
+
190
+
191
+ ### HTTP response details
192
+ | Status code | Description | Response headers |
193
+ |-------------|-------------|------------------|
194
+ |**201** | Successful Response | - |
195
+ |**422** | Validation Error | - |
196
+
197
+ [[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)
198
+
199
+ # **createRecipeFromZipApiRecipesCreateZipPost**
200
+ > any createRecipeFromZipApiRecipesCreateZipPost()
201
+
202
+ Create recipe from archive
203
+
204
+ ### Example
205
+
206
+ ```typescript
207
+ import {
208
+ RecipeCRUDApi,
209
+ Configuration
210
+ } from 'mealie-typescript';
211
+
212
+ const configuration = new Configuration();
213
+ const apiInstance = new RecipeCRUDApi(configuration);
214
+
215
+ let archive: File; // (default to undefined)
216
+ let acceptLanguage: string; // (optional) (default to undefined)
217
+
218
+ const { status, data } = await apiInstance.createRecipeFromZipApiRecipesCreateZipPost(
219
+ archive,
220
+ acceptLanguage
221
+ );
222
+ ```
223
+
224
+ ### Parameters
225
+
226
+ |Name | Type | Description | Notes|
227
+ |------------- | ------------- | ------------- | -------------|
228
+ | **archive** | [**File**] | | defaults to undefined|
229
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
230
+
231
+
232
+ ### Return type
233
+
234
+ **any**
235
+
236
+ ### Authorization
237
+
238
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
239
+
240
+ ### HTTP request headers
241
+
242
+ - **Content-Type**: multipart/form-data
243
+ - **Accept**: application/json
244
+
245
+
246
+ ### HTTP response details
247
+ | Status code | Description | Response headers |
248
+ |-------------|-------------|------------------|
249
+ |**201** | Successful Response | - |
250
+ |**422** | Validation Error | - |
251
+
252
+ [[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)
253
+
254
+ # **deleteOneApiRecipesSlugDelete**
255
+ > any deleteOneApiRecipesSlugDelete()
256
+
257
+ Deletes a recipe by slug
258
+
259
+ ### Example
260
+
261
+ ```typescript
262
+ import {
263
+ RecipeCRUDApi,
264
+ Configuration
265
+ } from 'mealie-typescript';
266
+
267
+ const configuration = new Configuration();
268
+ const apiInstance = new RecipeCRUDApi(configuration);
269
+
270
+ let slug: string; // (default to undefined)
271
+ let acceptLanguage: string; // (optional) (default to undefined)
272
+
273
+ const { status, data } = await apiInstance.deleteOneApiRecipesSlugDelete(
274
+ slug,
275
+ acceptLanguage
276
+ );
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+ |Name | Type | Description | Notes|
282
+ |------------- | ------------- | ------------- | -------------|
283
+ | **slug** | [**string**] | | defaults to undefined|
284
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
285
+
286
+
287
+ ### Return type
288
+
289
+ **any**
290
+
291
+ ### Authorization
292
+
293
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
294
+
295
+ ### HTTP request headers
296
+
297
+ - **Content-Type**: Not defined
298
+ - **Accept**: application/json
299
+
300
+
301
+ ### HTTP response details
302
+ | Status code | Description | Response headers |
303
+ |-------------|-------------|------------------|
304
+ |**200** | Successful Response | - |
305
+ |**422** | Validation Error | - |
306
+
307
+ [[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)
308
+
309
+ # **deleteRecipeImageApiRecipesSlugImageDelete**
310
+ > any deleteRecipeImageApiRecipesSlugImageDelete()
311
+
312
+
313
+ ### Example
314
+
315
+ ```typescript
316
+ import {
317
+ RecipeCRUDApi,
318
+ Configuration
319
+ } from 'mealie-typescript';
320
+
321
+ const configuration = new Configuration();
322
+ const apiInstance = new RecipeCRUDApi(configuration);
323
+
324
+ let slug: string; // (default to undefined)
325
+ let acceptLanguage: string; // (optional) (default to undefined)
326
+
327
+ const { status, data } = await apiInstance.deleteRecipeImageApiRecipesSlugImageDelete(
328
+ slug,
329
+ acceptLanguage
330
+ );
331
+ ```
332
+
333
+ ### Parameters
334
+
335
+ |Name | Type | Description | Notes|
336
+ |------------- | ------------- | ------------- | -------------|
337
+ | **slug** | [**string**] | | defaults to undefined|
338
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
339
+
340
+
341
+ ### Return type
342
+
343
+ **any**
344
+
345
+ ### Authorization
346
+
347
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
348
+
349
+ ### HTTP request headers
350
+
351
+ - **Content-Type**: Not defined
352
+ - **Accept**: application/json
353
+
354
+
355
+ ### HTTP response details
356
+ | Status code | Description | Response headers |
357
+ |-------------|-------------|------------------|
358
+ |**200** | Successful Response | - |
359
+ |**422** | Validation Error | - |
360
+
361
+ [[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)
362
+
363
+ # **duplicateOneApiRecipesSlugDuplicatePost**
364
+ > RecipeOutput duplicateOneApiRecipesSlugDuplicatePost(recipeDuplicate)
365
+
366
+ Duplicates a recipe with a new custom name if given
367
+
368
+ ### Example
369
+
370
+ ```typescript
371
+ import {
372
+ RecipeCRUDApi,
373
+ Configuration,
374
+ RecipeDuplicate
375
+ } from 'mealie-typescript';
376
+
377
+ const configuration = new Configuration();
378
+ const apiInstance = new RecipeCRUDApi(configuration);
379
+
380
+ let slug: string; // (default to undefined)
381
+ let recipeDuplicate: RecipeDuplicate; //
382
+ let acceptLanguage: string; // (optional) (default to undefined)
383
+
384
+ const { status, data } = await apiInstance.duplicateOneApiRecipesSlugDuplicatePost(
385
+ slug,
386
+ recipeDuplicate,
387
+ acceptLanguage
388
+ );
389
+ ```
390
+
391
+ ### Parameters
392
+
393
+ |Name | Type | Description | Notes|
394
+ |------------- | ------------- | ------------- | -------------|
395
+ | **recipeDuplicate** | **RecipeDuplicate**| | |
396
+ | **slug** | [**string**] | | defaults to undefined|
397
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
398
+
399
+
400
+ ### Return type
401
+
402
+ **RecipeOutput**
403
+
404
+ ### Authorization
405
+
406
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
407
+
408
+ ### HTTP request headers
409
+
410
+ - **Content-Type**: application/json
411
+ - **Accept**: application/json
412
+
413
+
414
+ ### HTTP response details
415
+ | Status code | Description | Response headers |
416
+ |-------------|-------------|------------------|
417
+ |**201** | Successful Response | - |
418
+ |**422** | Validation Error | - |
419
+
420
+ [[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)
421
+
422
+ # **getAllApiRecipesGet**
423
+ > PaginationBaseRecipeSummary getAllApiRecipesGet()
424
+
425
+
426
+ ### Example
427
+
428
+ ```typescript
429
+ import {
430
+ RecipeCRUDApi,
431
+ Configuration,
432
+ Cookbook
433
+ } from 'mealie-typescript';
434
+
435
+ const configuration = new Configuration();
436
+ const apiInstance = new RecipeCRUDApi(configuration);
437
+
438
+ let categories: Array<GetAllApiRecipesGetCategoriesParameterInner>; // (optional) (default to undefined)
439
+ let tags: Array<GetAllApiRecipesGetTagsParameterInner>; // (optional) (default to undefined)
440
+ let tools: Array<GetAllApiRecipesGetTagsParameterInner>; // (optional) (default to undefined)
441
+ let foods: Array<GetAllApiRecipesGetTagsParameterInner>; // (optional) (default to undefined)
442
+ let households: Array<GetAllApiRecipesGetTagsParameterInner>; // (optional) (default to undefined)
443
+ let orderBy: string; // (optional) (default to undefined)
444
+ let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
445
+ let orderDirection: OrderDirection; // (optional) (default to undefined)
446
+ let queryFilter: string; // (optional) (default to undefined)
447
+ let paginationSeed: string; // (optional) (default to undefined)
448
+ let page: number; // (optional) (default to 1)
449
+ let perPage: number; // (optional) (default to 50)
450
+ let cookbook: Cookbook; // (optional) (default to undefined)
451
+ let requireAllCategories: boolean; // (optional) (default to false)
452
+ let requireAllTags: boolean; // (optional) (default to false)
453
+ let requireAllTools: boolean; // (optional) (default to false)
454
+ let requireAllFoods: boolean; // (optional) (default to false)
455
+ let search: string; // (optional) (default to undefined)
456
+ let acceptLanguage: string; // (optional) (default to undefined)
457
+
458
+ const { status, data } = await apiInstance.getAllApiRecipesGet(
459
+ categories,
460
+ tags,
461
+ tools,
462
+ foods,
463
+ households,
464
+ orderBy,
465
+ orderByNullPosition,
466
+ orderDirection,
467
+ queryFilter,
468
+ paginationSeed,
469
+ page,
470
+ perPage,
471
+ cookbook,
472
+ requireAllCategories,
473
+ requireAllTags,
474
+ requireAllTools,
475
+ requireAllFoods,
476
+ search,
477
+ acceptLanguage
478
+ );
479
+ ```
480
+
481
+ ### Parameters
482
+
483
+ |Name | Type | Description | Notes|
484
+ |------------- | ------------- | ------------- | -------------|
485
+ | **categories** | **Array&lt;GetAllApiRecipesGetCategoriesParameterInner&gt;** | | (optional) defaults to undefined|
486
+ | **tags** | **Array&lt;GetAllApiRecipesGetTagsParameterInner&gt;** | | (optional) defaults to undefined|
487
+ | **tools** | **Array&lt;GetAllApiRecipesGetTagsParameterInner&gt;** | | (optional) defaults to undefined|
488
+ | **foods** | **Array&lt;GetAllApiRecipesGetTagsParameterInner&gt;** | | (optional) defaults to undefined|
489
+ | **households** | **Array&lt;GetAllApiRecipesGetTagsParameterInner&gt;** | | (optional) defaults to undefined|
490
+ | **orderBy** | [**string**] | | (optional) defaults to undefined|
491
+ | **orderByNullPosition** | **OrderByNullPosition** | | (optional) defaults to undefined|
492
+ | **orderDirection** | **OrderDirection** | | (optional) defaults to undefined|
493
+ | **queryFilter** | [**string**] | | (optional) defaults to undefined|
494
+ | **paginationSeed** | [**string**] | | (optional) defaults to undefined|
495
+ | **page** | [**number**] | | (optional) defaults to 1|
496
+ | **perPage** | [**number**] | | (optional) defaults to 50|
497
+ | **cookbook** | **Cookbook** | | (optional) defaults to undefined|
498
+ | **requireAllCategories** | [**boolean**] | | (optional) defaults to false|
499
+ | **requireAllTags** | [**boolean**] | | (optional) defaults to false|
500
+ | **requireAllTools** | [**boolean**] | | (optional) defaults to false|
501
+ | **requireAllFoods** | [**boolean**] | | (optional) defaults to false|
502
+ | **search** | [**string**] | | (optional) defaults to undefined|
503
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
504
+
505
+
506
+ ### Return type
507
+
508
+ **PaginationBaseRecipeSummary**
509
+
510
+ ### Authorization
511
+
512
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
513
+
514
+ ### HTTP request headers
515
+
516
+ - **Content-Type**: Not defined
517
+ - **Accept**: application/json
518
+
519
+
520
+ ### HTTP response details
521
+ | Status code | Description | Response headers |
522
+ |-------------|-------------|------------------|
523
+ |**200** | Successful Response | - |
524
+ |**422** | Validation Error | - |
525
+
526
+ [[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)
527
+
528
+ # **getOneApiRecipesSlugGet**
529
+ > RecipeOutput getOneApiRecipesSlugGet()
530
+
531
+ Takes in a recipe\'s slug or id and returns all data for a recipe
532
+
533
+ ### Example
534
+
535
+ ```typescript
536
+ import {
537
+ RecipeCRUDApi,
538
+ Configuration
539
+ } from 'mealie-typescript';
540
+
541
+ const configuration = new Configuration();
542
+ const apiInstance = new RecipeCRUDApi(configuration);
543
+
544
+ let slug: string; //A recipe\'s slug or id (default to undefined)
545
+ let acceptLanguage: string; // (optional) (default to undefined)
546
+
547
+ const { status, data } = await apiInstance.getOneApiRecipesSlugGet(
548
+ slug,
549
+ acceptLanguage
550
+ );
551
+ ```
552
+
553
+ ### Parameters
554
+
555
+ |Name | Type | Description | Notes|
556
+ |------------- | ------------- | ------------- | -------------|
557
+ | **slug** | [**string**] | A recipe\&#39;s slug or id | defaults to undefined|
558
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
559
+
560
+
561
+ ### Return type
562
+
563
+ **RecipeOutput**
564
+
565
+ ### Authorization
566
+
567
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
568
+
569
+ ### HTTP request headers
570
+
571
+ - **Content-Type**: Not defined
572
+ - **Accept**: application/json
573
+
574
+
575
+ ### HTTP response details
576
+ | Status code | Description | Response headers |
577
+ |-------------|-------------|------------------|
578
+ |**200** | Successful Response | - |
579
+ |**422** | Validation Error | - |
580
+
581
+ [[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)
582
+
583
+ # **parseRecipeUrlApiRecipesCreateUrlPost**
584
+ > string parseRecipeUrlApiRecipesCreateUrlPost(scrapeRecipe)
585
+
586
+ Takes in a URL and attempts to scrape data and load it into the database
587
+
588
+ ### Example
589
+
590
+ ```typescript
591
+ import {
592
+ RecipeCRUDApi,
593
+ Configuration,
594
+ ScrapeRecipe
595
+ } from 'mealie-typescript';
596
+
597
+ const configuration = new Configuration();
598
+ const apiInstance = new RecipeCRUDApi(configuration);
599
+
600
+ let scrapeRecipe: ScrapeRecipe; //
601
+ let acceptLanguage: string; // (optional) (default to undefined)
602
+
603
+ const { status, data } = await apiInstance.parseRecipeUrlApiRecipesCreateUrlPost(
604
+ scrapeRecipe,
605
+ acceptLanguage
606
+ );
607
+ ```
608
+
609
+ ### Parameters
610
+
611
+ |Name | Type | Description | Notes|
612
+ |------------- | ------------- | ------------- | -------------|
613
+ | **scrapeRecipe** | **ScrapeRecipe**| | |
614
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
615
+
616
+
617
+ ### Return type
618
+
619
+ **string**
620
+
621
+ ### Authorization
622
+
623
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
624
+
625
+ ### HTTP request headers
626
+
627
+ - **Content-Type**: application/json
628
+ - **Accept**: application/json
629
+
630
+
631
+ ### HTTP response details
632
+ | Status code | Description | Response headers |
633
+ |-------------|-------------|------------------|
634
+ |**201** | Successful Response | - |
635
+ |**422** | Validation Error | - |
636
+
637
+ [[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)
638
+
639
+ # **parseRecipeUrlBulkApiRecipesCreateUrlBulkPost**
640
+ > any parseRecipeUrlBulkApiRecipesCreateUrlBulkPost(createRecipeByUrlBulk)
641
+
642
+ Takes in a URL and attempts to scrape data and load it into the database
643
+
644
+ ### Example
645
+
646
+ ```typescript
647
+ import {
648
+ RecipeCRUDApi,
649
+ Configuration,
650
+ CreateRecipeByUrlBulk
651
+ } from 'mealie-typescript';
652
+
653
+ const configuration = new Configuration();
654
+ const apiInstance = new RecipeCRUDApi(configuration);
655
+
656
+ let createRecipeByUrlBulk: CreateRecipeByUrlBulk; //
657
+ let acceptLanguage: string; // (optional) (default to undefined)
658
+
659
+ const { status, data } = await apiInstance.parseRecipeUrlBulkApiRecipesCreateUrlBulkPost(
660
+ createRecipeByUrlBulk,
661
+ acceptLanguage
662
+ );
663
+ ```
664
+
665
+ ### Parameters
666
+
667
+ |Name | Type | Description | Notes|
668
+ |------------- | ------------- | ------------- | -------------|
669
+ | **createRecipeByUrlBulk** | **CreateRecipeByUrlBulk**| | |
670
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
671
+
672
+
673
+ ### Return type
674
+
675
+ **any**
676
+
677
+ ### Authorization
678
+
679
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
680
+
681
+ ### HTTP request headers
682
+
683
+ - **Content-Type**: application/json
684
+ - **Accept**: application/json
685
+
686
+
687
+ ### HTTP response details
688
+ | Status code | Description | Response headers |
689
+ |-------------|-------------|------------------|
690
+ |**202** | Successful Response | - |
691
+ |**422** | Validation Error | - |
692
+
693
+ [[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)
694
+
695
+ # **patchManyApiRecipesPatch**
696
+ > any patchManyApiRecipesPatch(recipeInput)
697
+
698
+
699
+ ### Example
700
+
701
+ ```typescript
702
+ import {
703
+ RecipeCRUDApi,
704
+ Configuration
705
+ } from 'mealie-typescript';
706
+
707
+ const configuration = new Configuration();
708
+ const apiInstance = new RecipeCRUDApi(configuration);
709
+
710
+ let recipeInput: Array<RecipeInput>; //
711
+ let acceptLanguage: string; // (optional) (default to undefined)
712
+
713
+ const { status, data } = await apiInstance.patchManyApiRecipesPatch(
714
+ recipeInput,
715
+ acceptLanguage
716
+ );
717
+ ```
718
+
719
+ ### Parameters
720
+
721
+ |Name | Type | Description | Notes|
722
+ |------------- | ------------- | ------------- | -------------|
723
+ | **recipeInput** | **Array<RecipeInput>**| | |
724
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
725
+
726
+
727
+ ### Return type
728
+
729
+ **any**
730
+
731
+ ### Authorization
732
+
733
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
734
+
735
+ ### HTTP request headers
736
+
737
+ - **Content-Type**: application/json
738
+ - **Accept**: application/json
739
+
740
+
741
+ ### HTTP response details
742
+ | Status code | Description | Response headers |
743
+ |-------------|-------------|------------------|
744
+ |**200** | Successful Response | - |
745
+ |**422** | Validation Error | - |
746
+
747
+ [[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)
748
+
749
+ # **patchOneApiRecipesSlugPatch**
750
+ > any patchOneApiRecipesSlugPatch(recipeInput)
751
+
752
+ Updates a recipe by existing slug and data.
753
+
754
+ ### Example
755
+
756
+ ```typescript
757
+ import {
758
+ RecipeCRUDApi,
759
+ Configuration,
760
+ RecipeInput
761
+ } from 'mealie-typescript';
762
+
763
+ const configuration = new Configuration();
764
+ const apiInstance = new RecipeCRUDApi(configuration);
765
+
766
+ let slug: string; // (default to undefined)
767
+ let recipeInput: RecipeInput; //
768
+ let acceptLanguage: string; // (optional) (default to undefined)
769
+
770
+ const { status, data } = await apiInstance.patchOneApiRecipesSlugPatch(
771
+ slug,
772
+ recipeInput,
773
+ acceptLanguage
774
+ );
775
+ ```
776
+
777
+ ### Parameters
778
+
779
+ |Name | Type | Description | Notes|
780
+ |------------- | ------------- | ------------- | -------------|
781
+ | **recipeInput** | **RecipeInput**| | |
782
+ | **slug** | [**string**] | | defaults to undefined|
783
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
784
+
785
+
786
+ ### Return type
787
+
788
+ **any**
789
+
790
+ ### Authorization
791
+
792
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
793
+
794
+ ### HTTP request headers
795
+
796
+ - **Content-Type**: application/json
797
+ - **Accept**: application/json
798
+
799
+
800
+ ### HTTP response details
801
+ | Status code | Description | Response headers |
802
+ |-------------|-------------|------------------|
803
+ |**200** | Successful Response | - |
804
+ |**422** | Validation Error | - |
805
+
806
+ [[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)
807
+
808
+ # **scrapeImageUrlApiRecipesSlugImagePost**
809
+ > any scrapeImageUrlApiRecipesSlugImagePost(scrapeRecipe)
810
+
811
+
812
+ ### Example
813
+
814
+ ```typescript
815
+ import {
816
+ RecipeCRUDApi,
817
+ Configuration,
818
+ ScrapeRecipe
819
+ } from 'mealie-typescript';
820
+
821
+ const configuration = new Configuration();
822
+ const apiInstance = new RecipeCRUDApi(configuration);
823
+
824
+ let slug: string; // (default to undefined)
825
+ let scrapeRecipe: ScrapeRecipe; //
826
+ let acceptLanguage: string; // (optional) (default to undefined)
827
+
828
+ const { status, data } = await apiInstance.scrapeImageUrlApiRecipesSlugImagePost(
829
+ slug,
830
+ scrapeRecipe,
831
+ acceptLanguage
832
+ );
833
+ ```
834
+
835
+ ### Parameters
836
+
837
+ |Name | Type | Description | Notes|
838
+ |------------- | ------------- | ------------- | -------------|
839
+ | **scrapeRecipe** | **ScrapeRecipe**| | |
840
+ | **slug** | [**string**] | | defaults to undefined|
841
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
842
+
843
+
844
+ ### Return type
845
+
846
+ **any**
847
+
848
+ ### Authorization
849
+
850
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
851
+
852
+ ### HTTP request headers
853
+
854
+ - **Content-Type**: application/json
855
+ - **Accept**: application/json
856
+
857
+
858
+ ### HTTP response details
859
+ | Status code | Description | Response headers |
860
+ |-------------|-------------|------------------|
861
+ |**200** | Successful Response | - |
862
+ |**422** | Validation Error | - |
863
+
864
+ [[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)
865
+
866
+ # **suggestRecipesApiRecipesSuggestionsGet**
867
+ > RecipeSuggestionResponse suggestRecipesApiRecipesSuggestionsGet()
868
+
869
+
870
+ ### Example
871
+
872
+ ```typescript
873
+ import {
874
+ RecipeCRUDApi,
875
+ Configuration
876
+ } from 'mealie-typescript';
877
+
878
+ const configuration = new Configuration();
879
+ const apiInstance = new RecipeCRUDApi(configuration);
880
+
881
+ let foods: Array<string>; // (optional) (default to undefined)
882
+ let tools: Array<string>; // (optional) (default to undefined)
883
+ let orderBy: string; // (optional) (default to undefined)
884
+ let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
885
+ let orderDirection: OrderDirection; // (optional) (default to undefined)
886
+ let queryFilter: string; // (optional) (default to undefined)
887
+ let paginationSeed: string; // (optional) (default to undefined)
888
+ let limit: number; // (optional) (default to 10)
889
+ let maxMissingFoods: number; // (optional) (default to 5)
890
+ let maxMissingTools: number; // (optional) (default to 5)
891
+ let includeFoodsOnHand: boolean; // (optional) (default to true)
892
+ let includeToolsOnHand: boolean; // (optional) (default to true)
893
+ let acceptLanguage: string; // (optional) (default to undefined)
894
+
895
+ const { status, data } = await apiInstance.suggestRecipesApiRecipesSuggestionsGet(
896
+ foods,
897
+ tools,
898
+ orderBy,
899
+ orderByNullPosition,
900
+ orderDirection,
901
+ queryFilter,
902
+ paginationSeed,
903
+ limit,
904
+ maxMissingFoods,
905
+ maxMissingTools,
906
+ includeFoodsOnHand,
907
+ includeToolsOnHand,
908
+ acceptLanguage
909
+ );
910
+ ```
911
+
912
+ ### Parameters
913
+
914
+ |Name | Type | Description | Notes|
915
+ |------------- | ------------- | ------------- | -------------|
916
+ | **foods** | **Array&lt;string&gt;** | | (optional) defaults to undefined|
917
+ | **tools** | **Array&lt;string&gt;** | | (optional) defaults to undefined|
918
+ | **orderBy** | [**string**] | | (optional) defaults to undefined|
919
+ | **orderByNullPosition** | **OrderByNullPosition** | | (optional) defaults to undefined|
920
+ | **orderDirection** | **OrderDirection** | | (optional) defaults to undefined|
921
+ | **queryFilter** | [**string**] | | (optional) defaults to undefined|
922
+ | **paginationSeed** | [**string**] | | (optional) defaults to undefined|
923
+ | **limit** | [**number**] | | (optional) defaults to 10|
924
+ | **maxMissingFoods** | [**number**] | | (optional) defaults to 5|
925
+ | **maxMissingTools** | [**number**] | | (optional) defaults to 5|
926
+ | **includeFoodsOnHand** | [**boolean**] | | (optional) defaults to true|
927
+ | **includeToolsOnHand** | [**boolean**] | | (optional) defaults to true|
928
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
929
+
930
+
931
+ ### Return type
932
+
933
+ **RecipeSuggestionResponse**
934
+
935
+ ### Authorization
936
+
937
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
938
+
939
+ ### HTTP request headers
940
+
941
+ - **Content-Type**: Not defined
942
+ - **Accept**: application/json
943
+
944
+
945
+ ### HTTP response details
946
+ | Status code | Description | Response headers |
947
+ |-------------|-------------|------------------|
948
+ |**200** | Successful Response | - |
949
+ |**422** | Validation Error | - |
950
+
951
+ [[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)
952
+
953
+ # **testParseRecipeUrlApiRecipesTestScrapeUrlPost**
954
+ > any testParseRecipeUrlApiRecipesTestScrapeUrlPost(scrapeRecipeTest)
955
+
956
+
957
+ ### Example
958
+
959
+ ```typescript
960
+ import {
961
+ RecipeCRUDApi,
962
+ Configuration,
963
+ ScrapeRecipeTest
964
+ } from 'mealie-typescript';
965
+
966
+ const configuration = new Configuration();
967
+ const apiInstance = new RecipeCRUDApi(configuration);
968
+
969
+ let scrapeRecipeTest: ScrapeRecipeTest; //
970
+ let acceptLanguage: string; // (optional) (default to undefined)
971
+
972
+ const { status, data } = await apiInstance.testParseRecipeUrlApiRecipesTestScrapeUrlPost(
973
+ scrapeRecipeTest,
974
+ acceptLanguage
975
+ );
976
+ ```
977
+
978
+ ### Parameters
979
+
980
+ |Name | Type | Description | Notes|
981
+ |------------- | ------------- | ------------- | -------------|
982
+ | **scrapeRecipeTest** | **ScrapeRecipeTest**| | |
983
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
984
+
985
+
986
+ ### Return type
987
+
988
+ **any**
989
+
990
+ ### Authorization
991
+
992
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
993
+
994
+ ### HTTP request headers
995
+
996
+ - **Content-Type**: application/json
997
+ - **Accept**: application/json
998
+
999
+
1000
+ ### HTTP response details
1001
+ | Status code | Description | Response headers |
1002
+ |-------------|-------------|------------------|
1003
+ |**200** | Successful Response | - |
1004
+ |**422** | Validation Error | - |
1005
+
1006
+ [[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)
1007
+
1008
+ # **updateLastMadeApiRecipesSlugLastMadePatch**
1009
+ > any updateLastMadeApiRecipesSlugLastMadePatch(recipeLastMade)
1010
+
1011
+ Update a recipe\'s last made timestamp
1012
+
1013
+ ### Example
1014
+
1015
+ ```typescript
1016
+ import {
1017
+ RecipeCRUDApi,
1018
+ Configuration,
1019
+ RecipeLastMade
1020
+ } from 'mealie-typescript';
1021
+
1022
+ const configuration = new Configuration();
1023
+ const apiInstance = new RecipeCRUDApi(configuration);
1024
+
1025
+ let slug: string; // (default to undefined)
1026
+ let recipeLastMade: RecipeLastMade; //
1027
+ let acceptLanguage: string; // (optional) (default to undefined)
1028
+
1029
+ const { status, data } = await apiInstance.updateLastMadeApiRecipesSlugLastMadePatch(
1030
+ slug,
1031
+ recipeLastMade,
1032
+ acceptLanguage
1033
+ );
1034
+ ```
1035
+
1036
+ ### Parameters
1037
+
1038
+ |Name | Type | Description | Notes|
1039
+ |------------- | ------------- | ------------- | -------------|
1040
+ | **recipeLastMade** | **RecipeLastMade**| | |
1041
+ | **slug** | [**string**] | | defaults to undefined|
1042
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
1043
+
1044
+
1045
+ ### Return type
1046
+
1047
+ **any**
1048
+
1049
+ ### Authorization
1050
+
1051
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
1052
+
1053
+ ### HTTP request headers
1054
+
1055
+ - **Content-Type**: application/json
1056
+ - **Accept**: application/json
1057
+
1058
+
1059
+ ### HTTP response details
1060
+ | Status code | Description | Response headers |
1061
+ |-------------|-------------|------------------|
1062
+ |**200** | Successful Response | - |
1063
+ |**422** | Validation Error | - |
1064
+
1065
+ [[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)
1066
+
1067
+ # **updateManyApiRecipesPut**
1068
+ > any updateManyApiRecipesPut(recipeInput)
1069
+
1070
+
1071
+ ### Example
1072
+
1073
+ ```typescript
1074
+ import {
1075
+ RecipeCRUDApi,
1076
+ Configuration
1077
+ } from 'mealie-typescript';
1078
+
1079
+ const configuration = new Configuration();
1080
+ const apiInstance = new RecipeCRUDApi(configuration);
1081
+
1082
+ let recipeInput: Array<RecipeInput>; //
1083
+ let acceptLanguage: string; // (optional) (default to undefined)
1084
+
1085
+ const { status, data } = await apiInstance.updateManyApiRecipesPut(
1086
+ recipeInput,
1087
+ acceptLanguage
1088
+ );
1089
+ ```
1090
+
1091
+ ### Parameters
1092
+
1093
+ |Name | Type | Description | Notes|
1094
+ |------------- | ------------- | ------------- | -------------|
1095
+ | **recipeInput** | **Array<RecipeInput>**| | |
1096
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
1097
+
1098
+
1099
+ ### Return type
1100
+
1101
+ **any**
1102
+
1103
+ ### Authorization
1104
+
1105
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
1106
+
1107
+ ### HTTP request headers
1108
+
1109
+ - **Content-Type**: application/json
1110
+ - **Accept**: application/json
1111
+
1112
+
1113
+ ### HTTP response details
1114
+ | Status code | Description | Response headers |
1115
+ |-------------|-------------|------------------|
1116
+ |**200** | Successful Response | - |
1117
+ |**422** | Validation Error | - |
1118
+
1119
+ [[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)
1120
+
1121
+ # **updateOneApiRecipesSlugPut**
1122
+ > any updateOneApiRecipesSlugPut(recipeInput)
1123
+
1124
+ Updates a recipe by existing slug and data.
1125
+
1126
+ ### Example
1127
+
1128
+ ```typescript
1129
+ import {
1130
+ RecipeCRUDApi,
1131
+ Configuration,
1132
+ RecipeInput
1133
+ } from 'mealie-typescript';
1134
+
1135
+ const configuration = new Configuration();
1136
+ const apiInstance = new RecipeCRUDApi(configuration);
1137
+
1138
+ let slug: string; // (default to undefined)
1139
+ let recipeInput: RecipeInput; //
1140
+ let acceptLanguage: string; // (optional) (default to undefined)
1141
+
1142
+ const { status, data } = await apiInstance.updateOneApiRecipesSlugPut(
1143
+ slug,
1144
+ recipeInput,
1145
+ acceptLanguage
1146
+ );
1147
+ ```
1148
+
1149
+ ### Parameters
1150
+
1151
+ |Name | Type | Description | Notes|
1152
+ |------------- | ------------- | ------------- | -------------|
1153
+ | **recipeInput** | **RecipeInput**| | |
1154
+ | **slug** | [**string**] | | defaults to undefined|
1155
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
1156
+
1157
+
1158
+ ### Return type
1159
+
1160
+ **any**
1161
+
1162
+ ### Authorization
1163
+
1164
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
1165
+
1166
+ ### HTTP request headers
1167
+
1168
+ - **Content-Type**: application/json
1169
+ - **Accept**: application/json
1170
+
1171
+
1172
+ ### HTTP response details
1173
+ | Status code | Description | Response headers |
1174
+ |-------------|-------------|------------------|
1175
+ |**200** | Successful Response | - |
1176
+ |**422** | Validation Error | - |
1177
+
1178
+ [[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)
1179
+
1180
+ # **updateRecipeImageApiRecipesSlugImagePut**
1181
+ > UpdateImageResponse updateRecipeImageApiRecipesSlugImagePut()
1182
+
1183
+
1184
+ ### Example
1185
+
1186
+ ```typescript
1187
+ import {
1188
+ RecipeCRUDApi,
1189
+ Configuration
1190
+ } from 'mealie-typescript';
1191
+
1192
+ const configuration = new Configuration();
1193
+ const apiInstance = new RecipeCRUDApi(configuration);
1194
+
1195
+ let slug: string; // (default to undefined)
1196
+ let image: File; // (default to undefined)
1197
+ let extension: string; // (default to undefined)
1198
+ let acceptLanguage: string; // (optional) (default to undefined)
1199
+
1200
+ const { status, data } = await apiInstance.updateRecipeImageApiRecipesSlugImagePut(
1201
+ slug,
1202
+ image,
1203
+ extension,
1204
+ acceptLanguage
1205
+ );
1206
+ ```
1207
+
1208
+ ### Parameters
1209
+
1210
+ |Name | Type | Description | Notes|
1211
+ |------------- | ------------- | ------------- | -------------|
1212
+ | **slug** | [**string**] | | defaults to undefined|
1213
+ | **image** | [**File**] | | defaults to undefined|
1214
+ | **extension** | [**string**] | | defaults to undefined|
1215
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
1216
+
1217
+
1218
+ ### Return type
1219
+
1220
+ **UpdateImageResponse**
1221
+
1222
+ ### Authorization
1223
+
1224
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
1225
+
1226
+ ### HTTP request headers
1227
+
1228
+ - **Content-Type**: multipart/form-data
1229
+ - **Accept**: application/json
1230
+
1231
+
1232
+ ### HTTP response details
1233
+ | Status code | Description | Response headers |
1234
+ |-------------|-------------|------------------|
1235
+ |**200** | Successful Response | - |
1236
+ |**422** | Validation Error | - |
1237
+
1238
+ [[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)
1239
+
1240
+ # **uploadRecipeAssetApiRecipesSlugAssetsPost**
1241
+ > RecipeAsset uploadRecipeAssetApiRecipesSlugAssetsPost()
1242
+
1243
+ Upload a file to store as a recipe asset
1244
+
1245
+ ### Example
1246
+
1247
+ ```typescript
1248
+ import {
1249
+ RecipeCRUDApi,
1250
+ Configuration
1251
+ } from 'mealie-typescript';
1252
+
1253
+ const configuration = new Configuration();
1254
+ const apiInstance = new RecipeCRUDApi(configuration);
1255
+
1256
+ let slug: string; // (default to undefined)
1257
+ let name: string; // (default to undefined)
1258
+ let icon: string; // (default to undefined)
1259
+ let extension: string; // (default to undefined)
1260
+ let file: File; // (default to undefined)
1261
+ let acceptLanguage: string; // (optional) (default to undefined)
1262
+
1263
+ const { status, data } = await apiInstance.uploadRecipeAssetApiRecipesSlugAssetsPost(
1264
+ slug,
1265
+ name,
1266
+ icon,
1267
+ extension,
1268
+ file,
1269
+ acceptLanguage
1270
+ );
1271
+ ```
1272
+
1273
+ ### Parameters
1274
+
1275
+ |Name | Type | Description | Notes|
1276
+ |------------- | ------------- | ------------- | -------------|
1277
+ | **slug** | [**string**] | | defaults to undefined|
1278
+ | **name** | [**string**] | | defaults to undefined|
1279
+ | **icon** | [**string**] | | defaults to undefined|
1280
+ | **extension** | [**string**] | | defaults to undefined|
1281
+ | **file** | [**File**] | | defaults to undefined|
1282
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
1283
+
1284
+
1285
+ ### Return type
1286
+
1287
+ **RecipeAsset**
1288
+
1289
+ ### Authorization
1290
+
1291
+ [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
1292
+
1293
+ ### HTTP request headers
1294
+
1295
+ - **Content-Type**: multipart/form-data
1296
+ - **Accept**: application/json
1297
+
1298
+
1299
+ ### HTTP response details
1300
+ | Status code | Description | Response headers |
1301
+ |-------------|-------------|------------------|
1302
+ |**200** | Successful Response | - |
1303
+ |**422** | Validation Error | - |
1304
+
1305
+ [[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)
1306
+