rocie-client 0.1.0

An enterprise grocery management system - server
Documentation

Rust API client for rocie-client

An enterprise grocery management system - server

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 0.1.0
  • Package version: 0.1.0
  • Generator version: 7.17.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
ApiGetAuthInventoryApi amount_by_id GET /inventory/{id} Get the amount of an product
ApiGetAuthProductApi product_by_id GET /product/by-id/{id} Get Product by id
ApiGetAuthProductApi product_by_name GET /product/by-name/{name} Get Product by name
ApiGetAuthProductApi product_suggestion_by_name GET /product/by-part-name/{name} Get Product suggestion by name
ApiGetAuthProductApi products_by_product_parent_id_direct GET /product/by-product-parent-id-direct/{id} Get Products by it's product parent id
ApiGetAuthProductApi products_by_product_parent_id_indirect GET /product/by-product-parent-id-indirect/{id} Get Products by it's product parent id
ApiGetAuthProductApi products_in_storage GET /products_in_storage/ Return all products, which non-null amount in storage
ApiGetAuthProductApi products_registered GET /products_registered/ Return all registered products
ApiGetAuthProductApi products_without_product_parent GET /product/without-product-parent Get Products by it's absents of a product parent
ApiGetAuthProductParentApi product_parents GET /product_parents/ Return all registered product parents
ApiGetAuthProductParentApi product_parents_toplevel GET /product_parents_toplevel/ Return all registered product parents, that have no parents themselves
ApiGetAuthProductParentApi product_parents_under GET /product_parents_under/{id} Return all parents, that have this parent as parent
ApiGetAuthRecipeApi recipe_by_id GET /recipe/by-id/{id} Get an recipe by it's id.
ApiGetAuthRecipeApi recipe_by_name GET /recipe/by-name/{name} Get an recipe by it's name.
ApiGetAuthRecipeApi recipes GET /recipe/all Get all added recipes
ApiGetAuthRecipeApi recipes_by_recipe_parent_id_direct GET /recipe/by-recipe-parent-id-direct/{id} Get Recipes by it's recipe parent id
ApiGetAuthRecipeApi recipes_by_recipe_parent_id_indirect GET /recipe/by-recipe-parent-id-indirect/{id} Get Recipes by it's recipe parent id
ApiGetAuthRecipeApi recipes_without_recipe_parent GET /recipe/without-recipe-parent Get Recipes by it's absents of a recipe parent
ApiGetAuthRecipeParentApi recipe_parents GET /recipe_parents/ Return all registered recipe parents
ApiGetAuthRecipeParentApi recipe_parents_toplevel GET /recipe_parents_toplevel/ Return all registered recipe parents, that have no parents themselves
ApiGetAuthRecipeParentApi recipe_parents_under GET /recipe_parents_under/{id} Return all parents, that have this parent as parent
ApiGetAuthUnitApi unit_by_id GET /unit/{id} Get Unit by id
ApiGetAuthUnitApi units GET /units/ Return all registered units
ApiGetAuthUnitApi units_by_property_id GET /units-by-property/{id} Return all registered units for a specific unit property
ApiGetAuthUnitPropertyApi unit_properties GET /unit-properties/ Return all registered unit properties
ApiGetAuthUnitPropertyApi unit_property_by_id GET /unit-property/{id} Get Unit property by id
ApiGetAuthUserApi user_by_id GET /user/{id} Get an specific user by id.
ApiGetAuthUserApi users GET /users Get all registered users.
ApiGetNoAuthStateApi can_be_provisioned GET /can-be-provisioned Check if the server can be provisioned
ApiGetNoAuthStateApi is_logged_in GET /is-logged-in Check if you are logged in
ApiSetAuthBarcodeApi buy_barcode POST /barcode/{barcode_id}/buy/{times} Buy an barcode
ApiSetAuthBarcodeApi consume_barcode POST /barcode/{id}/consume Consume an barcode
ApiSetAuthProductApi associate_barcode POST /product/{id}/associate Associate a barcode with a product
ApiSetAuthProductApi register_product POST /product/new Register a product
ApiSetAuthProductParentApi register_product_parent POST /product_parent/new Register a product parent
ApiSetAuthRecipeApi add_recipe POST /recipe/new Register a product parent
ApiSetAuthRecipeParentApi register_recipe_parent POST /recipe_parent/new Register a product parent
ApiSetAuthUnitApi register_unit POST /unit/new Register an Unit
ApiSetAuthUnitPropertyApi register_unit_property POST /unit-property/new Register an Unit Property
ApiSetAuthUserApi register_user POST /user/new Register an new User
ApiSetNoAuthUserApi login POST /login Log in as a specific user
ApiSetNoAuthUserApi logout POST /logout Log the current user out
ApiSetNoAuthUserApi provision POST /provision Provision this instance.

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

benedikt.peetz@b-peetz.de