feat: 986 - new Prices fields

lib/openfoodfacts.dart

@@ -109,6 +109,7 @@ export 'src/prices/get_users_parameters.dart';
 export 'src/prices/get_users_result.dart';
 export 'src/prices/location.dart';
 export 'src/prices/location_osm_type.dart';
+export 'src/prices/location_type.dart';
 export 'src/prices/maybe_error.dart';
 export 'src/prices/order_by.dart';
 export 'src/prices/price.dart';

lib/src/open_prices_api_client.dart

@@ -322,7 +322,12 @@ class OpenPricesAPIClient {
     return MaybeError<bool>.responseError(response);
   }
 
-  static Future<MaybeError<Price>> createPrice({
+  /// Adds a price. Returns an error, or either the added price or null.
+  ///
+  /// Returned price can be null if we cannot decode it (but the status code is
+  /// good enough to say "price added!", even if we have trouble decoding the
+  /// price).
+  static Future<MaybeError<Price?>> createPrice({
     required final Price price,
     required final String bearerToken,
     final UriProductHelper uriHelper = uriHelperFoodProd,
@@ -348,6 +353,8 @@ class OpenPricesAPIClient {
       'location_osm_id': price.locationOSMId,
       'location_osm_type': price.locationOSMType.offTag,
       'date': GetParametersHelper.formatDate(price.date),
+      if (price.receiptQuantity != null)
+        'receipt_quantity': price.receiptQuantity,
     };
     final Response response = await HttpHelper().doPostJsonRequest(
       uri,
@@ -360,7 +367,7 @@ class OpenPricesAPIClient {
         final Map<String, dynamic> json = HttpHelper().jsonDecodeUtf8(response);
         return MaybeError<Price>.value(Price.fromJson(json));
       } catch (e) {
-        //
+        return MaybeError<Price>.unreadableResponse(response);
       }
     }
     return MaybeError<Price>.responseError(response);
@@ -454,6 +461,8 @@ class OpenPricesAPIClient {
     final LocationOSMType? locationOSMType,
     final DateTime? date,
     final Currency? currency,
+    final int? receiptPriceCount,
+    final num? receiptPriceTotal,
     required final String bearerToken,
     final UriProductHelper uriHelper = uriHelperFoodProd,
   }) async {
@@ -475,6 +484,10 @@ class OpenPricesAPIClient {
           'location_osm_type': locationOSMType.offTag,
         if (date != null) 'date': GetParametersHelper.formatDate(date),
         if (currency != null) 'currency': currency.name,
+        if (receiptPriceCount != null)
+          'receipt_price_count': receiptPriceCount.toString(),
+        if (receiptPriceTotal != null)
+          'receipt_price_total': receiptPriceTotal.toString(),
       },
     );
     final List<int> fileBytes = await UriReader.instance.readAsBytes(imageUri);

lib/src/prices/location.dart

@@ -1,6 +1,7 @@
 import 'package:json_annotation/json_annotation.dart';
 
 import 'location_osm_type.dart';
+import 'location_type.dart';
 import '../interface/json_object.dart';
 import '../utils/json_helper.dart';
 
@@ -15,6 +16,10 @@ class Location extends JsonObject {
   @JsonKey(name: 'osm_id')
   late int osmId;
 
+  /// Type of the location object.
+  @JsonKey(name: 'type')
+  late LocationType locationType;
+
   /// Type of the OpenStreetMap location object.
   ///
   /// Stores can be represented as nodes, ways or relations in OpenStreetMap.
@@ -73,6 +78,9 @@ class Location extends JsonObject {
   @JsonKey(name: 'osm_lon')
   double? longitude;
 
+  @JsonKey(name: 'website_url')
+  String? websiteUrl;
+
   /// Date when the product was bought.
   @JsonKey(fromJson: JsonHelper.stringTimestampToDate)
   late DateTime created;

lib/src/prices/location_type.dart

@@ -0,0 +1,22 @@
+import 'package:json_annotation/json_annotation.dart';
+
+import '../model/off_tagged.dart';
+
+/// Type of the Location.
+enum LocationType implements OffTagged {
+  @JsonValue('OSM')
+  osm(offTag: 'OSM'),
+  @JsonValue('ONLINE')
+  online(offTag: 'ONLINE');
+
+  const LocationType({
+    required this.offTag,
+  });
+
+  @override
+  final String offTag;
+
+  /// Returns the first [LocationType] that matches the [offTag].
+  static LocationType? fromOffTag(final String? offTag) =>
+      OffTagged.fromOffTag(offTag, LocationType.values) as LocationType?;
+}

lib/src/prices/maybe_error.dart

@@ -6,22 +6,29 @@ import 'package:http/http.dart';
 class MaybeError<T> {
   const MaybeError.value(T this._value)
       : error = null,
-        statusCode = null;
+        statusCode = null,
+        isError = false;
   MaybeError.responseError(final Response response)
       : _value = null,
         error = utf8.decode(response.bodyBytes),
-        statusCode = response.statusCode;
+        statusCode = response.statusCode,
+        isError = true;
+  MaybeError.unreadableResponse(final Response response)
+      : _value = null,
+        error = utf8.decode(response.bodyBytes),
+        statusCode = response.statusCode,
+        isError = false;
   MaybeError.error({
     required String this.error,
     required int this.statusCode,
-  }) : _value = null;
+  })  : _value = null,
+        isError = true;
 
   final T? _value;
+  final bool isError;
   final String? error;
   final int? statusCode;
 
-  bool get isError => _value == null;
-
   T get value => _value!;
 
   String get detailError {

lib/src/prices/price.dart

@@ -130,6 +130,10 @@ class Price extends JsonObject {
   @JsonKey()
   PriceProduct? product;
 
+  /// Receipt's price quantity (user input).
+  @JsonKey(name: 'receipt_quantity')
+  int? receiptQuantity;
+
   /// Owner. Read-only.
   @JsonKey()
   late String owner;

lib/src/prices/price_total_stats.dart

@@ -31,6 +31,12 @@ class PriceTotalStats extends JsonObject {
   @JsonKey(name: 'location_with_price_count')
   int? locationWithPriceCount;
 
+  @JsonKey(name: 'location_type_osm_count')
+  int? locationTypeOsmCount;
+
+  @JsonKey(name: 'location_type_online_count')
+  int? locationTypeOnlineCount;
+
   @JsonKey(name: 'proof_count')
   int? proofCount;
 
@@ -43,6 +49,12 @@ class PriceTotalStats extends JsonObject {
   @JsonKey(name: 'proof_type_receipt_count')
   int? proofTypeReceiptCount;
 
+  @JsonKey(name: 'proof_type_gdpr_request_count')
+  int? proofTypeGdprRequestCount;
+
+  @JsonKey(name: 'proof_type_shop_import_count')
+  int? proofTypeShopImportCount;
+
   @JsonKey(name: 'user_count')
   int? userCount;
 

lib/src/prices/proof.dart

@@ -40,6 +40,14 @@ class Proof extends JsonObject {
   @JsonKey(name: 'price_count')
   late int priceCount;
 
+  /// Receipt's number of prices (user input).
+  @JsonKey(name: 'receipt_price_count')
+  int? receiptPriceCount;
+
+  /// Receipt's total amount (user input).
+  @JsonKey(name: 'receipt_price_total')
+  num? receiptPriceTotal;
+
   /// ID of the location in OpenStreetMap.
   ///
   /// The store where the product was bought.

lib/src/prices/update_price_parameters.dart

@@ -25,6 +25,9 @@ class UpdatePriceParameters extends JsonObject {
   /// Date when the product was bought.
   DateTime? date;
 
+  /// Receipt's price quantity (user input).
+  int? receiptQuantity;
+
   @override
   Map<String, dynamic> toJson() => <String, dynamic>{
         if (pricePer != null) 'price_per': pricePer!.offTag,
@@ -34,5 +37,6 @@ class UpdatePriceParameters extends JsonObject {
         if (price != null) 'price': price,
         if (currency != null) 'currency': currency!.name,
         if (date != null) 'date': GetParametersHelper.formatDate(date!),
+        if (receiptQuantity != null) 'receipt_quantity': receiptQuantity,
       };
 }

lib/src/prices/update_proof_parameters.dart

@@ -1,6 +1,7 @@
 import '../interface/json_object.dart';
 import 'currency.dart';
 import 'get_parameters_helper.dart';
+import 'location_osm_type.dart';
 import 'proof_type.dart';
 
 /// Parameters for the "update proof" API query.
@@ -16,10 +17,27 @@ class UpdateProofParameters extends JsonObject {
   /// Currency of the price.
   Currency? currency;
 
+  /// ID of the location in OpenStreetMap.
+  int? locationOSMId;
+
+  /// Type of the OpenStreetMap location object.
+  LocationOSMType? locationOSMType;
+
+  /// Receipt's number of prices.
+  int? receiptPriceCount;
+
+  /// Receipt's total amount (user input).
+  num? receiptPriceTotal;
+
   @override
   Map<String, dynamic> toJson() => <String, dynamic>{
         if (type != null) 'type': type!.offTag,
         if (date != null) 'date': GetParametersHelper.formatDate(date!),
         if (currency != null) 'currency': currency!.name,
+        if (locationOSMId != null) 'location_osm_id': locationOSMId,
+        if (locationOSMType != null)
+          'location_osm_type': locationOSMType!.offTag,
+        if (receiptPriceCount != null) 'receipt_price_count': receiptPriceCount,
+        if (receiptPriceTotal != null) 'receipt_price_total': receiptPriceTotal,
       };
 }