cata_log_hub.api.v1.catalogs module

cata_log_hub.api.v1.catalogs.list_catalogs(order=[CatalogOrderChoices.DESC_CREATED_AT], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

List all catalogs.

Return type:

PaginationPage[Catalog]

Parameters:

• order (Annotated[list[CatalogOrderChoices], Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.list_latest_catalogs(order=[CatalogOrderChoices.DESC_CREATED_AT], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

List the latest catalog for every provider.

Return type:

PaginationPage[Catalog]

Parameters:

• order (Annotated[list[CatalogOrderChoices], Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.list_previews_catalogs(order=[CatalogOrderChoices.DESC_CREATED_AT], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

List all preview catalogs.

Return type:

PaginationPage[Catalog]

Parameters:

• order (Annotated[list[CatalogOrderChoices], Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.list_current_catalogs(order=[CatalogOrderChoices.DESC_CREATED_AT], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

List all current catalogs.

Return type:

PaginationPage[Catalog]

Parameters:

• order (Annotated[list[CatalogOrderChoices], Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.list_outdated_catalogs(order=[CatalogOrderChoices.DESC_CREATED_AT], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

List all outdated catalogs.

Return type:

PaginationPage[Catalog]

Parameters:

• order (Annotated[list[CatalogOrderChoices], Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.get_catalog(catalog_id, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Get a single catalog.

Return type:

Catalog

Parameters:

• catalog_id (Annotated[int, Path(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.download_catalog(catalog_id, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Download a catalog as pdf.

Return type:

Response

Parameters:

• catalog_id (Annotated[int, Path(PydanticUndefined)])

• filename (Annotated[str | None, Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.embed_catalog(catalog_id, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Embed a catalog as pdf.

Return type:

Response

Parameters:

• catalog_id (Annotated[int, Path(PydanticUndefined)])

• filename (Annotated[str | None, Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.list_catalog_pages(catalog_id, order=[PageOrderChoices.NUMBER], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Get catalog pages.

Return type:

PaginationPage[Page]

Parameters:

• catalog_id (Annotated[int, Path(PydanticUndefined)])

• order (Annotated[list[PageOrderChoices], Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.get_catalog_page(catalog_id, page_number, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Get a single catalog page by its page number.

Return type:

Page

Parameters:

• catalog_id (Annotated[int, Path(PydanticUndefined)])

• page_number (Annotated[int, Ge(ge=0), Path(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.catalogs.download_catalog_page(catalog_id, page_number, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Download a single catalog page by its page number.

Return type:

FileResponse

Parameters:

• catalog_id (Annotated[int, Path(PydanticUndefined)])

• page_number (Annotated[int, Ge(ge=0), Path(PydanticUndefined)])

• filename (str | None)

• db_session (Session)

cata_log_hub.api.v1.catalogs.embed_catalog_page(catalog_id, page_number, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Embed a single catalog page by its page number.

Return type:

FileResponse

Parameters:

• catalog_id (Annotated[int, Path(PydanticUndefined)])

• page_number (Annotated[int, Ge(ge=0), Path(PydanticUndefined)])

• filename (Annotated[str | None, Query(PydanticUndefined)])

• db_session (Session)