README.md

Ingredients

(ingredients)

Overview

The ingredients endpoints.

Available Operations

• list_ingredients - Get a list of ingredients.

list_ingredients

Get a list of ingredients, if authenticated this will include stock levels and product codes otherwise it will only include public information.

Example Usage

import speakeasybar
from speakeasybar.models import shared

s = speakeasybar.Speakeasybar(
    security=shared.Security(
        api_key="<YOUR_API_KEY>",
    ),
)


res = s.ingredients.list_ingredients(ingredients=[
    '<value>',
])

if res.classes is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
ingredients	List[str]	➖	A list of ingredients to filter by. If not provided all ingredients will be returned.

Response

operations.ListIngredientsResponse

Errors

Error Object	Status Code	Content Type
errors.APIError	5XX	application/json
errors.SDKError	4xx-5xx	/