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
package/index.ts ADDED
@@ -0,0 +1,18 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Mealie
5
+ * Mealie is a web application for managing your recipes, meal plans, and shopping lists. This is the Restful API interactive documentation that can be used to explore the API. If you\'re justing getting started with the API and want to get started quickly, you can use the [API Usage | Mealie Docs](https://docs.mealie.io/documentation/getting-started/api-usage/) as a reference for how to get started. If you have any questions or comments about mealie, please use the discord server to talk to the developers or other community members. If you\'d like to file an issue, please use the [GitHub Issue Tracker | Mealie](https://github.com/mealie-recipes/mealie/issues/new/choose) ## Helpful Links - [Home Page](https://mealie.io) - [Documentation](https://docs.mealie.io) - [Discord](https://discord.gg/QuStdQGSGK) - [Demo](https://demo.mealie.io)
6
+ *
7
+ * The version of the OpenAPI document: nightly
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ export * from "./api";
17
+ export * from "./configuration";
18
+
package/package.json ADDED
@@ -0,0 +1,31 @@
1
+ {
2
+ "name": "mealie-typescript",
3
+ "version": "1.0.0",
4
+ "description": "OpenAPI client for mealie-typescript",
5
+ "author": "OpenAPI-Generator Contributors",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
9
+ },
10
+ "keywords": [
11
+ "axios",
12
+ "typescript",
13
+ "openapi-client",
14
+ "openapi-generator",
15
+ "mealie-typescript"
16
+ ],
17
+ "license": "Unlicense",
18
+ "main": "./dist/index.js",
19
+ "typings": "./dist/index.d.ts",
20
+ "scripts": {
21
+ "build": "tsc",
22
+ "prepare": "npm run build"
23
+ },
24
+ "dependencies": {
25
+ "axios": "^1.6.1"
26
+ },
27
+ "devDependencies": {
28
+ "@types/node": "12.11.5 - 12.20.42",
29
+ "typescript": "^4.0 || ^5.0"
30
+ }
31
+ }
package/tsconfig.json ADDED
@@ -0,0 +1,21 @@
1
+ {
2
+ "compilerOptions": {
3
+ "declaration": true,
4
+ "target": "ES5",
5
+ "module": "commonjs",
6
+ "noImplicitAny": true,
7
+ "outDir": "dist",
8
+ "rootDir": ".",
9
+ "lib": [
10
+ "es2017",
11
+ "dom"
12
+ ],
13
+ "typeRoots": [
14
+ "node_modules/@types"
15
+ ]
16
+ },
17
+ "exclude": [
18
+ "dist",
19
+ "node_modules"
20
+ ]
21
+ }