mealie-typescript 1.0.0

package/docs/ExploreCategoriesApi.md

@@ -0,0 +1,144 @@
+# ExploreCategoriesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getAllApiExploreGroupsGroupSlugOrganizersCategoriesGet**](#getallapiexploregroupsgroupslugorganizerscategoriesget) | **GET** /api/explore/groups/{group_slug}/organizers/categories | Get All|
+|[**getOneApiExploreGroupsGroupSlugOrganizersCategoriesItemIdGet**](#getoneapiexploregroupsgroupslugorganizerscategoriesitemidget) | **GET** /api/explore/groups/{group_slug}/organizers/categories/{item_id} | Get One|
+
+# **getAllApiExploreGroupsGroupSlugOrganizersCategoriesGet**
+> PaginationBaseRecipeCategory getAllApiExploreGroupsGroupSlugOrganizersCategoriesGet()
+
+
+### Example
+
+```typescript
+import {
+    ExploreCategoriesApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ExploreCategoriesApi(configuration);
+
+let groupSlug: string; // (default to undefined)
+let search: string; // (optional) (default to undefined)
+let orderBy: string; // (optional) (default to undefined)
+let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
+let orderDirection: OrderDirection; // (optional) (default to undefined)
+let queryFilter: string; // (optional) (default to undefined)
+let paginationSeed: string; // (optional) (default to undefined)
+let page: number; // (optional) (default to 1)
+let perPage: number; // (optional) (default to 50)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getAllApiExploreGroupsGroupSlugOrganizersCategoriesGet(
+    groupSlug,
+    search,
+    orderBy,
+    orderByNullPosition,
+    orderDirection,
+    queryFilter,
+    paginationSeed,
+    page,
+    perPage,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupSlug** | [**string**] |  | defaults to undefined|
+| **search** | [**string**] |  | (optional) defaults to undefined|
+| **orderBy** | [**string**] |  | (optional) defaults to undefined|
+| **orderByNullPosition** | **OrderByNullPosition** |  | (optional) defaults to undefined|
+| **orderDirection** | **OrderDirection** |  | (optional) defaults to undefined|
+| **queryFilter** | [**string**] |  | (optional) defaults to undefined|
+| **paginationSeed** | [**string**] |  | (optional) defaults to undefined|
+| **page** | [**number**] |  | (optional) defaults to 1|
+| **perPage** | [**number**] |  | (optional) defaults to 50|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginationBaseRecipeCategory**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **getOneApiExploreGroupsGroupSlugOrganizersCategoriesItemIdGet**
+> CategoryOut getOneApiExploreGroupsGroupSlugOrganizersCategoriesItemIdGet()
+
+
+### Example
+
+```typescript
+import {
+    ExploreCategoriesApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ExploreCategoriesApi(configuration);
+
+let itemId: string; // (default to undefined)
+let groupSlug: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getOneApiExploreGroupsGroupSlugOrganizersCategoriesItemIdGet(
+    itemId,
+    groupSlug,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **itemId** | [**string**] |  | defaults to undefined|
+| **groupSlug** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**CategoryOut**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+

package/docs/ExploreCookbooksApi.md

@@ -0,0 +1,145 @@
+# ExploreCookbooksApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getAllApiExploreGroupsGroupSlugCookbooksGet**](#getallapiexploregroupsgroupslugcookbooksget) | **GET** /api/explore/groups/{group_slug}/cookbooks | Get All|
+|[**getOneApiExploreGroupsGroupSlugCookbooksItemIdGet**](#getoneapiexploregroupsgroupslugcookbooksitemidget) | **GET** /api/explore/groups/{group_slug}/cookbooks/{item_id} | Get One|
+
+# **getAllApiExploreGroupsGroupSlugCookbooksGet**
+> PaginationBaseReadCookBook getAllApiExploreGroupsGroupSlugCookbooksGet()
+
+
+### Example
+
+```typescript
+import {
+    ExploreCookbooksApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ExploreCookbooksApi(configuration);
+
+let groupSlug: string; // (default to undefined)
+let search: string; // (optional) (default to undefined)
+let orderBy: string; // (optional) (default to undefined)
+let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
+let orderDirection: OrderDirection; // (optional) (default to undefined)
+let queryFilter: string; // (optional) (default to undefined)
+let paginationSeed: string; // (optional) (default to undefined)
+let page: number; // (optional) (default to 1)
+let perPage: number; // (optional) (default to 50)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getAllApiExploreGroupsGroupSlugCookbooksGet(
+    groupSlug,
+    search,
+    orderBy,
+    orderByNullPosition,
+    orderDirection,
+    queryFilter,
+    paginationSeed,
+    page,
+    perPage,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupSlug** | [**string**] |  | defaults to undefined|
+| **search** | [**string**] |  | (optional) defaults to undefined|
+| **orderBy** | [**string**] |  | (optional) defaults to undefined|
+| **orderByNullPosition** | **OrderByNullPosition** |  | (optional) defaults to undefined|
+| **orderDirection** | **OrderDirection** |  | (optional) defaults to undefined|
+| **queryFilter** | [**string**] |  | (optional) defaults to undefined|
+| **paginationSeed** | [**string**] |  | (optional) defaults to undefined|
+| **page** | [**number**] |  | (optional) defaults to 1|
+| **perPage** | [**number**] |  | (optional) defaults to 50|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginationBaseReadCookBook**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **getOneApiExploreGroupsGroupSlugCookbooksItemIdGet**
+> ReadCookBook getOneApiExploreGroupsGroupSlugCookbooksItemIdGet()
+
+
+### Example
+
+```typescript
+import {
+    ExploreCookbooksApi,
+    Configuration,
+    ItemId1
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ExploreCookbooksApi(configuration);
+
+let itemId: ItemId1; // (default to undefined)
+let groupSlug: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getOneApiExploreGroupsGroupSlugCookbooksItemIdGet(
+    itemId,
+    groupSlug,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **itemId** | **ItemId1** |  | defaults to undefined|
+| **groupSlug** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ReadCookBook**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+

package/docs/ExploreFoodsApi.md

@@ -0,0 +1,144 @@
+# ExploreFoodsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getAllApiExploreGroupsGroupSlugFoodsGet**](#getallapiexploregroupsgroupslugfoodsget) | **GET** /api/explore/groups/{group_slug}/foods | Get All|
+|[**getOneApiExploreGroupsGroupSlugFoodsItemIdGet**](#getoneapiexploregroupsgroupslugfoodsitemidget) | **GET** /api/explore/groups/{group_slug}/foods/{item_id} | Get One|
+
+# **getAllApiExploreGroupsGroupSlugFoodsGet**
+> PaginationBaseIngredientFood getAllApiExploreGroupsGroupSlugFoodsGet()
+
+
+### Example
+
+```typescript
+import {
+    ExploreFoodsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ExploreFoodsApi(configuration);
+
+let groupSlug: string; // (default to undefined)
+let search: string; // (optional) (default to undefined)
+let orderBy: string; // (optional) (default to undefined)
+let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
+let orderDirection: OrderDirection; // (optional) (default to undefined)
+let queryFilter: string; // (optional) (default to undefined)
+let paginationSeed: string; // (optional) (default to undefined)
+let page: number; // (optional) (default to 1)
+let perPage: number; // (optional) (default to 50)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getAllApiExploreGroupsGroupSlugFoodsGet(
+    groupSlug,
+    search,
+    orderBy,
+    orderByNullPosition,
+    orderDirection,
+    queryFilter,
+    paginationSeed,
+    page,
+    perPage,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupSlug** | [**string**] |  | defaults to undefined|
+| **search** | [**string**] |  | (optional) defaults to undefined|
+| **orderBy** | [**string**] |  | (optional) defaults to undefined|
+| **orderByNullPosition** | **OrderByNullPosition** |  | (optional) defaults to undefined|
+| **orderDirection** | **OrderDirection** |  | (optional) defaults to undefined|
+| **queryFilter** | [**string**] |  | (optional) defaults to undefined|
+| **paginationSeed** | [**string**] |  | (optional) defaults to undefined|
+| **page** | [**number**] |  | (optional) defaults to 1|
+| **perPage** | [**number**] |  | (optional) defaults to 50|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginationBaseIngredientFood**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **getOneApiExploreGroupsGroupSlugFoodsItemIdGet**
+> IngredientFoodOutput getOneApiExploreGroupsGroupSlugFoodsItemIdGet()
+
+
+### Example
+
+```typescript
+import {
+    ExploreFoodsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ExploreFoodsApi(configuration);
+
+let itemId: string; // (default to undefined)
+let groupSlug: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getOneApiExploreGroupsGroupSlugFoodsItemIdGet(
+    itemId,
+    groupSlug,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **itemId** | [**string**] |  | defaults to undefined|
+| **groupSlug** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**IngredientFoodOutput**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+

package/docs/ExploreHouseholdsApi.md

@@ -0,0 +1,141 @@
+# ExploreHouseholdsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getAllApiExploreGroupsGroupSlugHouseholdsGet**](#getallapiexploregroupsgroupslughouseholdsget) | **GET** /api/explore/groups/{group_slug}/households | Get All|
+|[**getHouseholdApiExploreGroupsGroupSlugHouseholdsHouseholdSlugGet**](#gethouseholdapiexploregroupsgroupslughouseholdshouseholdslugget) | **GET** /api/explore/groups/{group_slug}/households/{household_slug} | Get Household|
+
+# **getAllApiExploreGroupsGroupSlugHouseholdsGet**
+> PaginationBaseHouseholdSummary getAllApiExploreGroupsGroupSlugHouseholdsGet()
+
+
+### Example
+
+```typescript
+import {
+    ExploreHouseholdsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ExploreHouseholdsApi(configuration);
+
+let groupSlug: string; // (default to undefined)
+let orderBy: string; // (optional) (default to undefined)
+let orderByNullPosition: OrderByNullPosition; // (optional) (default to undefined)
+let orderDirection: OrderDirection; // (optional) (default to undefined)
+let queryFilter: string; // (optional) (default to undefined)
+let paginationSeed: string; // (optional) (default to undefined)
+let page: number; // (optional) (default to 1)
+let perPage: number; // (optional) (default to 50)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getAllApiExploreGroupsGroupSlugHouseholdsGet(
+    groupSlug,
+    orderBy,
+    orderByNullPosition,
+    orderDirection,
+    queryFilter,
+    paginationSeed,
+    page,
+    perPage,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupSlug** | [**string**] |  | defaults to undefined|
+| **orderBy** | [**string**] |  | (optional) defaults to undefined|
+| **orderByNullPosition** | **OrderByNullPosition** |  | (optional) defaults to undefined|
+| **orderDirection** | **OrderDirection** |  | (optional) defaults to undefined|
+| **queryFilter** | [**string**] |  | (optional) defaults to undefined|
+| **paginationSeed** | [**string**] |  | (optional) defaults to undefined|
+| **page** | [**number**] |  | (optional) defaults to 1|
+| **perPage** | [**number**] |  | (optional) defaults to 50|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginationBaseHouseholdSummary**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **getHouseholdApiExploreGroupsGroupSlugHouseholdsHouseholdSlugGet**
+> HouseholdSummary getHouseholdApiExploreGroupsGroupSlugHouseholdsHouseholdSlugGet()
+
+
+### Example
+
+```typescript
+import {
+    ExploreHouseholdsApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ExploreHouseholdsApi(configuration);
+
+let householdSlug: string; // (default to undefined)
+let groupSlug: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getHouseholdApiExploreGroupsGroupSlugHouseholdsHouseholdSlugGet(
+    householdSlug,
+    groupSlug,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **householdSlug** | [**string**] |  | defaults to undefined|
+| **groupSlug** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**HouseholdSummary**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+