openfoodfacts_proxy.models.v2

source package openfoodfacts_proxy.models.v2

Classes

• V2AttributeGroupsResponse — Response model for GET /api/v2/attribute_groups.

• V2PreferencesResponse — Response model for GET /api/v2/preferences.

• V2ProductNotFoundResponse — Response model for GET /api/v2/product/{code} when product is not found.

• V2ProductResponse — Response model for GET /api/v2/product/{code}.

• V2SearchResponse — Response model for GET /api/v2/search.

source class V2AttributeGroupsResponse(**data: Any)

Bases : BaseModel

Response model for GET /api/v2/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 V2PreferencesResponse(**data: Any)

Bases : BaseModel

Response model for GET /api/v2/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 V2ProductNotFoundResponse(**data: Any)

Bases : BaseModel

Response model for GET /api/v2/product/{code} when product is not found.

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 V2ProductResponse(**data: Any)

Bases : BaseModel

Response model for GET /api/v2/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 V2SearchResponse(**data: Any)

Bases : BaseModel

Response model for GET /api/v2/search.

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.