/*
   This file is part of TALER
   Copyright (C) 2025 Taler Systems SA

   TALER is free software; you can redistribute it and/or modify it under the
   terms of the GNU General Public License as published by the Free Software
   Foundation; either version 3, or (at your option) any later version.

   TALER is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

   You should have received a copy of the GNU General Public License along with
   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
 */
/**
 * @file src/include/merchant-database/iterate_statistic_bucket_amounts_by_range.h
 * @brief implementation of the iterate_statistic_bucket_amounts_by_range function for Postgres
 * @author Christian Grothoff
 */
#ifndef MERCHANT_DATABASE_ITERATE_STATISTIC_BUCKET_AMOUNTS_BY_RANGE_H
#define MERCHANT_DATABASE_ITERATE_STATISTIC_BUCKET_AMOUNTS_BY_RANGE_H

#include <taler/taler_util.h>
#include <taler/taler_json_lib.h>
#include "merchantdb_lib.h"


struct TALER_MERCHANTDB_PostgresContext;
/* Callback typedefs */
/**
 * Returns amount-valued statistics by bucket.
 * Called by `iterate_statistic_bucket_amounts`.
 *
 * @param cls closure
 * @param description description of the statistic
 * @param bucket_start start time of the bucket
 * @param bucket_end end time of the bucket
 * @param bucket_range range of the bucket
 * @param cumulative_amounts_len the length of @a cumulative_amounts
 * @param cumulative_amounts the cumulative amounts array
 */
typedef void
(*TALER_MERCHANTDB_AmountByBucketStatisticsCallback)(
  void *cls,
  const char *description,
  struct GNUNET_TIME_Timestamp bucket_start,
  struct GNUNET_TIME_Timestamp bucket_end,
  const char *bucket_range,
  unsigned int cumulative_amounts_len,
  const struct TALER_Amount cumulative_amounts[static cumulative_amounts_len]);

/**
 * Returns amount-valued statistics by bucket.
 * Called by `iterate_statistic_bucket_amounts_by_range`.
 *
 * @param cls closure
 * @param bucket_start start time of the bucket
 * @param cumulative_amounts_len the length of @a cumulative_amounts
 * @param cumulative_amounts the cumulative amounts array
 */
typedef void
(*TALER_MERCHANTDB_AmountByBucketRangeStatisticsCallback)(
  void *cls,
  struct GNUNET_TIME_Timestamp bucket_start,
  unsigned int cumulative_amounts_len,
  const struct TALER_Amount cumulative_amounts[static cumulative_amounts_len]);

/**
 * Lookup amount statistics for instance and slug by bucket,
 * restricting to a fixed number of buckets at a given granularity.
 *
 * @param pg database context
 * @param instance_id instance to lookup statistics for
 * @param slug instance to lookup statistics for
 * @param granularity limit to buckets of this size
 * @param counter requested number of buckets
 * @param cb function to call on all token families found
 * @param cb_cls closure for @a cb
 * @return database result code
 */
enum GNUNET_DB_QueryStatus
TALER_MERCHANTDB_iterate_statistic_bucket_amounts_by_range (struct
                                                            TALER_MERCHANTDB_PostgresContext *
                                                            pg,
                                                            const char *instance_id,
                                                            const char *slug,
                                                            const char *granularity,
                                                            uint64_t counter,
                                                            TALER_MERCHANTDB_AmountByBucketRangeStatisticsCallback
                                                            cb,
                                                            void *cb_cls);

#endif
