Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 2.76 KB

README.md

File metadata and controls

52 lines (35 loc) · 2.76 KB

Ingredients

(ingredients)

Overview

The ingredients endpoints.

Available Operations

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

from speakeasy_bar_py import BarPython
from speakeasy_bar_py.models import components

with BarPython(
    security=components.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
) as s:
    res = s.ingredients.list_ingredients(page=347327)

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

Parameters

Parameter Type Required Description
page int ✔️ N/A
ingredients List[str] ➖ A list of ingredients to filter by. If not provided all ingredients will be returned.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListIngredientsResponse

Errors

Error Type Status Code Content Type
errors.APIError 5XX application/json
errors.SDKError 4XX */*