openfoodfacts_proxy.models.v3

source package openfoodfacts_proxy.models.v3

Classes

• V3AttributeGroupsResponse — Response model for GET /api/v3.4/attribute_groups.

• V3Error — Structured error detail in a v3 response.

• V3ExternalSourcesResponse — Response model for GET /api/v3/external_sources.

• V3PreferencesResponse — Response model for GET /api/v3/preferences.

• V3ProductResponse — Response model for GET /api/v3/product/{code}.

• V3ResponseStatus — Shared response envelope for all Open Food Facts v3 API responses.

• V3Result — Result descriptor returned in all v3 API responses.

• V3TagInfo — Tag detail within a tag knowledge panels response.

• V3TagResponse — Response model for GET /api/v3/tag/{tagtype}/{tag_or_tagid}.

• V3TaxonomyCanonicalizeResponse — Response model for GET /api/v3/taxonomy_canonicalize_tags.

• V3TaxonomyDisplayResponse — Response model for GET /api/v3/taxonomy_display_tags.

• V3TaxonomySuggestionsResponse — Response model for GET /api/v3/taxonomy_suggestions.

• V3Warning — Structured warning detail in a v3 response.

source class V3AttributeGroupsResponse(**data: Any)

Bases : V3ResponseStatus

Response model for GET /api/v3.4/attribute_groups.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3Error(**data: Any)

Bases : BaseModel

Structured error detail in a v3 response.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3ExternalSourcesResponse(**data: Any)

Bases : V3ResponseStatus

Response model for GET /api/v3/external_sources.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3PreferencesResponse(**data: Any)

Bases : V3ResponseStatus

Response model for GET /api/v3/preferences.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3ProductResponse(**data: Any)

Bases : V3ResponseStatus

Response model for GET /api/v3/product/{code}.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3ResponseStatus(**data: Any)

Bases : BaseModel

Shared response envelope for all Open Food Facts v3 API responses.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3Result(**data: Any)

Bases : BaseModel

Result descriptor returned in all v3 API responses.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3TagInfo(**data: Any)

Bases : BaseModel

Tag detail within a tag knowledge panels response.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3TagResponse(**data: Any)

Bases : V3ResponseStatus

Response model for GET /api/v3/tag/{tagtype}/{tag_or_tagid}.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3TaxonomyCanonicalizeResponse(**data: Any)

Bases : V3ResponseStatus

Response model for GET /api/v3/taxonomy_canonicalize_tags.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3TaxonomyDisplayResponse(**data: Any)

Bases : V3ResponseStatus

Response model for GET /api/v3/taxonomy_display_tags.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3TaxonomySuggestionsResponse(**data: Any)

Bases : V3ResponseStatus

Response model for GET /api/v3/taxonomy_suggestions.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.

source class V3Warning(**data: Any)

Bases : BaseModel

Structured warning detail in a v3 response.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

• model_config : ClassVar[ConfigDict] — Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

• model_extra : dict[str, Any] | None — Get extra fields set during validation.

• model_fields_set : set[str] — Returns the set of fields that have been explicitly set on this model instance.