mealie-typescript 1.0.0

package/docs/HouseholdsMealplanRulesApi.md

@@ -0,0 +1,305 @@
+# HouseholdsMealplanRulesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createOneApiHouseholdsMealplansRulesPost**](#createoneapihouseholdsmealplansrulespost) | **POST** /api/households/mealplans/rules | Create One|
+|[**deleteOneApiHouseholdsMealplansRulesItemIdDelete**](#deleteoneapihouseholdsmealplansrulesitemiddelete) | **DELETE** /api/households/mealplans/rules/{item_id} | Delete One|
+|[**getAllApiHouseholdsMealplansRulesGet**](#getallapihouseholdsmealplansrulesget) | **GET** /api/households/mealplans/rules | Get All|
+|[**getOneApiHouseholdsMealplansRulesItemIdGet**](#getoneapihouseholdsmealplansrulesitemidget) | **GET** /api/households/mealplans/rules/{item_id} | Get One|
+|[**updateOneApiHouseholdsMealplansRulesItemIdPut**](#updateoneapihouseholdsmealplansrulesitemidput) | **PUT** /api/households/mealplans/rules/{item_id} | Update One|
+
+# **createOneApiHouseholdsMealplansRulesPost**
+> PlanRulesOut createOneApiHouseholdsMealplansRulesPost(planRulesCreate)
+
+
+### Example
+
+```typescript
+import {
+    HouseholdsMealplanRulesApi,
+    Configuration,
+    PlanRulesCreate
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new HouseholdsMealplanRulesApi(configuration);
+
+let planRulesCreate: PlanRulesCreate; //
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.createOneApiHouseholdsMealplansRulesPost(
+    planRulesCreate,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planRulesCreate** | **PlanRulesCreate**|  | |
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PlanRulesOut**
+
+### Authorization
+
+[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | 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)
+
+# **deleteOneApiHouseholdsMealplansRulesItemIdDelete**
+> PlanRulesOut deleteOneApiHouseholdsMealplansRulesItemIdDelete()
+
+
+### Example
+
+```typescript
+import {
+    HouseholdsMealplanRulesApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new HouseholdsMealplanRulesApi(configuration);
+
+let itemId: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.deleteOneApiHouseholdsMealplansRulesItemIdDelete(
+    itemId,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **itemId** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PlanRulesOut**
+
+### Authorization
+
+[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### 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)
+
+# **getAllApiHouseholdsMealplansRulesGet**
+> PlanRulesPagination getAllApiHouseholdsMealplansRulesGet()
+
+
+### Example
+
+```typescript
+import {
+    HouseholdsMealplanRulesApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new HouseholdsMealplanRulesApi(configuration);
+
+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.getAllApiHouseholdsMealplansRulesGet(
+    orderBy,
+    orderByNullPosition,
+    orderDirection,
+    queryFilter,
+    paginationSeed,
+    page,
+    perPage,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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
+
+**PlanRulesPagination**
+
+### Authorization
+
+[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### 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)
+
+# **getOneApiHouseholdsMealplansRulesItemIdGet**
+> PlanRulesOut getOneApiHouseholdsMealplansRulesItemIdGet()
+
+
+### Example
+
+```typescript
+import {
+    HouseholdsMealplanRulesApi,
+    Configuration
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new HouseholdsMealplanRulesApi(configuration);
+
+let itemId: string; // (default to undefined)
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getOneApiHouseholdsMealplansRulesItemIdGet(
+    itemId,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **itemId** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PlanRulesOut**
+
+### Authorization
+
+[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### 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)
+
+# **updateOneApiHouseholdsMealplansRulesItemIdPut**
+> PlanRulesOut updateOneApiHouseholdsMealplansRulesItemIdPut(planRulesCreate)
+
+
+### Example
+
+```typescript
+import {
+    HouseholdsMealplanRulesApi,
+    Configuration,
+    PlanRulesCreate
+} from 'mealie-typescript';
+
+const configuration = new Configuration();
+const apiInstance = new HouseholdsMealplanRulesApi(configuration);
+
+let itemId: string; // (default to undefined)
+let planRulesCreate: PlanRulesCreate; //
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.updateOneApiHouseholdsMealplansRulesItemIdPut(
+    itemId,
+    planRulesCreate,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planRulesCreate** | **PlanRulesCreate**|  | |
+| **itemId** | [**string**] |  | defaults to undefined|
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PlanRulesOut**
+
+### Authorization
+
+[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+