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,266 @@
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&lt;GetAllApiRecipesGetTagsParameterInner&gt;** | | (optional) defaults to undefined|
78
+ | **tags** | **Array&lt;GetAllApiRecipesGetTagsParameterInner&gt;** | | (optional) defaults to undefined|
79
+ | **tools** | **Array&lt;GetAllApiRecipesGetTagsParameterInner&gt;** | | (optional) defaults to undefined|
80
+ | **foods** | **Array&lt;GetAllApiRecipesGetTagsParameterInner&gt;** | | (optional) defaults to undefined|
81
+ | **households** | **Array&lt;GetAllApiRecipesGetTagsParameterInner&gt;** | | (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&lt;string&gt;** | | (optional) defaults to undefined|
231
+ | **tools** | **Array&lt;string&gt;** | | (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
+
@@ -0,0 +1,144 @@
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
+
@@ -0,0 +1,144 @@
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
+
@@ -0,0 +1,22 @@
1
+ # ExportRecipes
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **recipes** | **Array&lt;string&gt;** | | [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)
@@ -0,0 +1,8 @@
1
+ # ExportTypes
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Json` (value: `'json'`)
7
+
8
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
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 ADDED
@@ -0,0 +1,40 @@
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&lt;CreateIngredientFoodAlias&gt;**](CreateIngredientFoodAlias.md) | | [optional] [default to undefined]
15
+ **householdsWithIngredientFood** | **Array&lt;string&gt;** | | [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 ADDED
@@ -0,0 +1,40 @@
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&lt;CreateIngredientFoodAlias&gt;**](CreateIngredientFoodAlias.md) | | [optional] [default to undefined]
15
+ **householdsWithIngredientFood** | **Array&lt;string&gt;** | | [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)