# Rust API client for rocie-client An enterprise grocery management system - server ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client. - API version: 0.1.0 - Package version: 0.1.0 - Generator version: 7.14.0 - Build package: `org.openapitools.codegen.languages.RustClientCodegen` ## Installation Put the package under your project folder in a directory named `rocie-client` and add the following to `Cargo.toml` under `[dependencies]`: ``` rocie-client = { path = "./rocie-client" } ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *ApiGetInventoryApi* | [**amount_by_id**](docs/ApiGetInventoryApi.md#amount_by_id) | **GET** /inventory/{id} | Get the amount of an product *ApiGetProductApi* | [**product_by_id**](docs/ApiGetProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id *ApiGetProductApi* | [**product_by_name**](docs/ApiGetProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name *ApiGetProductApi* | [**product_suggestion_by_name**](docs/ApiGetProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name *ApiGetProductApi* | [**products_by_product_parent_id_direct**](docs/ApiGetProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id *ApiGetProductApi* | [**products_by_product_parent_id_indirect**](docs/ApiGetProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id *ApiGetProductApi* | [**products_in_storage**](docs/ApiGetProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage *ApiGetProductApi* | [**products_registered**](docs/ApiGetProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products *ApiGetProductParentApi* | [**product_parents**](docs/ApiGetProductParentApi.md#product_parents) | **GET** /product_parents/ | Return all registered product parents *ApiGetProductParentApi* | [**product_parents_toplevel**](docs/ApiGetProductParentApi.md#product_parents_toplevel) | **GET** /product_parents_toplevel/ | Return all registered product parents, that have no parents themselves *ApiGetProductParentApi* | [**product_parents_under**](docs/ApiGetProductParentApi.md#product_parents_under) | **GET** /product_parents_under/{id} | Return all parents, that have this parent as parent *ApiGetRecipeApi* | [**recipe_by_id**](docs/ApiGetRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. *ApiGetRecipeApi* | [**recipes**](docs/ApiGetRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes *ApiGetUnitApi* | [**unit_by_id**](docs/ApiGetUnitApi.md#unit_by_id) | **GET** /unit/{id} | Get Unit by id *ApiGetUnitApi* | [**units**](docs/ApiGetUnitApi.md#units) | **GET** /units/ | Return all registered units *ApiGetUnitApi* | [**units_by_property_id**](docs/ApiGetUnitApi.md#units_by_property_id) | **GET** /units-by-property/{id} | Return all registered units for a specific unit property *ApiGetUnitPropertyApi* | [**unit_properties**](docs/ApiGetUnitPropertyApi.md#unit_properties) | **GET** /unit-properties/ | Return all registered unit properties *ApiGetUnitPropertyApi* | [**unit_property_by_id**](docs/ApiGetUnitPropertyApi.md#unit_property_by_id) | **GET** /unit-property/{id} | Get Unit property by id *ApiSetBarcodeApi* | [**buy_barcode**](docs/ApiSetBarcodeApi.md#buy_barcode) | **POST** /barcode/{barcode_id}/buy/{times} | Buy an barcode *ApiSetBarcodeApi* | [**consume_barcode**](docs/ApiSetBarcodeApi.md#consume_barcode) | **POST** /barcode/{id}/consume | Consume an barcode *ApiSetProductApi* | [**associate_barcode**](docs/ApiSetProductApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product *ApiSetProductApi* | [**register_product**](docs/ApiSetProductApi.md#register_product) | **POST** /product/new | Register a product *ApiSetProductParentApi* | [**register_product_parent**](docs/ApiSetProductParentApi.md#register_product_parent) | **POST** /product_parent/new | Register a product parent *ApiSetRecipeApi* | [**add_recipe**](docs/ApiSetRecipeApi.md#add_recipe) | **POST** /recipe/new | Register a product parent *ApiSetUnitApi* | [**register_unit**](docs/ApiSetUnitApi.md#register_unit) | **POST** /unit/new | Register an Unit *ApiSetUnitPropertyApi* | [**register_unit_property**](docs/ApiSetUnitPropertyApi.md#register_unit_property) | **POST** /unit-property/new | Register an Unit Property ## Documentation For Models - [Barcode](docs/Barcode.md) - [BarcodeId](docs/BarcodeId.md) - [Product](docs/Product.md) - [ProductAmount](docs/ProductAmount.md) - [ProductId](docs/ProductId.md) - [ProductParent](docs/ProductParent.md) - [ProductParentId](docs/ProductParentId.md) - [ProductParentStub](docs/ProductParentStub.md) - [ProductStub](docs/ProductStub.md) - [Recipe](docs/Recipe.md) - [RecipeId](docs/RecipeId.md) - [RecipeStub](docs/RecipeStub.md) - [Unit](docs/Unit.md) - [UnitAmount](docs/UnitAmount.md) - [UnitId](docs/UnitId.md) - [UnitProperty](docs/UnitProperty.md) - [UnitPropertyId](docs/UnitPropertyId.md) - [UnitPropertyStub](docs/UnitPropertyStub.md) - [UnitStub](docs/UnitStub.md) To get access to the crate's generated documentation, use: ``` cargo doc --open ``` ## Author benedikt.peetz@b-peetz.de