mealie-typescript 1.0.0 → 1.0.5

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.
@@ -1,6 +1,5 @@
1
1
  .gitignore
2
2
  .npmignore
3
- README.md
4
3
  api.ts
5
4
  base.ts
6
5
  common.ts
@@ -300,7 +299,5 @@ docs/ValidationErrorLocInner.md
300
299
  docs/Value.md
301
300
  docs/WebhookPagination.md
302
301
  docs/WebhookType.md
303
- git_push.sh
304
302
  index.ts
305
303
  package.json
306
- tsconfig.json
@@ -21,4 +21,6 @@
21
21
  #docs/*.md
22
22
  # Then explicitly reverse the ignore rule for a single file:
23
23
  #!docs/README.md
24
- tsconfig.json
24
+ tsconfig.json
25
+ README.md
26
+ git_push.sh
package/README.md CHANGED
@@ -1,564 +1,79 @@
1
- ## mealie-typescript@nightly
1
+ # mealie-typescript
2
2
 
3
- This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
3
+ TypeScript/JavaScript client for the [Mealie](https://mealie.io) API.
4
4
 
5
- Environment
6
- * Node.js
7
- * Webpack
8
- * Browserify
5
+ ## Installation
9
6
 
10
- Language level
11
- * ES5 - you must have a Promises/A+ library installed
12
- * ES6
13
-
14
- Module system
15
- * CommonJS
16
- * ES6 module system
17
-
18
- It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
19
-
20
- ### Building
21
-
22
- To build and compile the typescript sources to javascript use:
23
- ```
24
- npm install
25
- npm run build
7
+ ```bash
8
+ npm install mealie-typescript
26
9
  ```
27
10
 
28
- ### Publishing
11
+ ## Usage
29
12
 
30
- First build the package then run `npm publish`
13
+ ```typescript
14
+ import { Configuration, RecipeCRUDApi } from 'mealie-typescript';
31
15
 
32
- ### Consuming
16
+ const config = new Configuration({
17
+ basePath: 'https://your-mealie-instance.com',
18
+ accessToken: 'your-api-token',
19
+ });
33
20
 
34
- navigate to the folder of your consuming project and run one of the following commands.
21
+ const recipesApi = new RecipeCRUDApi(config);
35
22
 
36
- _published:_
23
+ // Get all recipes
24
+ const recipes = await recipesApi.getAllApiRecipesGet();
25
+ console.log(recipes.data);
37
26
 
38
- ```
39
- npm install mealie-typescript@nightly --save
27
+ // Get a specific recipe
28
+ const recipe = await recipesApi.getOneApiRecipesSlugGet('my-recipe-slug');
29
+ console.log(recipe.data);
40
30
  ```
41
31
 
42
- _unPublished (not recommended):_
32
+ ### Authentication
43
33
 
44
- ```
45
- npm install PATH_TO_GENERATED_PACKAGE --save
46
- ```
34
+ Mealie uses OAuth2 password flow. You can obtain a token using the `UsersAuthenticationApi`:
47
35
 
48
- ### Documentation for API Endpoints
36
+ ```typescript
37
+ import { Configuration, UsersAuthenticationApi } from 'mealie-typescript';
49
38
 
50
- All URIs are relative to *http://localhost*
39
+ const authApi = new UsersAuthenticationApi(new Configuration({
40
+ basePath: 'https://your-mealie-instance.com',
41
+ }));
51
42
 
52
- Class | Method | HTTP request | Description
53
- ------------ | ------------- | ------------- | -------------
54
- *AdminAboutApi* | [**checkAppConfigApiAdminAboutCheckGet**](docs/AdminAboutApi.md#checkappconfigapiadminaboutcheckget) | **GET** /api/admin/about/check | Check App Config
55
- *AdminAboutApi* | [**getAppInfoApiAdminAboutGet**](docs/AdminAboutApi.md#getappinfoapiadminaboutget) | **GET** /api/admin/about | Get App Info
56
- *AdminAboutApi* | [**getAppStatisticsApiAdminAboutStatisticsGet**](docs/AdminAboutApi.md#getappstatisticsapiadminaboutstatisticsget) | **GET** /api/admin/about/statistics | Get App Statistics
57
- *AdminBackupsApi* | [**createOneApiAdminBackupsPost**](docs/AdminBackupsApi.md#createoneapiadminbackupspost) | **POST** /api/admin/backups | Create One
58
- *AdminBackupsApi* | [**deleteOneApiAdminBackupsFileNameDelete**](docs/AdminBackupsApi.md#deleteoneapiadminbackupsfilenamedelete) | **DELETE** /api/admin/backups/{file_name} | Delete One
59
- *AdminBackupsApi* | [**getAllApiAdminBackupsGet**](docs/AdminBackupsApi.md#getallapiadminbackupsget) | **GET** /api/admin/backups | Get All
60
- *AdminBackupsApi* | [**getOneApiAdminBackupsFileNameGet**](docs/AdminBackupsApi.md#getoneapiadminbackupsfilenameget) | **GET** /api/admin/backups/{file_name} | Get One
61
- *AdminBackupsApi* | [**importOneApiAdminBackupsFileNameRestorePost**](docs/AdminBackupsApi.md#importoneapiadminbackupsfilenamerestorepost) | **POST** /api/admin/backups/{file_name}/restore | Import One
62
- *AdminBackupsApi* | [**uploadOneApiAdminBackupsUploadPost**](docs/AdminBackupsApi.md#uploadoneapiadminbackupsuploadpost) | **POST** /api/admin/backups/upload | Upload One
63
- *AdminDebugApi* | [**debugOpenaiApiAdminDebugOpenaiPost**](docs/AdminDebugApi.md#debugopenaiapiadmindebugopenaipost) | **POST** /api/admin/debug/openai | Debug Openai
64
- *AdminEmailApi* | [**checkEmailConfigApiAdminEmailGet**](docs/AdminEmailApi.md#checkemailconfigapiadminemailget) | **GET** /api/admin/email | Check Email Config
65
- *AdminEmailApi* | [**sendTestEmailApiAdminEmailPost**](docs/AdminEmailApi.md#sendtestemailapiadminemailpost) | **POST** /api/admin/email | Send Test Email
66
- *AdminMaintenanceApi* | [**cleanImagesApiAdminMaintenanceCleanImagesPost**](docs/AdminMaintenanceApi.md#cleanimagesapiadminmaintenancecleanimagespost) | **POST** /api/admin/maintenance/clean/images | Clean Images
67
- *AdminMaintenanceApi* | [**cleanRecipeFoldersApiAdminMaintenanceCleanRecipeFoldersPost**](docs/AdminMaintenanceApi.md#cleanrecipefoldersapiadminmaintenancecleanrecipefolderspost) | **POST** /api/admin/maintenance/clean/recipe-folders | Clean Recipe Folders
68
- *AdminMaintenanceApi* | [**cleanTempApiAdminMaintenanceCleanTempPost**](docs/AdminMaintenanceApi.md#cleantempapiadminmaintenancecleantemppost) | **POST** /api/admin/maintenance/clean/temp | Clean Temp
69
- *AdminMaintenanceApi* | [**getMaintenanceSummaryApiAdminMaintenanceGet**](docs/AdminMaintenanceApi.md#getmaintenancesummaryapiadminmaintenanceget) | **GET** /api/admin/maintenance | Get Maintenance Summary
70
- *AdminMaintenanceApi* | [**getStorageDetailsApiAdminMaintenanceStorageGet**](docs/AdminMaintenanceApi.md#getstoragedetailsapiadminmaintenancestorageget) | **GET** /api/admin/maintenance/storage | Get Storage Details
71
- *AdminManageGroupsApi* | [**createOneApiAdminGroupsPost**](docs/AdminManageGroupsApi.md#createoneapiadmingroupspost) | **POST** /api/admin/groups | Create One
72
- *AdminManageGroupsApi* | [**deleteOneApiAdminGroupsItemIdDelete**](docs/AdminManageGroupsApi.md#deleteoneapiadmingroupsitemiddelete) | **DELETE** /api/admin/groups/{item_id} | Delete One
73
- *AdminManageGroupsApi* | [**getAllApiAdminGroupsGet**](docs/AdminManageGroupsApi.md#getallapiadmingroupsget) | **GET** /api/admin/groups | Get All
74
- *AdminManageGroupsApi* | [**getOneApiAdminGroupsItemIdGet**](docs/AdminManageGroupsApi.md#getoneapiadmingroupsitemidget) | **GET** /api/admin/groups/{item_id} | Get One
75
- *AdminManageGroupsApi* | [**updateOneApiAdminGroupsItemIdPut**](docs/AdminManageGroupsApi.md#updateoneapiadmingroupsitemidput) | **PUT** /api/admin/groups/{item_id} | Update One
76
- *AdminManageHouseholdsApi* | [**createOneApiAdminHouseholdsPost**](docs/AdminManageHouseholdsApi.md#createoneapiadminhouseholdspost) | **POST** /api/admin/households | Create One
77
- *AdminManageHouseholdsApi* | [**deleteOneApiAdminHouseholdsItemIdDelete**](docs/AdminManageHouseholdsApi.md#deleteoneapiadminhouseholdsitemiddelete) | **DELETE** /api/admin/households/{item_id} | Delete One
78
- *AdminManageHouseholdsApi* | [**getAllApiAdminHouseholdsGet**](docs/AdminManageHouseholdsApi.md#getallapiadminhouseholdsget) | **GET** /api/admin/households | Get All
79
- *AdminManageHouseholdsApi* | [**getOneApiAdminHouseholdsItemIdGet**](docs/AdminManageHouseholdsApi.md#getoneapiadminhouseholdsitemidget) | **GET** /api/admin/households/{item_id} | Get One
80
- *AdminManageHouseholdsApi* | [**updateOneApiAdminHouseholdsItemIdPut**](docs/AdminManageHouseholdsApi.md#updateoneapiadminhouseholdsitemidput) | **PUT** /api/admin/households/{item_id} | Update One
81
- *AdminManageUsersApi* | [**createOneApiAdminUsersPost**](docs/AdminManageUsersApi.md#createoneapiadminuserspost) | **POST** /api/admin/users | Create One
82
- *AdminManageUsersApi* | [**deleteOneApiAdminUsersItemIdDelete**](docs/AdminManageUsersApi.md#deleteoneapiadminusersitemiddelete) | **DELETE** /api/admin/users/{item_id} | Delete One
83
- *AdminManageUsersApi* | [**generateTokenApiAdminUsersPasswordResetTokenPost**](docs/AdminManageUsersApi.md#generatetokenapiadminuserspasswordresettokenpost) | **POST** /api/admin/users/password-reset-token | Generate Token
84
- *AdminManageUsersApi* | [**getAllApiAdminUsersGet**](docs/AdminManageUsersApi.md#getallapiadminusersget) | **GET** /api/admin/users | Get All
85
- *AdminManageUsersApi* | [**getOneApiAdminUsersItemIdGet**](docs/AdminManageUsersApi.md#getoneapiadminusersitemidget) | **GET** /api/admin/users/{item_id} | Get One
86
- *AdminManageUsersApi* | [**unlockUsersApiAdminUsersUnlockPost**](docs/AdminManageUsersApi.md#unlockusersapiadminusersunlockpost) | **POST** /api/admin/users/unlock | Unlock Users
87
- *AdminManageUsersApi* | [**updateOneApiAdminUsersItemIdPut**](docs/AdminManageUsersApi.md#updateoneapiadminusersitemidput) | **PUT** /api/admin/users/{item_id} | Update One
88
- *AppAboutApi* | [**getAppInfoApiAppAboutGet**](docs/AppAboutApi.md#getappinfoapiappaboutget) | **GET** /api/app/about | Get App Info
89
- *AppAboutApi* | [**getAppThemeApiAppAboutThemeGet**](docs/AppAboutApi.md#getappthemeapiappaboutthemeget) | **GET** /api/app/about/theme | Get App Theme
90
- *AppAboutApi* | [**getStartupInfoApiAppAboutStartupInfoGet**](docs/AppAboutApi.md#getstartupinfoapiappaboutstartupinfoget) | **GET** /api/app/about/startup-info | Get Startup Info
91
- *ExploreCategoriesApi* | [**getAllApiExploreGroupsGroupSlugOrganizersCategoriesGet**](docs/ExploreCategoriesApi.md#getallapiexploregroupsgroupslugorganizerscategoriesget) | **GET** /api/explore/groups/{group_slug}/organizers/categories | Get All
92
- *ExploreCategoriesApi* | [**getOneApiExploreGroupsGroupSlugOrganizersCategoriesItemIdGet**](docs/ExploreCategoriesApi.md#getoneapiexploregroupsgroupslugorganizerscategoriesitemidget) | **GET** /api/explore/groups/{group_slug}/organizers/categories/{item_id} | Get One
93
- *ExploreCookbooksApi* | [**getAllApiExploreGroupsGroupSlugCookbooksGet**](docs/ExploreCookbooksApi.md#getallapiexploregroupsgroupslugcookbooksget) | **GET** /api/explore/groups/{group_slug}/cookbooks | Get All
94
- *ExploreCookbooksApi* | [**getOneApiExploreGroupsGroupSlugCookbooksItemIdGet**](docs/ExploreCookbooksApi.md#getoneapiexploregroupsgroupslugcookbooksitemidget) | **GET** /api/explore/groups/{group_slug}/cookbooks/{item_id} | Get One
95
- *ExploreFoodsApi* | [**getAllApiExploreGroupsGroupSlugFoodsGet**](docs/ExploreFoodsApi.md#getallapiexploregroupsgroupslugfoodsget) | **GET** /api/explore/groups/{group_slug}/foods | Get All
96
- *ExploreFoodsApi* | [**getOneApiExploreGroupsGroupSlugFoodsItemIdGet**](docs/ExploreFoodsApi.md#getoneapiexploregroupsgroupslugfoodsitemidget) | **GET** /api/explore/groups/{group_slug}/foods/{item_id} | Get One
97
- *ExploreHouseholdsApi* | [**getAllApiExploreGroupsGroupSlugHouseholdsGet**](docs/ExploreHouseholdsApi.md#getallapiexploregroupsgroupslughouseholdsget) | **GET** /api/explore/groups/{group_slug}/households | Get All
98
- *ExploreHouseholdsApi* | [**getHouseholdApiExploreGroupsGroupSlugHouseholdsHouseholdSlugGet**](docs/ExploreHouseholdsApi.md#gethouseholdapiexploregroupsgroupslughouseholdshouseholdslugget) | **GET** /api/explore/groups/{group_slug}/households/{household_slug} | Get Household
99
- *ExploreRecipesApi* | [**getAllApiExploreGroupsGroupSlugRecipesGet**](docs/ExploreRecipesApi.md#getallapiexploregroupsgroupslugrecipesget) | **GET** /api/explore/groups/{group_slug}/recipes | Get All
100
- *ExploreRecipesApi* | [**getRecipeApiExploreGroupsGroupSlugRecipesRecipeSlugGet**](docs/ExploreRecipesApi.md#getrecipeapiexploregroupsgroupslugrecipesrecipeslugget) | **GET** /api/explore/groups/{group_slug}/recipes/{recipe_slug} | Get Recipe
101
- *ExploreRecipesApi* | [**suggestRecipesApiExploreGroupsGroupSlugRecipesSuggestionsGet**](docs/ExploreRecipesApi.md#suggestrecipesapiexploregroupsgroupslugrecipessuggestionsget) | **GET** /api/explore/groups/{group_slug}/recipes/suggestions | Suggest Recipes
102
- *ExploreTagsApi* | [**getAllApiExploreGroupsGroupSlugOrganizersTagsGet**](docs/ExploreTagsApi.md#getallapiexploregroupsgroupslugorganizerstagsget) | **GET** /api/explore/groups/{group_slug}/organizers/tags | Get All
103
- *ExploreTagsApi* | [**getOneApiExploreGroupsGroupSlugOrganizersTagsItemIdGet**](docs/ExploreTagsApi.md#getoneapiexploregroupsgroupslugorganizerstagsitemidget) | **GET** /api/explore/groups/{group_slug}/organizers/tags/{item_id} | Get One
104
- *ExploreToolsApi* | [**getAllApiExploreGroupsGroupSlugOrganizersToolsGet**](docs/ExploreToolsApi.md#getallapiexploregroupsgroupslugorganizerstoolsget) | **GET** /api/explore/groups/{group_slug}/organizers/tools | Get All
105
- *ExploreToolsApi* | [**getOneApiExploreGroupsGroupSlugOrganizersToolsItemIdGet**](docs/ExploreToolsApi.md#getoneapiexploregroupsgroupslugorganizerstoolsitemidget) | **GET** /api/explore/groups/{group_slug}/organizers/tools/{item_id} | Get One
106
- *GroupsHouseholdsApi* | [**getAllHouseholdsApiGroupsHouseholdsGet**](docs/GroupsHouseholdsApi.md#getallhouseholdsapigroupshouseholdsget) | **GET** /api/groups/households | Get All Households
107
- *GroupsHouseholdsApi* | [**getOneHouseholdApiGroupsHouseholdsHouseholdSlugGet**](docs/GroupsHouseholdsApi.md#getonehouseholdapigroupshouseholdshouseholdslugget) | **GET** /api/groups/households/{household_slug} | Get One Household
108
- *GroupsMigrationsApi* | [**startDataMigrationApiGroupsMigrationsPost**](docs/GroupsMigrationsApi.md#startdatamigrationapigroupsmigrationspost) | **POST** /api/groups/migrations | Start Data Migration
109
- *GroupsMultiPurposeLabelsApi* | [**createOneApiGroupsLabelsPost**](docs/GroupsMultiPurposeLabelsApi.md#createoneapigroupslabelspost) | **POST** /api/groups/labels | Create One
110
- *GroupsMultiPurposeLabelsApi* | [**deleteOneApiGroupsLabelsItemIdDelete**](docs/GroupsMultiPurposeLabelsApi.md#deleteoneapigroupslabelsitemiddelete) | **DELETE** /api/groups/labels/{item_id} | Delete One
111
- *GroupsMultiPurposeLabelsApi* | [**getAllApiGroupsLabelsGet**](docs/GroupsMultiPurposeLabelsApi.md#getallapigroupslabelsget) | **GET** /api/groups/labels | Get All
112
- *GroupsMultiPurposeLabelsApi* | [**getOneApiGroupsLabelsItemIdGet**](docs/GroupsMultiPurposeLabelsApi.md#getoneapigroupslabelsitemidget) | **GET** /api/groups/labels/{item_id} | Get One
113
- *GroupsMultiPurposeLabelsApi* | [**updateOneApiGroupsLabelsItemIdPut**](docs/GroupsMultiPurposeLabelsApi.md#updateoneapigroupslabelsitemidput) | **PUT** /api/groups/labels/{item_id} | Update One
114
- *GroupsReportsApi* | [**deleteOneApiGroupsReportsItemIdDelete**](docs/GroupsReportsApi.md#deleteoneapigroupsreportsitemiddelete) | **DELETE** /api/groups/reports/{item_id} | Delete One
115
- *GroupsReportsApi* | [**getAllApiGroupsReportsGet**](docs/GroupsReportsApi.md#getallapigroupsreportsget) | **GET** /api/groups/reports | Get All
116
- *GroupsReportsApi* | [**getOneApiGroupsReportsItemIdGet**](docs/GroupsReportsApi.md#getoneapigroupsreportsitemidget) | **GET** /api/groups/reports/{item_id} | Get One
117
- *GroupsSeedersApi* | [**seedFoodsApiGroupsSeedersFoodsPost**](docs/GroupsSeedersApi.md#seedfoodsapigroupsseedersfoodspost) | **POST** /api/groups/seeders/foods | Seed Foods
118
- *GroupsSeedersApi* | [**seedLabelsApiGroupsSeedersLabelsPost**](docs/GroupsSeedersApi.md#seedlabelsapigroupsseederslabelspost) | **POST** /api/groups/seeders/labels | Seed Labels
119
- *GroupsSeedersApi* | [**seedUnitsApiGroupsSeedersUnitsPost**](docs/GroupsSeedersApi.md#seedunitsapigroupsseedersunitspost) | **POST** /api/groups/seeders/units | Seed Units
120
- *GroupsSelfServiceApi* | [**getGroupMemberApiGroupsMembersUsernameOrIdGet**](docs/GroupsSelfServiceApi.md#getgroupmemberapigroupsmembersusernameoridget) | **GET** /api/groups/members/{username_or_id} | Get Group Member
121
- *GroupsSelfServiceApi* | [**getGroupMembersApiGroupsMembersGet**](docs/GroupsSelfServiceApi.md#getgroupmembersapigroupsmembersget) | **GET** /api/groups/members | Get Group Members
122
- *GroupsSelfServiceApi* | [**getGroupPreferencesApiGroupsPreferencesGet**](docs/GroupsSelfServiceApi.md#getgrouppreferencesapigroupspreferencesget) | **GET** /api/groups/preferences | Get Group Preferences
123
- *GroupsSelfServiceApi* | [**getLoggedInUserGroupApiGroupsSelfGet**](docs/GroupsSelfServiceApi.md#getloggedinusergroupapigroupsselfget) | **GET** /api/groups/self | Get Logged In User Group
124
- *GroupsSelfServiceApi* | [**getStorageApiGroupsStorageGet**](docs/GroupsSelfServiceApi.md#getstorageapigroupsstorageget) | **GET** /api/groups/storage | Get Storage
125
- *GroupsSelfServiceApi* | [**updateGroupPreferencesApiGroupsPreferencesPut**](docs/GroupsSelfServiceApi.md#updategrouppreferencesapigroupspreferencesput) | **PUT** /api/groups/preferences | Update Group Preferences
126
- *HouseholdsCookbooksApi* | [**createOneApiHouseholdsCookbooksPost**](docs/HouseholdsCookbooksApi.md#createoneapihouseholdscookbookspost) | **POST** /api/households/cookbooks | Create One
127
- *HouseholdsCookbooksApi* | [**deleteOneApiHouseholdsCookbooksItemIdDelete**](docs/HouseholdsCookbooksApi.md#deleteoneapihouseholdscookbooksitemiddelete) | **DELETE** /api/households/cookbooks/{item_id} | Delete One
128
- *HouseholdsCookbooksApi* | [**getAllApiHouseholdsCookbooksGet**](docs/HouseholdsCookbooksApi.md#getallapihouseholdscookbooksget) | **GET** /api/households/cookbooks | Get All
129
- *HouseholdsCookbooksApi* | [**getOneApiHouseholdsCookbooksItemIdGet**](docs/HouseholdsCookbooksApi.md#getoneapihouseholdscookbooksitemidget) | **GET** /api/households/cookbooks/{item_id} | Get One
130
- *HouseholdsCookbooksApi* | [**updateManyApiHouseholdsCookbooksPut**](docs/HouseholdsCookbooksApi.md#updatemanyapihouseholdscookbooksput) | **PUT** /api/households/cookbooks | Update Many
131
- *HouseholdsCookbooksApi* | [**updateOneApiHouseholdsCookbooksItemIdPut**](docs/HouseholdsCookbooksApi.md#updateoneapihouseholdscookbooksitemidput) | **PUT** /api/households/cookbooks/{item_id} | Update One
132
- *HouseholdsEventNotificationsApi* | [**createOneApiHouseholdsEventsNotificationsPost**](docs/HouseholdsEventNotificationsApi.md#createoneapihouseholdseventsnotificationspost) | **POST** /api/households/events/notifications | Create One
133
- *HouseholdsEventNotificationsApi* | [**deleteOneApiHouseholdsEventsNotificationsItemIdDelete**](docs/HouseholdsEventNotificationsApi.md#deleteoneapihouseholdseventsnotificationsitemiddelete) | **DELETE** /api/households/events/notifications/{item_id} | Delete One
134
- *HouseholdsEventNotificationsApi* | [**getAllApiHouseholdsEventsNotificationsGet**](docs/HouseholdsEventNotificationsApi.md#getallapihouseholdseventsnotificationsget) | **GET** /api/households/events/notifications | Get All
135
- *HouseholdsEventNotificationsApi* | [**getOneApiHouseholdsEventsNotificationsItemIdGet**](docs/HouseholdsEventNotificationsApi.md#getoneapihouseholdseventsnotificationsitemidget) | **GET** /api/households/events/notifications/{item_id} | Get One
136
- *HouseholdsEventNotificationsApi* | [**testNotificationApiHouseholdsEventsNotificationsItemIdTestPost**](docs/HouseholdsEventNotificationsApi.md#testnotificationapihouseholdseventsnotificationsitemidtestpost) | **POST** /api/households/events/notifications/{item_id}/test | Test Notification
137
- *HouseholdsEventNotificationsApi* | [**updateOneApiHouseholdsEventsNotificationsItemIdPut**](docs/HouseholdsEventNotificationsApi.md#updateoneapihouseholdseventsnotificationsitemidput) | **PUT** /api/households/events/notifications/{item_id} | Update One
138
- *HouseholdsInvitationsApi* | [**createInviteTokenApiHouseholdsInvitationsPost**](docs/HouseholdsInvitationsApi.md#createinvitetokenapihouseholdsinvitationspost) | **POST** /api/households/invitations | Create Invite Token
139
- *HouseholdsInvitationsApi* | [**emailInvitationApiHouseholdsInvitationsEmailPost**](docs/HouseholdsInvitationsApi.md#emailinvitationapihouseholdsinvitationsemailpost) | **POST** /api/households/invitations/email | Email Invitation
140
- *HouseholdsInvitationsApi* | [**getInviteTokensApiHouseholdsInvitationsGet**](docs/HouseholdsInvitationsApi.md#getinvitetokensapihouseholdsinvitationsget) | **GET** /api/households/invitations | Get Invite Tokens
141
- *HouseholdsMealplanRulesApi* | [**createOneApiHouseholdsMealplansRulesPost**](docs/HouseholdsMealplanRulesApi.md#createoneapihouseholdsmealplansrulespost) | **POST** /api/households/mealplans/rules | Create One
142
- *HouseholdsMealplanRulesApi* | [**deleteOneApiHouseholdsMealplansRulesItemIdDelete**](docs/HouseholdsMealplanRulesApi.md#deleteoneapihouseholdsmealplansrulesitemiddelete) | **DELETE** /api/households/mealplans/rules/{item_id} | Delete One
143
- *HouseholdsMealplanRulesApi* | [**getAllApiHouseholdsMealplansRulesGet**](docs/HouseholdsMealplanRulesApi.md#getallapihouseholdsmealplansrulesget) | **GET** /api/households/mealplans/rules | Get All
144
- *HouseholdsMealplanRulesApi* | [**getOneApiHouseholdsMealplansRulesItemIdGet**](docs/HouseholdsMealplanRulesApi.md#getoneapihouseholdsmealplansrulesitemidget) | **GET** /api/households/mealplans/rules/{item_id} | Get One
145
- *HouseholdsMealplanRulesApi* | [**updateOneApiHouseholdsMealplansRulesItemIdPut**](docs/HouseholdsMealplanRulesApi.md#updateoneapihouseholdsmealplansrulesitemidput) | **PUT** /api/households/mealplans/rules/{item_id} | Update One
146
- *HouseholdsMealplansApi* | [**createOneApiHouseholdsMealplansPost**](docs/HouseholdsMealplansApi.md#createoneapihouseholdsmealplanspost) | **POST** /api/households/mealplans | Create One
147
- *HouseholdsMealplansApi* | [**createRandomMealApiHouseholdsMealplansRandomPost**](docs/HouseholdsMealplansApi.md#createrandommealapihouseholdsmealplansrandompost) | **POST** /api/households/mealplans/random | Create Random Meal
148
- *HouseholdsMealplansApi* | [**deleteOneApiHouseholdsMealplansItemIdDelete**](docs/HouseholdsMealplansApi.md#deleteoneapihouseholdsmealplansitemiddelete) | **DELETE** /api/households/mealplans/{item_id} | Delete One
149
- *HouseholdsMealplansApi* | [**getAllApiHouseholdsMealplansGet**](docs/HouseholdsMealplansApi.md#getallapihouseholdsmealplansget) | **GET** /api/households/mealplans | Get All
150
- *HouseholdsMealplansApi* | [**getOneApiHouseholdsMealplansItemIdGet**](docs/HouseholdsMealplansApi.md#getoneapihouseholdsmealplansitemidget) | **GET** /api/households/mealplans/{item_id} | Get One
151
- *HouseholdsMealplansApi* | [**getTodaysMealsApiHouseholdsMealplansTodayGet**](docs/HouseholdsMealplansApi.md#gettodaysmealsapihouseholdsmealplanstodayget) | **GET** /api/households/mealplans/today | Get Todays Meals
152
- *HouseholdsMealplansApi* | [**updateOneApiHouseholdsMealplansItemIdPut**](docs/HouseholdsMealplansApi.md#updateoneapihouseholdsmealplansitemidput) | **PUT** /api/households/mealplans/{item_id} | Update One
153
- *HouseholdsRecipeActionsApi* | [**createOneApiHouseholdsRecipeActionsPost**](docs/HouseholdsRecipeActionsApi.md#createoneapihouseholdsrecipeactionspost) | **POST** /api/households/recipe-actions | Create One
154
- *HouseholdsRecipeActionsApi* | [**deleteOneApiHouseholdsRecipeActionsItemIdDelete**](docs/HouseholdsRecipeActionsApi.md#deleteoneapihouseholdsrecipeactionsitemiddelete) | **DELETE** /api/households/recipe-actions/{item_id} | Delete One
155
- *HouseholdsRecipeActionsApi* | [**getAllApiHouseholdsRecipeActionsGet**](docs/HouseholdsRecipeActionsApi.md#getallapihouseholdsrecipeactionsget) | **GET** /api/households/recipe-actions | Get All
156
- *HouseholdsRecipeActionsApi* | [**getOneApiHouseholdsRecipeActionsItemIdGet**](docs/HouseholdsRecipeActionsApi.md#getoneapihouseholdsrecipeactionsitemidget) | **GET** /api/households/recipe-actions/{item_id} | Get One
157
- *HouseholdsRecipeActionsApi* | [**triggerActionApiHouseholdsRecipeActionsItemIdTriggerRecipeSlugPost**](docs/HouseholdsRecipeActionsApi.md#triggeractionapihouseholdsrecipeactionsitemidtriggerrecipeslugpost) | **POST** /api/households/recipe-actions/{item_id}/trigger/{recipe_slug} | Trigger Action
158
- *HouseholdsRecipeActionsApi* | [**updateOneApiHouseholdsRecipeActionsItemIdPut**](docs/HouseholdsRecipeActionsApi.md#updateoneapihouseholdsrecipeactionsitemidput) | **PUT** /api/households/recipe-actions/{item_id} | Update One
159
- *HouseholdsSelfServiceApi* | [**getHouseholdMembersApiHouseholdsMembersGet**](docs/HouseholdsSelfServiceApi.md#gethouseholdmembersapihouseholdsmembersget) | **GET** /api/households/members | Get Household Members
160
- *HouseholdsSelfServiceApi* | [**getHouseholdPreferencesApiHouseholdsPreferencesGet**](docs/HouseholdsSelfServiceApi.md#gethouseholdpreferencesapihouseholdspreferencesget) | **GET** /api/households/preferences | Get Household Preferences
161
- *HouseholdsSelfServiceApi* | [**getHouseholdRecipeApiHouseholdsSelfRecipesRecipeSlugGet**](docs/HouseholdsSelfServiceApi.md#gethouseholdrecipeapihouseholdsselfrecipesrecipeslugget) | **GET** /api/households/self/recipes/{recipe_slug} | Get Household Recipe
162
- *HouseholdsSelfServiceApi* | [**getLoggedInUserHouseholdApiHouseholdsSelfGet**](docs/HouseholdsSelfServiceApi.md#getloggedinuserhouseholdapihouseholdsselfget) | **GET** /api/households/self | Get Logged In User Household
163
- *HouseholdsSelfServiceApi* | [**getStatisticsApiHouseholdsStatisticsGet**](docs/HouseholdsSelfServiceApi.md#getstatisticsapihouseholdsstatisticsget) | **GET** /api/households/statistics | Get Statistics
164
- *HouseholdsSelfServiceApi* | [**setMemberPermissionsApiHouseholdsPermissionsPut**](docs/HouseholdsSelfServiceApi.md#setmemberpermissionsapihouseholdspermissionsput) | **PUT** /api/households/permissions | Set Member Permissions
165
- *HouseholdsSelfServiceApi* | [**updateHouseholdPreferencesApiHouseholdsPreferencesPut**](docs/HouseholdsSelfServiceApi.md#updatehouseholdpreferencesapihouseholdspreferencesput) | **PUT** /api/households/preferences | Update Household Preferences
166
- *HouseholdsShoppingListItemsApi* | [**createManyApiHouseholdsShoppingItemsCreateBulkPost**](docs/HouseholdsShoppingListItemsApi.md#createmanyapihouseholdsshoppingitemscreatebulkpost) | **POST** /api/households/shopping/items/create-bulk | Create Many
167
- *HouseholdsShoppingListItemsApi* | [**createOneApiHouseholdsShoppingItemsPost**](docs/HouseholdsShoppingListItemsApi.md#createoneapihouseholdsshoppingitemspost) | **POST** /api/households/shopping/items | Create One
168
- *HouseholdsShoppingListItemsApi* | [**deleteManyApiHouseholdsShoppingItemsDelete**](docs/HouseholdsShoppingListItemsApi.md#deletemanyapihouseholdsshoppingitemsdelete) | **DELETE** /api/households/shopping/items | Delete Many
169
- *HouseholdsShoppingListItemsApi* | [**deleteOneApiHouseholdsShoppingItemsItemIdDelete**](docs/HouseholdsShoppingListItemsApi.md#deleteoneapihouseholdsshoppingitemsitemiddelete) | **DELETE** /api/households/shopping/items/{item_id} | Delete One
170
- *HouseholdsShoppingListItemsApi* | [**getAllApiHouseholdsShoppingItemsGet**](docs/HouseholdsShoppingListItemsApi.md#getallapihouseholdsshoppingitemsget) | **GET** /api/households/shopping/items | Get All
171
- *HouseholdsShoppingListItemsApi* | [**getOneApiHouseholdsShoppingItemsItemIdGet**](docs/HouseholdsShoppingListItemsApi.md#getoneapihouseholdsshoppingitemsitemidget) | **GET** /api/households/shopping/items/{item_id} | Get One
172
- *HouseholdsShoppingListItemsApi* | [**updateManyApiHouseholdsShoppingItemsPut**](docs/HouseholdsShoppingListItemsApi.md#updatemanyapihouseholdsshoppingitemsput) | **PUT** /api/households/shopping/items | Update Many
173
- *HouseholdsShoppingListItemsApi* | [**updateOneApiHouseholdsShoppingItemsItemIdPut**](docs/HouseholdsShoppingListItemsApi.md#updateoneapihouseholdsshoppingitemsitemidput) | **PUT** /api/households/shopping/items/{item_id} | Update One
174
- *HouseholdsShoppingListsApi* | [**addRecipeIngredientsToListApiHouseholdsShoppingListsItemIdRecipePost**](docs/HouseholdsShoppingListsApi.md#addrecipeingredientstolistapihouseholdsshoppinglistsitemidrecipepost) | **POST** /api/households/shopping/lists/{item_id}/recipe | Add Recipe Ingredients To List
175
- *HouseholdsShoppingListsApi* | [**addSingleRecipeIngredientsToListApiHouseholdsShoppingListsItemIdRecipeRecipeIdPost**](docs/HouseholdsShoppingListsApi.md#addsinglerecipeingredientstolistapihouseholdsshoppinglistsitemidreciperecipeidpost) | **POST** /api/households/shopping/lists/{item_id}/recipe/{recipe_id} | Add Single Recipe Ingredients To List
176
- *HouseholdsShoppingListsApi* | [**createOneApiHouseholdsShoppingListsPost**](docs/HouseholdsShoppingListsApi.md#createoneapihouseholdsshoppinglistspost) | **POST** /api/households/shopping/lists | Create One
177
- *HouseholdsShoppingListsApi* | [**deleteOneApiHouseholdsShoppingListsItemIdDelete**](docs/HouseholdsShoppingListsApi.md#deleteoneapihouseholdsshoppinglistsitemiddelete) | **DELETE** /api/households/shopping/lists/{item_id} | Delete One
178
- *HouseholdsShoppingListsApi* | [**getAllApiHouseholdsShoppingListsGet**](docs/HouseholdsShoppingListsApi.md#getallapihouseholdsshoppinglistsget) | **GET** /api/households/shopping/lists | Get All
179
- *HouseholdsShoppingListsApi* | [**getOneApiHouseholdsShoppingListsItemIdGet**](docs/HouseholdsShoppingListsApi.md#getoneapihouseholdsshoppinglistsitemidget) | **GET** /api/households/shopping/lists/{item_id} | Get One
180
- *HouseholdsShoppingListsApi* | [**removeRecipeIngredientsFromListApiHouseholdsShoppingListsItemIdRecipeRecipeIdDeletePost**](docs/HouseholdsShoppingListsApi.md#removerecipeingredientsfromlistapihouseholdsshoppinglistsitemidreciperecipeiddeletepost) | **POST** /api/households/shopping/lists/{item_id}/recipe/{recipe_id}/delete | Remove Recipe Ingredients From List
181
- *HouseholdsShoppingListsApi* | [**updateLabelSettingsApiHouseholdsShoppingListsItemIdLabelSettingsPut**](docs/HouseholdsShoppingListsApi.md#updatelabelsettingsapihouseholdsshoppinglistsitemidlabelsettingsput) | **PUT** /api/households/shopping/lists/{item_id}/label-settings | Update Label Settings
182
- *HouseholdsShoppingListsApi* | [**updateOneApiHouseholdsShoppingListsItemIdPut**](docs/HouseholdsShoppingListsApi.md#updateoneapihouseholdsshoppinglistsitemidput) | **PUT** /api/households/shopping/lists/{item_id} | Update One
183
- *HouseholdsWebhooksApi* | [**createOneApiHouseholdsWebhooksPost**](docs/HouseholdsWebhooksApi.md#createoneapihouseholdswebhookspost) | **POST** /api/households/webhooks | Create One
184
- *HouseholdsWebhooksApi* | [**deleteOneApiHouseholdsWebhooksItemIdDelete**](docs/HouseholdsWebhooksApi.md#deleteoneapihouseholdswebhooksitemiddelete) | **DELETE** /api/households/webhooks/{item_id} | Delete One
185
- *HouseholdsWebhooksApi* | [**getAllApiHouseholdsWebhooksGet**](docs/HouseholdsWebhooksApi.md#getallapihouseholdswebhooksget) | **GET** /api/households/webhooks | Get All
186
- *HouseholdsWebhooksApi* | [**getOneApiHouseholdsWebhooksItemIdGet**](docs/HouseholdsWebhooksApi.md#getoneapihouseholdswebhooksitemidget) | **GET** /api/households/webhooks/{item_id} | Get One
187
- *HouseholdsWebhooksApi* | [**rerunWebhooksApiHouseholdsWebhooksRerunPost**](docs/HouseholdsWebhooksApi.md#rerunwebhooksapihouseholdswebhooksrerunpost) | **POST** /api/households/webhooks/rerun | Rerun Webhooks
188
- *HouseholdsWebhooksApi* | [**testOneApiHouseholdsWebhooksItemIdTestPost**](docs/HouseholdsWebhooksApi.md#testoneapihouseholdswebhooksitemidtestpost) | **POST** /api/households/webhooks/{item_id}/test | Test One
189
- *HouseholdsWebhooksApi* | [**updateOneApiHouseholdsWebhooksItemIdPut**](docs/HouseholdsWebhooksApi.md#updateoneapihouseholdswebhooksitemidput) | **PUT** /api/households/webhooks/{item_id} | Update One
190
- *OrganizerCategoriesApi* | [**createOneApiOrganizersCategoriesPost**](docs/OrganizerCategoriesApi.md#createoneapiorganizerscategoriespost) | **POST** /api/organizers/categories | Create One
191
- *OrganizerCategoriesApi* | [**deleteOneApiOrganizersCategoriesItemIdDelete**](docs/OrganizerCategoriesApi.md#deleteoneapiorganizerscategoriesitemiddelete) | **DELETE** /api/organizers/categories/{item_id} | Delete One
192
- *OrganizerCategoriesApi* | [**getAllApiOrganizersCategoriesGet**](docs/OrganizerCategoriesApi.md#getallapiorganizerscategoriesget) | **GET** /api/organizers/categories | Get All
193
- *OrganizerCategoriesApi* | [**getAllEmptyApiOrganizersCategoriesEmptyGet**](docs/OrganizerCategoriesApi.md#getallemptyapiorganizerscategoriesemptyget) | **GET** /api/organizers/categories/empty | Get All Empty
194
- *OrganizerCategoriesApi* | [**getOneApiOrganizersCategoriesItemIdGet**](docs/OrganizerCategoriesApi.md#getoneapiorganizerscategoriesitemidget) | **GET** /api/organizers/categories/{item_id} | Get One
195
- *OrganizerCategoriesApi* | [**getOneBySlugApiOrganizersCategoriesSlugCategorySlugGet**](docs/OrganizerCategoriesApi.md#getonebyslugapiorganizerscategoriesslugcategoryslugget) | **GET** /api/organizers/categories/slug/{category_slug} | Get One By Slug
196
- *OrganizerCategoriesApi* | [**updateOneApiOrganizersCategoriesItemIdPut**](docs/OrganizerCategoriesApi.md#updateoneapiorganizerscategoriesitemidput) | **PUT** /api/organizers/categories/{item_id} | Update One
197
- *OrganizerTagsApi* | [**createOneApiOrganizersTagsPost**](docs/OrganizerTagsApi.md#createoneapiorganizerstagspost) | **POST** /api/organizers/tags | Create One
198
- *OrganizerTagsApi* | [**deleteRecipeTagApiOrganizersTagsItemIdDelete**](docs/OrganizerTagsApi.md#deleterecipetagapiorganizerstagsitemiddelete) | **DELETE** /api/organizers/tags/{item_id} | Delete Recipe Tag
199
- *OrganizerTagsApi* | [**getAllApiOrganizersTagsGet**](docs/OrganizerTagsApi.md#getallapiorganizerstagsget) | **GET** /api/organizers/tags | Get All
200
- *OrganizerTagsApi* | [**getEmptyTagsApiOrganizersTagsEmptyGet**](docs/OrganizerTagsApi.md#getemptytagsapiorganizerstagsemptyget) | **GET** /api/organizers/tags/empty | Get Empty Tags
201
- *OrganizerTagsApi* | [**getOneApiOrganizersTagsItemIdGet**](docs/OrganizerTagsApi.md#getoneapiorganizerstagsitemidget) | **GET** /api/organizers/tags/{item_id} | Get One
202
- *OrganizerTagsApi* | [**getOneBySlugApiOrganizersTagsSlugTagSlugGet**](docs/OrganizerTagsApi.md#getonebyslugapiorganizerstagsslugtagslugget) | **GET** /api/organizers/tags/slug/{tag_slug} | Get One By Slug
203
- *OrganizerTagsApi* | [**updateOneApiOrganizersTagsItemIdPut**](docs/OrganizerTagsApi.md#updateoneapiorganizerstagsitemidput) | **PUT** /api/organizers/tags/{item_id} | Update One
204
- *OrganizerToolsApi* | [**createOneApiOrganizersToolsPost**](docs/OrganizerToolsApi.md#createoneapiorganizerstoolspost) | **POST** /api/organizers/tools | Create One
205
- *OrganizerToolsApi* | [**deleteOneApiOrganizersToolsItemIdDelete**](docs/OrganizerToolsApi.md#deleteoneapiorganizerstoolsitemiddelete) | **DELETE** /api/organizers/tools/{item_id} | Delete One
206
- *OrganizerToolsApi* | [**getAllApiOrganizersToolsGet**](docs/OrganizerToolsApi.md#getallapiorganizerstoolsget) | **GET** /api/organizers/tools | Get All
207
- *OrganizerToolsApi* | [**getOneApiOrganizersToolsItemIdGet**](docs/OrganizerToolsApi.md#getoneapiorganizerstoolsitemidget) | **GET** /api/organizers/tools/{item_id} | Get One
208
- *OrganizerToolsApi* | [**getOneBySlugApiOrganizersToolsSlugToolSlugGet**](docs/OrganizerToolsApi.md#getonebyslugapiorganizerstoolsslugtoolslugget) | **GET** /api/organizers/tools/slug/{tool_slug} | Get One By Slug
209
- *OrganizerToolsApi* | [**updateOneApiOrganizersToolsItemIdPut**](docs/OrganizerToolsApi.md#updateoneapiorganizerstoolsitemidput) | **PUT** /api/organizers/tools/{item_id} | Update One
210
- *RecipeBulkActionsApi* | [**bulkCategorizeRecipesApiRecipesBulkActionsCategorizePost**](docs/RecipeBulkActionsApi.md#bulkcategorizerecipesapirecipesbulkactionscategorizepost) | **POST** /api/recipes/bulk-actions/categorize | Bulk Categorize Recipes
211
- *RecipeBulkActionsApi* | [**bulkDeleteRecipesApiRecipesBulkActionsDeletePost**](docs/RecipeBulkActionsApi.md#bulkdeleterecipesapirecipesbulkactionsdeletepost) | **POST** /api/recipes/bulk-actions/delete | Bulk Delete Recipes
212
- *RecipeBulkActionsApi* | [**bulkExportRecipesApiRecipesBulkActionsExportPost**](docs/RecipeBulkActionsApi.md#bulkexportrecipesapirecipesbulkactionsexportpost) | **POST** /api/recipes/bulk-actions/export | Bulk Export Recipes
213
- *RecipeBulkActionsApi* | [**bulkSettingsRecipesApiRecipesBulkActionsSettingsPost**](docs/RecipeBulkActionsApi.md#bulksettingsrecipesapirecipesbulkactionssettingspost) | **POST** /api/recipes/bulk-actions/settings | Bulk Settings Recipes
214
- *RecipeBulkActionsApi* | [**bulkTagRecipesApiRecipesBulkActionsTagPost**](docs/RecipeBulkActionsApi.md#bulktagrecipesapirecipesbulkactionstagpost) | **POST** /api/recipes/bulk-actions/tag | Bulk Tag Recipes
215
- *RecipeBulkActionsApi* | [**getExportedDataApiRecipesBulkActionsExportGet**](docs/RecipeBulkActionsApi.md#getexporteddataapirecipesbulkactionsexportget) | **GET** /api/recipes/bulk-actions/export | Get Exported Data
216
- *RecipeBulkActionsApi* | [**getExportedDataTokenApiRecipesBulkActionsExportDownloadGet**](docs/RecipeBulkActionsApi.md#getexporteddatatokenapirecipesbulkactionsexportdownloadget) | **GET** /api/recipes/bulk-actions/export/download | Get Exported Data Token
217
- *RecipeBulkActionsApi* | [**purgeExportDataApiRecipesBulkActionsExportPurgeDelete**](docs/RecipeBulkActionsApi.md#purgeexportdataapirecipesbulkactionsexportpurgedelete) | **DELETE** /api/recipes/bulk-actions/export/purge | Purge Export Data
218
- *RecipeCRUDApi* | [**createOneApiRecipesPost**](docs/RecipeCRUDApi.md#createoneapirecipespost) | **POST** /api/recipes | Create One
219
- *RecipeCRUDApi* | [**createRecipeFromHtmlOrJsonApiRecipesCreateHtmlOrJsonPost**](docs/RecipeCRUDApi.md#createrecipefromhtmlorjsonapirecipescreatehtmlorjsonpost) | **POST** /api/recipes/create/html-or-json | Create Recipe From Html Or Json
220
- *RecipeCRUDApi* | [**createRecipeFromImageApiRecipesCreateImagePost**](docs/RecipeCRUDApi.md#createrecipefromimageapirecipescreateimagepost) | **POST** /api/recipes/create/image | Create Recipe From Image
221
- *RecipeCRUDApi* | [**createRecipeFromZipApiRecipesCreateZipPost**](docs/RecipeCRUDApi.md#createrecipefromzipapirecipescreatezippost) | **POST** /api/recipes/create/zip | Create Recipe From Zip
222
- *RecipeCRUDApi* | [**deleteOneApiRecipesSlugDelete**](docs/RecipeCRUDApi.md#deleteoneapirecipesslugdelete) | **DELETE** /api/recipes/{slug} | Delete One
223
- *RecipeCRUDApi* | [**deleteRecipeImageApiRecipesSlugImageDelete**](docs/RecipeCRUDApi.md#deleterecipeimageapirecipesslugimagedelete) | **DELETE** /api/recipes/{slug}/image | Delete Recipe Image
224
- *RecipeCRUDApi* | [**duplicateOneApiRecipesSlugDuplicatePost**](docs/RecipeCRUDApi.md#duplicateoneapirecipesslugduplicatepost) | **POST** /api/recipes/{slug}/duplicate | Duplicate One
225
- *RecipeCRUDApi* | [**getAllApiRecipesGet**](docs/RecipeCRUDApi.md#getallapirecipesget) | **GET** /api/recipes | Get All
226
- *RecipeCRUDApi* | [**getOneApiRecipesSlugGet**](docs/RecipeCRUDApi.md#getoneapirecipesslugget) | **GET** /api/recipes/{slug} | Get One
227
- *RecipeCRUDApi* | [**parseRecipeUrlApiRecipesCreateUrlPost**](docs/RecipeCRUDApi.md#parserecipeurlapirecipescreateurlpost) | **POST** /api/recipes/create/url | Parse Recipe Url
228
- *RecipeCRUDApi* | [**parseRecipeUrlBulkApiRecipesCreateUrlBulkPost**](docs/RecipeCRUDApi.md#parserecipeurlbulkapirecipescreateurlbulkpost) | **POST** /api/recipes/create/url/bulk | Parse Recipe Url Bulk
229
- *RecipeCRUDApi* | [**patchManyApiRecipesPatch**](docs/RecipeCRUDApi.md#patchmanyapirecipespatch) | **PATCH** /api/recipes | Patch Many
230
- *RecipeCRUDApi* | [**patchOneApiRecipesSlugPatch**](docs/RecipeCRUDApi.md#patchoneapirecipesslugpatch) | **PATCH** /api/recipes/{slug} | Patch One
231
- *RecipeCRUDApi* | [**scrapeImageUrlApiRecipesSlugImagePost**](docs/RecipeCRUDApi.md#scrapeimageurlapirecipesslugimagepost) | **POST** /api/recipes/{slug}/image | Scrape Image Url
232
- *RecipeCRUDApi* | [**suggestRecipesApiRecipesSuggestionsGet**](docs/RecipeCRUDApi.md#suggestrecipesapirecipessuggestionsget) | **GET** /api/recipes/suggestions | Suggest Recipes
233
- *RecipeCRUDApi* | [**testParseRecipeUrlApiRecipesTestScrapeUrlPost**](docs/RecipeCRUDApi.md#testparserecipeurlapirecipestestscrapeurlpost) | **POST** /api/recipes/test-scrape-url | Test Parse Recipe Url
234
- *RecipeCRUDApi* | [**updateLastMadeApiRecipesSlugLastMadePatch**](docs/RecipeCRUDApi.md#updatelastmadeapirecipessluglastmadepatch) | **PATCH** /api/recipes/{slug}/last-made | Update Last Made
235
- *RecipeCRUDApi* | [**updateManyApiRecipesPut**](docs/RecipeCRUDApi.md#updatemanyapirecipesput) | **PUT** /api/recipes | Update Many
236
- *RecipeCRUDApi* | [**updateOneApiRecipesSlugPut**](docs/RecipeCRUDApi.md#updateoneapirecipesslugput) | **PUT** /api/recipes/{slug} | Update One
237
- *RecipeCRUDApi* | [**updateRecipeImageApiRecipesSlugImagePut**](docs/RecipeCRUDApi.md#updaterecipeimageapirecipesslugimageput) | **PUT** /api/recipes/{slug}/image | Update Recipe Image
238
- *RecipeCRUDApi* | [**uploadRecipeAssetApiRecipesSlugAssetsPost**](docs/RecipeCRUDApi.md#uploadrecipeassetapirecipesslugassetspost) | **POST** /api/recipes/{slug}/assets | Upload Recipe Asset
239
- *RecipeCommentsApi* | [**createOneApiCommentsPost**](docs/RecipeCommentsApi.md#createoneapicommentspost) | **POST** /api/comments | Create One
240
- *RecipeCommentsApi* | [**deleteOneApiCommentsItemIdDelete**](docs/RecipeCommentsApi.md#deleteoneapicommentsitemiddelete) | **DELETE** /api/comments/{item_id} | Delete One
241
- *RecipeCommentsApi* | [**getAllApiCommentsGet**](docs/RecipeCommentsApi.md#getallapicommentsget) | **GET** /api/comments | Get All
242
- *RecipeCommentsApi* | [**getOneApiCommentsItemIdGet**](docs/RecipeCommentsApi.md#getoneapicommentsitemidget) | **GET** /api/comments/{item_id} | Get One
243
- *RecipeCommentsApi* | [**getRecipeCommentsApiRecipesSlugCommentsGet**](docs/RecipeCommentsApi.md#getrecipecommentsapirecipesslugcommentsget) | **GET** /api/recipes/{slug}/comments | Get Recipe Comments
244
- *RecipeCommentsApi* | [**updateOneApiCommentsItemIdPut**](docs/RecipeCommentsApi.md#updateoneapicommentsitemidput) | **PUT** /api/comments/{item_id} | Update One
245
- *RecipeExportsApi* | [**getRecipeAsFormatApiRecipesSlugExportsGet**](docs/RecipeExportsApi.md#getrecipeasformatapirecipesslugexportsget) | **GET** /api/recipes/{slug}/exports | Get Recipe As Format
246
- *RecipeExportsApi* | [**getRecipeFormatsAndTemplatesApiRecipesExportsGet**](docs/RecipeExportsApi.md#getrecipeformatsandtemplatesapirecipesexportsget) | **GET** /api/recipes/exports | Get Recipe Formats And Templates
247
- *RecipeImagesAndAssetsApi* | [**deleteRecipeImageApiRecipesSlugImageDelete**](docs/RecipeImagesAndAssetsApi.md#deleterecipeimageapirecipesslugimagedelete) | **DELETE** /api/recipes/{slug}/image | Delete Recipe Image
248
- *RecipeImagesAndAssetsApi* | [**getRecipeAssetApiMediaRecipesRecipeIdAssetsFileNameGet**](docs/RecipeImagesAndAssetsApi.md#getrecipeassetapimediarecipesrecipeidassetsfilenameget) | **GET** /api/media/recipes/{recipe_id}/assets/{file_name} | Get Recipe Asset
249
- *RecipeImagesAndAssetsApi* | [**getRecipeImgApiMediaRecipesRecipeIdImagesFileNameGet**](docs/RecipeImagesAndAssetsApi.md#getrecipeimgapimediarecipesrecipeidimagesfilenameget) | **GET** /api/media/recipes/{recipe_id}/images/{file_name} | Get Recipe Img
250
- *RecipeImagesAndAssetsApi* | [**getRecipeTimelineEventImgApiMediaRecipesRecipeIdImagesTimelineTimelineEventIdFileNameGet**](docs/RecipeImagesAndAssetsApi.md#getrecipetimelineeventimgapimediarecipesrecipeidimagestimelinetimelineeventidfilenameget) | **GET** /api/media/recipes/{recipe_id}/images/timeline/{timeline_event_id}/{file_name} | Get Recipe Timeline Event Img
251
- *RecipeImagesAndAssetsApi* | [**getUserImageApiMediaUsersUserIdFileNameGet**](docs/RecipeImagesAndAssetsApi.md#getuserimageapimediausersuseridfilenameget) | **GET** /api/media/users/{user_id}/{file_name} | Get User Image
252
- *RecipeImagesAndAssetsApi* | [**getValidationTextApiMediaDockerValidateTxtGet**](docs/RecipeImagesAndAssetsApi.md#getvalidationtextapimediadockervalidatetxtget) | **GET** /api/media/docker/validate.txt | Get Validation Text
253
- *RecipeImagesAndAssetsApi* | [**scrapeImageUrlApiRecipesSlugImagePost**](docs/RecipeImagesAndAssetsApi.md#scrapeimageurlapirecipesslugimagepost) | **POST** /api/recipes/{slug}/image | Scrape Image Url
254
- *RecipeImagesAndAssetsApi* | [**updateRecipeImageApiRecipesSlugImagePut**](docs/RecipeImagesAndAssetsApi.md#updaterecipeimageapirecipesslugimageput) | **PUT** /api/recipes/{slug}/image | Update Recipe Image
255
- *RecipeImagesAndAssetsApi* | [**uploadRecipeAssetApiRecipesSlugAssetsPost**](docs/RecipeImagesAndAssetsApi.md#uploadrecipeassetapirecipesslugassetspost) | **POST** /api/recipes/{slug}/assets | Upload Recipe Asset
256
- *RecipeIngredientParserApi* | [**parseIngredientApiParserIngredientPost**](docs/RecipeIngredientParserApi.md#parseingredientapiparseringredientpost) | **POST** /api/parser/ingredient | Parse Ingredient
257
- *RecipeIngredientParserApi* | [**parseIngredientsApiParserIngredientsPost**](docs/RecipeIngredientParserApi.md#parseingredientsapiparseringredientspost) | **POST** /api/parser/ingredients | Parse Ingredients
258
- *RecipeSharedApi* | [**getSharedRecipeApiRecipesSharedTokenIdGet**](docs/RecipeSharedApi.md#getsharedrecipeapirecipessharedtokenidget) | **GET** /api/recipes/shared/{token_id} | Get Shared Recipe
259
- *RecipeSharedApi* | [**getSharedRecipeAsZipApiRecipesSharedTokenIdZipGet**](docs/RecipeSharedApi.md#getsharedrecipeaszipapirecipessharedtokenidzipget) | **GET** /api/recipes/shared/{token_id}/zip | Get Shared Recipe As Zip
260
- *RecipeTimelineApi* | [**createOneApiRecipesTimelineEventsPost**](docs/RecipeTimelineApi.md#createoneapirecipestimelineeventspost) | **POST** /api/recipes/timeline/events | Create One
261
- *RecipeTimelineApi* | [**deleteOneApiRecipesTimelineEventsItemIdDelete**](docs/RecipeTimelineApi.md#deleteoneapirecipestimelineeventsitemiddelete) | **DELETE** /api/recipes/timeline/events/{item_id} | Delete One
262
- *RecipeTimelineApi* | [**getAllApiRecipesTimelineEventsGet**](docs/RecipeTimelineApi.md#getallapirecipestimelineeventsget) | **GET** /api/recipes/timeline/events | Get All
263
- *RecipeTimelineApi* | [**getOneApiRecipesTimelineEventsItemIdGet**](docs/RecipeTimelineApi.md#getoneapirecipestimelineeventsitemidget) | **GET** /api/recipes/timeline/events/{item_id} | Get One
264
- *RecipeTimelineApi* | [**updateEventImageApiRecipesTimelineEventsItemIdImagePut**](docs/RecipeTimelineApi.md#updateeventimageapirecipestimelineeventsitemidimageput) | **PUT** /api/recipes/timeline/events/{item_id}/image | Update Event Image
265
- *RecipeTimelineApi* | [**updateOneApiRecipesTimelineEventsItemIdPut**](docs/RecipeTimelineApi.md#updateoneapirecipestimelineeventsitemidput) | **PUT** /api/recipes/timeline/events/{item_id} | Update One
266
- *RecipesFoodsApi* | [**createOneApiFoodsPost**](docs/RecipesFoodsApi.md#createoneapifoodspost) | **POST** /api/foods | Create One
267
- *RecipesFoodsApi* | [**deleteOneApiFoodsItemIdDelete**](docs/RecipesFoodsApi.md#deleteoneapifoodsitemiddelete) | **DELETE** /api/foods/{item_id} | Delete One
268
- *RecipesFoodsApi* | [**getAllApiFoodsGet**](docs/RecipesFoodsApi.md#getallapifoodsget) | **GET** /api/foods | Get All
269
- *RecipesFoodsApi* | [**getOneApiFoodsItemIdGet**](docs/RecipesFoodsApi.md#getoneapifoodsitemidget) | **GET** /api/foods/{item_id} | Get One
270
- *RecipesFoodsApi* | [**mergeOneApiFoodsMergePut**](docs/RecipesFoodsApi.md#mergeoneapifoodsmergeput) | **PUT** /api/foods/merge | Merge One
271
- *RecipesFoodsApi* | [**updateOneApiFoodsItemIdPut**](docs/RecipesFoodsApi.md#updateoneapifoodsitemidput) | **PUT** /api/foods/{item_id} | Update One
272
- *RecipesUnitsApi* | [**createOneApiUnitsPost**](docs/RecipesUnitsApi.md#createoneapiunitspost) | **POST** /api/units | Create One
273
- *RecipesUnitsApi* | [**deleteOneApiUnitsItemIdDelete**](docs/RecipesUnitsApi.md#deleteoneapiunitsitemiddelete) | **DELETE** /api/units/{item_id} | Delete One
274
- *RecipesUnitsApi* | [**getAllApiUnitsGet**](docs/RecipesUnitsApi.md#getallapiunitsget) | **GET** /api/units | Get All
275
- *RecipesUnitsApi* | [**getOneApiUnitsItemIdGet**](docs/RecipesUnitsApi.md#getoneapiunitsitemidget) | **GET** /api/units/{item_id} | Get One
276
- *RecipesUnitsApi* | [**mergeOneApiUnitsMergePut**](docs/RecipesUnitsApi.md#mergeoneapiunitsmergeput) | **PUT** /api/units/merge | Merge One
277
- *RecipesUnitsApi* | [**updateOneApiUnitsItemIdPut**](docs/RecipesUnitsApi.md#updateoneapiunitsitemidput) | **PUT** /api/units/{item_id} | Update One
278
- *SharedRecipesApi* | [**createOneApiSharedRecipesPost**](docs/SharedRecipesApi.md#createoneapisharedrecipespost) | **POST** /api/shared/recipes | Create One
279
- *SharedRecipesApi* | [**deleteOneApiSharedRecipesItemIdDelete**](docs/SharedRecipesApi.md#deleteoneapisharedrecipesitemiddelete) | **DELETE** /api/shared/recipes/{item_id} | Delete One
280
- *SharedRecipesApi* | [**getAllApiSharedRecipesGet**](docs/SharedRecipesApi.md#getallapisharedrecipesget) | **GET** /api/shared/recipes | Get All
281
- *SharedRecipesApi* | [**getOneApiSharedRecipesItemIdGet**](docs/SharedRecipesApi.md#getoneapisharedrecipesitemidget) | **GET** /api/shared/recipes/{item_id} | Get One
282
- *UsersAuthenticationApi* | [**getTokenApiAuthTokenPost**](docs/UsersAuthenticationApi.md#gettokenapiauthtokenpost) | **POST** /api/auth/token | Get Token
283
- *UsersAuthenticationApi* | [**logoutApiAuthLogoutPost**](docs/UsersAuthenticationApi.md#logoutapiauthlogoutpost) | **POST** /api/auth/logout | Logout
284
- *UsersAuthenticationApi* | [**oauthCallbackApiAuthOauthCallbackGet**](docs/UsersAuthenticationApi.md#oauthcallbackapiauthoauthcallbackget) | **GET** /api/auth/oauth/callback | Oauth Callback
285
- *UsersAuthenticationApi* | [**oauthLoginApiAuthOauthGet**](docs/UsersAuthenticationApi.md#oauthloginapiauthoauthget) | **GET** /api/auth/oauth | Oauth Login
286
- *UsersAuthenticationApi* | [**refreshTokenApiAuthRefreshGet**](docs/UsersAuthenticationApi.md#refreshtokenapiauthrefreshget) | **GET** /api/auth/refresh | Refresh Token
287
- *UsersCRUDApi* | [**getLoggedInUserApiUsersSelfGet**](docs/UsersCRUDApi.md#getloggedinuserapiusersselfget) | **GET** /api/users/self | Get Logged In User
288
- *UsersCRUDApi* | [**getLoggedInUserFavoritesApiUsersSelfFavoritesGet**](docs/UsersCRUDApi.md#getloggedinuserfavoritesapiusersselffavoritesget) | **GET** /api/users/self/favorites | Get Logged In User Favorites
289
- *UsersCRUDApi* | [**getLoggedInUserRatingForRecipeApiUsersSelfRatingsRecipeIdGet**](docs/UsersCRUDApi.md#getloggedinuserratingforrecipeapiusersselfratingsrecipeidget) | **GET** /api/users/self/ratings/{recipe_id} | Get Logged In User Rating For Recipe
290
- *UsersCRUDApi* | [**getLoggedInUserRatingsApiUsersSelfRatingsGet**](docs/UsersCRUDApi.md#getloggedinuserratingsapiusersselfratingsget) | **GET** /api/users/self/ratings | Get Logged In User Ratings
291
- *UsersCRUDApi* | [**updatePasswordApiUsersPasswordPut**](docs/UsersCRUDApi.md#updatepasswordapiuserspasswordput) | **PUT** /api/users/password | Update Password
292
- *UsersCRUDApi* | [**updateUserApiUsersItemIdPut**](docs/UsersCRUDApi.md#updateuserapiusersitemidput) | **PUT** /api/users/{item_id} | Update User
293
- *UsersImagesApi* | [**updateUserImageApiUsersIdImagePost**](docs/UsersImagesApi.md#updateuserimageapiusersidimagepost) | **POST** /api/users/{id}/image | Update User Image
294
- *UsersPasswordsApi* | [**forgotPasswordApiUsersForgotPasswordPost**](docs/UsersPasswordsApi.md#forgotpasswordapiusersforgotpasswordpost) | **POST** /api/users/forgot-password | Forgot Password
295
- *UsersPasswordsApi* | [**resetPasswordApiUsersResetPasswordPost**](docs/UsersPasswordsApi.md#resetpasswordapiusersresetpasswordpost) | **POST** /api/users/reset-password | Reset Password
296
- *UsersRatingsApi* | [**addFavoriteApiUsersIdFavoritesSlugPost**](docs/UsersRatingsApi.md#addfavoriteapiusersidfavoritesslugpost) | **POST** /api/users/{id}/favorites/{slug} | Add Favorite
297
- *UsersRatingsApi* | [**getFavoritesApiUsersIdFavoritesGet**](docs/UsersRatingsApi.md#getfavoritesapiusersidfavoritesget) | **GET** /api/users/{id}/favorites | Get Favorites
298
- *UsersRatingsApi* | [**getRatingsApiUsersIdRatingsGet**](docs/UsersRatingsApi.md#getratingsapiusersidratingsget) | **GET** /api/users/{id}/ratings | Get Ratings
299
- *UsersRatingsApi* | [**removeFavoriteApiUsersIdFavoritesSlugDelete**](docs/UsersRatingsApi.md#removefavoriteapiusersidfavoritesslugdelete) | **DELETE** /api/users/{id}/favorites/{slug} | Remove Favorite
300
- *UsersRatingsApi* | [**setRatingApiUsersIdRatingsSlugPost**](docs/UsersRatingsApi.md#setratingapiusersidratingsslugpost) | **POST** /api/users/{id}/ratings/{slug} | Set Rating
301
- *UsersRegistrationApi* | [**registerNewUserApiUsersRegisterPost**](docs/UsersRegistrationApi.md#registernewuserapiusersregisterpost) | **POST** /api/users/register | Register New User
302
- *UsersTokensApi* | [**createApiTokenApiUsersApiTokensPost**](docs/UsersTokensApi.md#createapitokenapiusersapitokenspost) | **POST** /api/users/api-tokens | Create Api Token
303
- *UsersTokensApi* | [**deleteApiTokenApiUsersApiTokensTokenIdDelete**](docs/UsersTokensApi.md#deleteapitokenapiusersapitokenstokeniddelete) | **DELETE** /api/users/api-tokens/{token_id} | Delete Api Token
304
- *UtilsApi* | [**downloadFileApiUtilsDownloadGet**](docs/UtilsApi.md#downloadfileapiutilsdownloadget) | **GET** /api/utils/download | Download File
43
+ const response = await authApi.getTokenApiAuthTokenPost(
44
+ 'your-username',
45
+ 'your-password'
46
+ );
305
47
 
48
+ const token = response.data.access_token;
49
+
50
+ // Use the token for subsequent requests
51
+ const config = new Configuration({
52
+ basePath: 'https://your-mealie-instance.com',
53
+ accessToken: token,
54
+ });
55
+ ```
306
56
 
307
- ### Documentation For Models
57
+ ### Available APIs
308
58
 
309
- - [AdminAboutInfo](docs/AdminAboutInfo.md)
310
- - [AllBackups](docs/AllBackups.md)
311
- - [AppInfo](docs/AppInfo.md)
312
- - [AppStartupInfo](docs/AppStartupInfo.md)
313
- - [AppStatistics](docs/AppStatistics.md)
314
- - [AppTheme](docs/AppTheme.md)
315
- - [AssignCategories](docs/AssignCategories.md)
316
- - [AssignSettings](docs/AssignSettings.md)
317
- - [AssignTags](docs/AssignTags.md)
318
- - [AuthMethod](docs/AuthMethod.md)
319
- - [BackupFile](docs/BackupFile.md)
320
- - [BodyTriggerActionApiHouseholdsRecipeActionsItemIdTriggerRecipeSlugPost](docs/BodyTriggerActionApiHouseholdsRecipeActionsItemIdTriggerRecipeSlugPost.md)
321
- - [CategoryBase](docs/CategoryBase.md)
322
- - [CategoryIn](docs/CategoryIn.md)
323
- - [CategoryOut](docs/CategoryOut.md)
324
- - [CategorySummary](docs/CategorySummary.md)
325
- - [ChangePassword](docs/ChangePassword.md)
326
- - [CheckAppConfig](docs/CheckAppConfig.md)
327
- - [CookBookPagination](docs/CookBookPagination.md)
328
- - [Cookbook](docs/Cookbook.md)
329
- - [Cookbook1](docs/Cookbook1.md)
330
- - [CookbookHousehold](docs/CookbookHousehold.md)
331
- - [CreateCookBook](docs/CreateCookBook.md)
332
- - [CreateGroupRecipeAction](docs/CreateGroupRecipeAction.md)
333
- - [CreateIngredientFood](docs/CreateIngredientFood.md)
334
- - [CreateIngredientFoodAlias](docs/CreateIngredientFoodAlias.md)
335
- - [CreateIngredientUnit](docs/CreateIngredientUnit.md)
336
- - [CreateIngredientUnitAlias](docs/CreateIngredientUnitAlias.md)
337
- - [CreateInviteToken](docs/CreateInviteToken.md)
338
- - [CreatePlanEntry](docs/CreatePlanEntry.md)
339
- - [CreateRandomEntry](docs/CreateRandomEntry.md)
340
- - [CreateRecipe](docs/CreateRecipe.md)
341
- - [CreateRecipeBulk](docs/CreateRecipeBulk.md)
342
- - [CreateRecipeByUrlBulk](docs/CreateRecipeByUrlBulk.md)
343
- - [CreateUserRegistration](docs/CreateUserRegistration.md)
344
- - [CreateWebhook](docs/CreateWebhook.md)
345
- - [DebugResponse](docs/DebugResponse.md)
346
- - [DeleteRecipes](docs/DeleteRecipes.md)
347
- - [DeleteTokenResponse](docs/DeleteTokenResponse.md)
348
- - [EmailInitationResponse](docs/EmailInitationResponse.md)
349
- - [EmailInvitation](docs/EmailInvitation.md)
350
- - [EmailReady](docs/EmailReady.md)
351
- - [EmailSuccess](docs/EmailSuccess.md)
352
- - [EmailTest](docs/EmailTest.md)
353
- - [ExportRecipes](docs/ExportRecipes.md)
354
- - [ExportTypes](docs/ExportTypes.md)
355
- - [FileTokenResponse](docs/FileTokenResponse.md)
356
- - [Food](docs/Food.md)
357
- - [Food1](docs/Food1.md)
358
- - [ForgotPassword](docs/ForgotPassword.md)
359
- - [FormatResponse](docs/FormatResponse.md)
360
- - [GetAllApiRecipesGetCategoriesParameterInner](docs/GetAllApiRecipesGetCategoriesParameterInner.md)
361
- - [GetAllApiRecipesGetTagsParameterInner](docs/GetAllApiRecipesGetTagsParameterInner.md)
362
- - [GroupAdminUpdate](docs/GroupAdminUpdate.md)
363
- - [GroupBase](docs/GroupBase.md)
364
- - [GroupDataExport](docs/GroupDataExport.md)
365
- - [GroupEventNotifierCreate](docs/GroupEventNotifierCreate.md)
366
- - [GroupEventNotifierOptions](docs/GroupEventNotifierOptions.md)
367
- - [GroupEventNotifierOptionsOut](docs/GroupEventNotifierOptionsOut.md)
368
- - [GroupEventNotifierOut](docs/GroupEventNotifierOut.md)
369
- - [GroupEventNotifierUpdate](docs/GroupEventNotifierUpdate.md)
370
- - [GroupEventPagination](docs/GroupEventPagination.md)
371
- - [GroupHouseholdSummary](docs/GroupHouseholdSummary.md)
372
- - [GroupInDB](docs/GroupInDB.md)
373
- - [GroupPagination](docs/GroupPagination.md)
374
- - [GroupRecipeActionOut](docs/GroupRecipeActionOut.md)
375
- - [GroupRecipeActionPagination](docs/GroupRecipeActionPagination.md)
376
- - [GroupRecipeActionType](docs/GroupRecipeActionType.md)
377
- - [GroupStorage](docs/GroupStorage.md)
378
- - [GroupSummary](docs/GroupSummary.md)
379
- - [HTTPValidationError](docs/HTTPValidationError.md)
380
- - [HouseholdCreate](docs/HouseholdCreate.md)
381
- - [HouseholdInDB](docs/HouseholdInDB.md)
382
- - [HouseholdPagination](docs/HouseholdPagination.md)
383
- - [HouseholdRecipeSummary](docs/HouseholdRecipeSummary.md)
384
- - [HouseholdStatistics](docs/HouseholdStatistics.md)
385
- - [HouseholdSummary](docs/HouseholdSummary.md)
386
- - [HouseholdUserSummary](docs/HouseholdUserSummary.md)
387
- - [ImageType](docs/ImageType.md)
388
- - [IngredientConfidence](docs/IngredientConfidence.md)
389
- - [IngredientFoodAlias](docs/IngredientFoodAlias.md)
390
- - [IngredientFoodInput](docs/IngredientFoodInput.md)
391
- - [IngredientFoodOutput](docs/IngredientFoodOutput.md)
392
- - [IngredientFoodPagination](docs/IngredientFoodPagination.md)
393
- - [IngredientReferences](docs/IngredientReferences.md)
394
- - [IngredientRequest](docs/IngredientRequest.md)
395
- - [IngredientUnitAlias](docs/IngredientUnitAlias.md)
396
- - [IngredientUnitInput](docs/IngredientUnitInput.md)
397
- - [IngredientUnitOutput](docs/IngredientUnitOutput.md)
398
- - [IngredientUnitPagination](docs/IngredientUnitPagination.md)
399
- - [IngredientsRequest](docs/IngredientsRequest.md)
400
- - [ItemId](docs/ItemId.md)
401
- - [ItemId1](docs/ItemId1.md)
402
- - [LogicalOperator](docs/LogicalOperator.md)
403
- - [LongLiveTokenCreateResponse](docs/LongLiveTokenCreateResponse.md)
404
- - [LongLiveTokenIn](docs/LongLiveTokenIn.md)
405
- - [LongLiveTokenOut](docs/LongLiveTokenOut.md)
406
- - [MaintenanceStorageDetails](docs/MaintenanceStorageDetails.md)
407
- - [MaintenanceSummary](docs/MaintenanceSummary.md)
408
- - [MealieSchemaRecipeRecipeCommentsUserBase](docs/MealieSchemaRecipeRecipeCommentsUserBase.md)
409
- - [MealieSchemaUserUserUserBase](docs/MealieSchemaUserUserUserBase.md)
410
- - [MergeFood](docs/MergeFood.md)
411
- - [MergeUnit](docs/MergeUnit.md)
412
- - [MultiPurposeLabelCreate](docs/MultiPurposeLabelCreate.md)
413
- - [MultiPurposeLabelOut](docs/MultiPurposeLabelOut.md)
414
- - [MultiPurposeLabelPagination](docs/MultiPurposeLabelPagination.md)
415
- - [MultiPurposeLabelSummary](docs/MultiPurposeLabelSummary.md)
416
- - [MultiPurposeLabelUpdate](docs/MultiPurposeLabelUpdate.md)
417
- - [Nutrition](docs/Nutrition.md)
418
- - [OrderByNullPosition](docs/OrderByNullPosition.md)
419
- - [OrderDirection](docs/OrderDirection.md)
420
- - [PaginationBaseHouseholdSummary](docs/PaginationBaseHouseholdSummary.md)
421
- - [PaginationBaseIngredientFood](docs/PaginationBaseIngredientFood.md)
422
- - [PaginationBaseReadCookBook](docs/PaginationBaseReadCookBook.md)
423
- - [PaginationBaseRecipeCategory](docs/PaginationBaseRecipeCategory.md)
424
- - [PaginationBaseRecipeSummary](docs/PaginationBaseRecipeSummary.md)
425
- - [PaginationBaseRecipeTag](docs/PaginationBaseRecipeTag.md)
426
- - [PaginationBaseRecipeTool](docs/PaginationBaseRecipeTool.md)
427
- - [PaginationBaseUserOut](docs/PaginationBaseUserOut.md)
428
- - [PaginationBaseUserSummary](docs/PaginationBaseUserSummary.md)
429
- - [ParsedIngredient](docs/ParsedIngredient.md)
430
- - [PasswordResetToken](docs/PasswordResetToken.md)
431
- - [PlanEntryPagination](docs/PlanEntryPagination.md)
432
- - [PlanEntryType](docs/PlanEntryType.md)
433
- - [PlanRulesCreate](docs/PlanRulesCreate.md)
434
- - [PlanRulesDay](docs/PlanRulesDay.md)
435
- - [PlanRulesOut](docs/PlanRulesOut.md)
436
- - [PlanRulesPagination](docs/PlanRulesPagination.md)
437
- - [PlanRulesType](docs/PlanRulesType.md)
438
- - [QueryFilterJSON](docs/QueryFilterJSON.md)
439
- - [QueryFilterJSONPart](docs/QueryFilterJSONPart.md)
440
- - [ReadCookBook](docs/ReadCookBook.md)
441
- - [ReadGroupPreferences](docs/ReadGroupPreferences.md)
442
- - [ReadHouseholdPreferences](docs/ReadHouseholdPreferences.md)
443
- - [ReadInviteToken](docs/ReadInviteToken.md)
444
- - [ReadPlanEntry](docs/ReadPlanEntry.md)
445
- - [ReadWebhook](docs/ReadWebhook.md)
446
- - [RecipeAsset](docs/RecipeAsset.md)
447
- - [RecipeCategory](docs/RecipeCategory.md)
448
- - [RecipeCategoryPagination](docs/RecipeCategoryPagination.md)
449
- - [RecipeCommentCreate](docs/RecipeCommentCreate.md)
450
- - [RecipeCommentOutInput](docs/RecipeCommentOutInput.md)
451
- - [RecipeCommentOutOutput](docs/RecipeCommentOutOutput.md)
452
- - [RecipeCommentPagination](docs/RecipeCommentPagination.md)
453
- - [RecipeCommentUpdate](docs/RecipeCommentUpdate.md)
454
- - [RecipeDuplicate](docs/RecipeDuplicate.md)
455
- - [RecipeIngredientInput](docs/RecipeIngredientInput.md)
456
- - [RecipeIngredientOutput](docs/RecipeIngredientOutput.md)
457
- - [RecipeInput](docs/RecipeInput.md)
458
- - [RecipeLastMade](docs/RecipeLastMade.md)
459
- - [RecipeNote](docs/RecipeNote.md)
460
- - [RecipeOutput](docs/RecipeOutput.md)
461
- - [RecipeSettings](docs/RecipeSettings.md)
462
- - [RecipeShareToken](docs/RecipeShareToken.md)
463
- - [RecipeShareTokenCreate](docs/RecipeShareTokenCreate.md)
464
- - [RecipeShareTokenSummary](docs/RecipeShareTokenSummary.md)
465
- - [RecipeStep](docs/RecipeStep.md)
466
- - [RecipeSuggestionResponse](docs/RecipeSuggestionResponse.md)
467
- - [RecipeSuggestionResponseItem](docs/RecipeSuggestionResponseItem.md)
468
- - [RecipeSummary](docs/RecipeSummary.md)
469
- - [RecipeTag](docs/RecipeTag.md)
470
- - [RecipeTagPagination](docs/RecipeTagPagination.md)
471
- - [RecipeTagResponse](docs/RecipeTagResponse.md)
472
- - [RecipeTimelineEventIn](docs/RecipeTimelineEventIn.md)
473
- - [RecipeTimelineEventOut](docs/RecipeTimelineEventOut.md)
474
- - [RecipeTimelineEventPagination](docs/RecipeTimelineEventPagination.md)
475
- - [RecipeTimelineEventUpdate](docs/RecipeTimelineEventUpdate.md)
476
- - [RecipeTool](docs/RecipeTool.md)
477
- - [RecipeToolCreate](docs/RecipeToolCreate.md)
478
- - [RecipeToolOut](docs/RecipeToolOut.md)
479
- - [RecipeToolPagination](docs/RecipeToolPagination.md)
480
- - [RecipeToolResponse](docs/RecipeToolResponse.md)
481
- - [RegisteredParser](docs/RegisteredParser.md)
482
- - [RelationalKeyword](docs/RelationalKeyword.md)
483
- - [RelationalOperator](docs/RelationalOperator.md)
484
- - [Relationaloperator](docs/Relationaloperator.md)
485
- - [ReportCategory](docs/ReportCategory.md)
486
- - [ReportEntryOut](docs/ReportEntryOut.md)
487
- - [ReportOut](docs/ReportOut.md)
488
- - [ReportSummary](docs/ReportSummary.md)
489
- - [ReportSummaryStatus](docs/ReportSummaryStatus.md)
490
- - [ResetPassword](docs/ResetPassword.md)
491
- - [SaveGroupRecipeAction](docs/SaveGroupRecipeAction.md)
492
- - [ScrapeRecipe](docs/ScrapeRecipe.md)
493
- - [ScrapeRecipeData](docs/ScrapeRecipeData.md)
494
- - [ScrapeRecipeTest](docs/ScrapeRecipeTest.md)
495
- - [SeederConfig](docs/SeederConfig.md)
496
- - [SetPermissions](docs/SetPermissions.md)
497
- - [ShoppingListAddRecipeParams](docs/ShoppingListAddRecipeParams.md)
498
- - [ShoppingListAddRecipeParamsBulk](docs/ShoppingListAddRecipeParamsBulk.md)
499
- - [ShoppingListCreate](docs/ShoppingListCreate.md)
500
- - [ShoppingListItemCreate](docs/ShoppingListItemCreate.md)
501
- - [ShoppingListItemOutInput](docs/ShoppingListItemOutInput.md)
502
- - [ShoppingListItemOutOutput](docs/ShoppingListItemOutOutput.md)
503
- - [ShoppingListItemPagination](docs/ShoppingListItemPagination.md)
504
- - [ShoppingListItemRecipeRefCreate](docs/ShoppingListItemRecipeRefCreate.md)
505
- - [ShoppingListItemRecipeRefOut](docs/ShoppingListItemRecipeRefOut.md)
506
- - [ShoppingListItemRecipeRefUpdate](docs/ShoppingListItemRecipeRefUpdate.md)
507
- - [ShoppingListItemUpdate](docs/ShoppingListItemUpdate.md)
508
- - [ShoppingListItemUpdateBulk](docs/ShoppingListItemUpdateBulk.md)
509
- - [ShoppingListItemUpdateRecipeReferencesInner](docs/ShoppingListItemUpdateRecipeReferencesInner.md)
510
- - [ShoppingListItemsCollectionOut](docs/ShoppingListItemsCollectionOut.md)
511
- - [ShoppingListMultiPurposeLabelOut](docs/ShoppingListMultiPurposeLabelOut.md)
512
- - [ShoppingListMultiPurposeLabelUpdate](docs/ShoppingListMultiPurposeLabelUpdate.md)
513
- - [ShoppingListOut](docs/ShoppingListOut.md)
514
- - [ShoppingListPagination](docs/ShoppingListPagination.md)
515
- - [ShoppingListRecipeRefOut](docs/ShoppingListRecipeRefOut.md)
516
- - [ShoppingListRemoveRecipeParams](docs/ShoppingListRemoveRecipeParams.md)
517
- - [ShoppingListSummary](docs/ShoppingListSummary.md)
518
- - [ShoppingListUpdate](docs/ShoppingListUpdate.md)
519
- - [SuccessResponse](docs/SuccessResponse.md)
520
- - [SupportedMigrations](docs/SupportedMigrations.md)
521
- - [TagBase](docs/TagBase.md)
522
- - [TagIn](docs/TagIn.md)
523
- - [TagOut](docs/TagOut.md)
524
- - [TimelineEventImage](docs/TimelineEventImage.md)
525
- - [TimelineEventType](docs/TimelineEventType.md)
526
- - [Unit](docs/Unit.md)
527
- - [Unit1](docs/Unit1.md)
528
- - [UnlockResults](docs/UnlockResults.md)
529
- - [UpdateCookBook](docs/UpdateCookBook.md)
530
- - [UpdateGroupPreferences](docs/UpdateGroupPreferences.md)
531
- - [UpdateHouseholdAdmin](docs/UpdateHouseholdAdmin.md)
532
- - [UpdateHouseholdPreferences](docs/UpdateHouseholdPreferences.md)
533
- - [UpdateImageResponse](docs/UpdateImageResponse.md)
534
- - [UpdatePlanEntry](docs/UpdatePlanEntry.md)
535
- - [UserIn](docs/UserIn.md)
536
- - [UserOut](docs/UserOut.md)
537
- - [UserPagination](docs/UserPagination.md)
538
- - [UserRatingOut](docs/UserRatingOut.md)
539
- - [UserRatingSummary](docs/UserRatingSummary.md)
540
- - [UserRatingUpdate](docs/UserRatingUpdate.md)
541
- - [UserRatingsUserRatingOut](docs/UserRatingsUserRatingOut.md)
542
- - [UserRatingsUserRatingSummary](docs/UserRatingsUserRatingSummary.md)
543
- - [UserSummary](docs/UserSummary.md)
544
- - [UsernameOrId](docs/UsernameOrId.md)
545
- - [ValidationError](docs/ValidationError.md)
546
- - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
547
- - [Value](docs/Value.md)
548
- - [WebhookPagination](docs/WebhookPagination.md)
549
- - [WebhookType](docs/WebhookType.md)
59
+ The client provides access to all Mealie API endpoints:
550
60
 
61
+ - `RecipeCRUDApi` - Create, read, update, delete recipes
62
+ - `RecipeCommentsApi` - Manage recipe comments
63
+ - `OrganizerCategoriesApi` - Manage recipe categories
64
+ - `OrganizerTagsApi` - Manage recipe tags
65
+ - `HouseholdsMealplansApi` - Meal planning
66
+ - `HouseholdsShoppingListsApi` - Shopping lists
67
+ - `UsersAuthenticationApi` - Authentication
68
+ - `AdminManageUsersApi` - User management (admin)
551
69
 
552
- <a id="documentation-for-authorization"></a>
553
- ## Documentation For Authorization
70
+ See the [docs](./docs) folder for complete API documentation.
554
71
 
72
+ ## Requirements
555
73
 
556
- Authentication schemes defined for the API:
557
- <a id="OAuth2PasswordBearer"></a>
558
- ### OAuth2PasswordBearer
74
+ - Node.js >= 16
75
+ - A running Mealie instance
559
76
 
560
- - **Type**: OAuth
561
- - **Flow**: password
562
- - **Authorization URL**:
563
- - **Scopes**: N/A
77
+ ## License
564
78
 
79
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mealie-typescript",
3
- "version": "1.0.0",
3
+ "version": "1.0.5",
4
4
  "description": "OpenAPI client for mealie-typescript",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
package/git_push.sh DELETED
@@ -1,57 +0,0 @@
1
- #!/bin/sh
2
- # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
3
- #
4
- # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
5
-
6
- git_user_id=$1
7
- git_repo_id=$2
8
- release_note=$3
9
- git_host=$4
10
-
11
- if [ "$git_host" = "" ]; then
12
- git_host="github.com"
13
- echo "[INFO] No command line input provided. Set \$git_host to $git_host"
14
- fi
15
-
16
- if [ "$git_user_id" = "" ]; then
17
- git_user_id="GIT_USER_ID"
18
- echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
19
- fi
20
-
21
- if [ "$git_repo_id" = "" ]; then
22
- git_repo_id="GIT_REPO_ID"
23
- echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
24
- fi
25
-
26
- if [ "$release_note" = "" ]; then
27
- release_note="Minor update"
28
- echo "[INFO] No command line input provided. Set \$release_note to $release_note"
29
- fi
30
-
31
- # Initialize the local directory as a Git repository
32
- git init
33
-
34
- # Adds the files in the local repository and stages them for commit.
35
- git add .
36
-
37
- # Commits the tracked changes and prepares them to be pushed to a remote repository.
38
- git commit -m "$release_note"
39
-
40
- # Sets the new remote
41
- git_remote=$(git remote)
42
- if [ "$git_remote" = "" ]; then # git remote not defined
43
-
44
- if [ "$GIT_TOKEN" = "" ]; then
45
- echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
46
- git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
47
- else
48
- git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
49
- fi
50
-
51
- fi
52
-
53
- git pull origin master
54
-
55
- # Pushes (Forces) the changes in the local repository up to the remote repository
56
- echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
57
- git push origin master 2>&1 | grep -v 'To https'