Package dev.vality.anapi.v2.api

Interface AnalyticsApiDelegate

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2023-07-07T08:12:11.951968249Z[Etc/UTC]")
public interface AnalyticsApiDelegate
A delegate to be called by the AnalyticsApiController}. Implement this interface with a Service annotated class.

  • Method Summary

    Modifier and Type Method Description
    default org.springframework.http.ResponseEntity<InlineResponse200> getAveragePayment​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/payments/average : Получение среднего размера платежа с группировкой по валютам Получение среднего размера платежа с группировкой по валютам
    default org.springframework.http.ResponseEntity<InlineResponse200> getCreditingsAmount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/crediting/amount : Получение списка зачислений с группировкой по валютам для ЛК Получение списка зачислений с группировкой по валютам для ЛК
    default org.springframework.http.ResponseEntity<InlineResponse200> getCurrentBalances​(String xRequestID, String partyID, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/balances/current : Получение текущего баланса по магазину Получение текущего баланса по магазину
    default org.springframework.http.ResponseEntity<InlineResponse2007> getCurrentShopBalances​(String xRequestID, String partyID, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/balances/current-shop-balances : Получение текущего баланса с группировкой по магазинам Получение текущего баланса с группировкой по магазинам
    default org.springframework.http.ResponseEntity<InlineResponse200> getPaymentsAmount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/payments/amount : Получение списка оборотов с группировкой по валютам Получение списка оборотов с группировкой по валютам
    default org.springframework.http.ResponseEntity<InlineResponse2001> getPaymentsCount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/payments/count : Получение количества платежей с группировкой по валютам Получение количества платежей с группировкой по валютам
    default org.springframework.http.ResponseEntity<InlineResponse2002> getPaymentsErrorDistribution​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/payments/errors : Получение распределения ошибок Получение распределения ошибок
    default org.springframework.http.ResponseEntity<InlineResponse2003> getPaymentsSplitAmount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String splitUnit, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/payments/split-amount : Получение списка оборотов с группировкой по валютам и разделенные по временным интервалам Получение списка оборотов с группировкой по валютам и разделенные по временным интервалам
    default org.springframework.http.ResponseEntity<InlineResponse2004> getPaymentsSplitCount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String splitUnit, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/payments/split-count : Получение количества платежей с группировкой по валютам и статусам, разделенного по временным интервалам Получение количества платежей с группировкой по валютам и статусам, разделенного по временным интервалам
    default org.springframework.http.ResponseEntity<InlineResponse2005> getPaymentsSubErrorDistribution​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/payments/sub-errors : Получение распределения ошибок с подошибками Получение распределения ошибок с подошибками
    default org.springframework.http.ResponseEntity<InlineResponse2006> getPaymentsToolDistribution​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/payments-tool : Получение распределения использования платежных инструментов Получение распределения использования платежных инструментов
    default org.springframework.http.ResponseEntity<InlineResponse200> getRefundsAmount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
    GET /analytics/refunds/amount : Получение списка возвратов с группировкой по валютам Получение списка возвратов с группировкой по валютам
    default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()  

  • Method Details

    • getRequest

      default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()

    • getAveragePayment

      default org.springframework.http.ResponseEntity<InlineResponse200> getAveragePayment​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/payments/average : Получение среднего размера платежа с группировкой по валютам Получение среднего размера платежа с группировкой по валютам
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Средний размер платежа с группировкой по валютам (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getAveragePayment(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getCreditingsAmount

      default org.springframework.http.ResponseEntity<InlineResponse200> getCreditingsAmount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/crediting/amount : Получение списка зачислений с группировкой по валютам для ЛК Получение списка зачислений с группировкой по валютам для ЛК
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Список зачислений с группировкой по валютам для ЛК (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getCreditingsAmount(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getCurrentBalances

      default org.springframework.http.ResponseEntity<InlineResponse200> getCurrentBalances​(String xRequestID, String partyID, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/balances/current : Получение текущего баланса по магазину Получение текущего баланса по магазину
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Список оборотов с группировкой по валютам (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getCurrentBalances(java.lang.String, java.lang.String, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getCurrentShopBalances

      default org.springframework.http.ResponseEntity<InlineResponse2007> getCurrentShopBalances​(String xRequestID, String partyID, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/balances/current-shop-balances : Получение текущего баланса с группировкой по магазинам Получение текущего баланса с группировкой по магазинам
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Список балансов с группировкой по магазинам (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getCurrentShopBalances(java.lang.String, java.lang.String, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getPaymentsAmount

      default org.springframework.http.ResponseEntity<InlineResponse200> getPaymentsAmount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/payments/amount : Получение списка оборотов с группировкой по валютам Получение списка оборотов с группировкой по валютам
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Список оборотов с группировкой по валютам (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getPaymentsAmount(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getPaymentsCount

      default org.springframework.http.ResponseEntity<InlineResponse2001> getPaymentsCount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/payments/count : Получение количества платежей с группировкой по валютам Получение количества платежей с группировкой по валютам
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Среднее количество платежей с группировкой по валютам (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getPaymentsCount(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getPaymentsErrorDistribution

      default org.springframework.http.ResponseEntity<InlineResponse2002> getPaymentsErrorDistribution​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/payments/errors : Получение распределения ошибок Получение распределения ошибок
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Распределение ошибок (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getPaymentsErrorDistribution(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getPaymentsSplitAmount

      default org.springframework.http.ResponseEntity<InlineResponse2003> getPaymentsSplitAmount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String splitUnit, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/payments/split-amount : Получение списка оборотов с группировкой по валютам и разделенные по временным интервалам Получение списка оборотов с группировкой по валютам и разделенные по временным интервалам
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      splitUnit - Единица времени сегмента разбиения (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Список оборотов с группировкой по валютам и разделенные по временным интервалам (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getPaymentsSplitAmount(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getPaymentsSplitCount

      default org.springframework.http.ResponseEntity<InlineResponse2004> getPaymentsSplitCount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String splitUnit, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/payments/split-count : Получение количества платежей с группировкой по валютам и статусам, разделенного по временным интервалам Получение количества платежей с группировкой по валютам и статусам, разделенного по временным интервалам
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      splitUnit - Единица времени сегмента разбиения (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Количество платежей с группировкой по валютам и статусам, разделенное по временным интервалам (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getPaymentsSplitCount(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getPaymentsSubErrorDistribution

      default org.springframework.http.ResponseEntity<InlineResponse2005> getPaymentsSubErrorDistribution​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/payments/sub-errors : Получение распределения ошибок с подошибками Получение распределения ошибок с подошибками
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Распределение ошибок с подошибками (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getPaymentsSubErrorDistribution(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getPaymentsToolDistribution

      default org.springframework.http.ResponseEntity<InlineResponse2006> getPaymentsToolDistribution​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/payments-tool : Получение распределения использования платежных инструментов Получение распределения использования платежных инструментов
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Распределение использования платежных инструментов (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getPaymentsToolDistribution(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)

    • getRefundsAmount

      default org.springframework.http.ResponseEntity<InlineResponse200> getRefundsAmount​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
      GET /analytics/refunds/amount : Получение списка возвратов с группировкой по валютам Получение списка возвратов с группировкой по валютам
      Parameters:
      xRequestID - Уникальный идентификатор запроса к системе (required)
      partyID - Уникальный идентификатор участника в рамках платформы (required)
      fromTime - Начало временного отрезка (required)
      toTime - Конец временного отрезка (required)
      xRequestDeadline - Максимальное время обработки запроса (optional)
      shopIDs - Идентификаторы магазинов (optional)
      excludeShopIDs - Идентификаторы магазинов, исключаемых из запроса (optional)
      paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
      Returns:
      Список возвратов с группировкой по валютам (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)
      See Also:
      AnalyticsApi.getRefundsAmount(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.String)