Package dev.vality.swag.analytics.api

Class AnalyticsApi

java.lang.Object

dev.vality.swag.analytics.api.AnalyticsApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-03-18T10:45:05.280Z")
@Component("dev.vality.swag.analytics.api.AnalyticsApi")
public class AnalyticsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AnalyticsApi()
AnalyticsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
InlineResponse2001	getAveragePayment(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение среднего размера платежа с группировкой по валютам
InlineResponse2001	getCurrentBalances(String xRequestID, String partyID, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение текущего баланса по магазину
InlineResponse200	getCurrentBalancesGroupByShop(String xRequestID, String partyID, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs)	Получение текущего баланса с группировкой по магазинам
InlineResponse2001	getPaymentsAmount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение списка оборотов с группировкой по валютам
InlineResponse2003	getPaymentsCount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение количества платежей с группировкой по валютам
InlineResponse2004	getPaymentsErrorDistribution(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение распределения ошибок
InlineResponse2005	getPaymentsSplitAmount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String splitUnit, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение списка оборотов с группировкой по валютам и разделенные по временным интервалам
InlineResponse2006	getPaymentsSplitCount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String splitUnit, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение количества платежей с группировкой по валютам и статусам, разделенного по временным интервалам
InlineResponse2007	getPaymentsSubErrorDistribution(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение распределения ошибок с подошибками
InlineResponse2002	getPaymentsToolDistribution(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение распределения использования платежных инструментов
InlineResponse2001	getRefundsAmount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)	Получение списка возвратов с группировкой по валютам
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AnalyticsApi

public AnalyticsApi()

AnalyticsApi

@Autowired
public AnalyticsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAveragePayment

public InlineResponse2001 getAveragePayment(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                     throws org.springframework.web.client.RestClientException

Получение среднего размера платежа с группировкой по валютам

200 - Средний размер платежа с группировкой по валютам

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

fromTime - Начало временного отрезка

toTime - Конец временного отрезка

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2001

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getCurrentBalances

public InlineResponse2001 getCurrentBalances(String xRequestID,
String partyID,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                      throws org.springframework.web.client.RestClientException

Получение текущего баланса по магазину

200 - Список оборотов с группировкой по валютам

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2001

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getCurrentBalancesGroupByShop

public InlineResponse200 getCurrentBalancesGroupByShop(String xRequestID,
String partyID,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs)
                                                throws org.springframework.web.client.RestClientException

Получение текущего баланса с группировкой по магазинам

200 - Список балансов с группировкой по магазинам

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

Returns:

InlineResponse200

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPaymentsAmount

public InlineResponse2001 getPaymentsAmount(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                     throws org.springframework.web.client.RestClientException

Получение списка оборотов с группировкой по валютам

200 - Список оборотов с группировкой по валютам

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

fromTime - Начало временного отрезка

toTime - Конец временного отрезка

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2001

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPaymentsCount

public InlineResponse2003 getPaymentsCount(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                    throws org.springframework.web.client.RestClientException

Получение количества платежей с группировкой по валютам

200 - Среднее количество платежей с группировкой по валютам

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

fromTime - Начало временного отрезка

toTime - Конец временного отрезка

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2003

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPaymentsErrorDistribution

public InlineResponse2004 getPaymentsErrorDistribution(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                                throws org.springframework.web.client.RestClientException

Получение распределения ошибок

200 - Распределение ошибок

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

fromTime - Начало временного отрезка

toTime - Конец временного отрезка

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2004

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPaymentsSplitAmount

public InlineResponse2005 getPaymentsSplitAmount(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String splitUnit,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                          throws org.springframework.web.client.RestClientException

Получение списка оборотов с группировкой по валютам и разделенные по временным интервалам

200 - Список оборотов с группировкой по валютам и разделенные по временным интервалам

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

fromTime - Начало временного отрезка

toTime - Конец временного отрезка

splitUnit - Единица времени сегмента разбиения

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2005

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPaymentsSplitCount

public InlineResponse2006 getPaymentsSplitCount(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String splitUnit,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                         throws org.springframework.web.client.RestClientException

Получение количества платежей с группировкой по валютам и статусам, разделенного по временным интервалам

200 - Количество платежей с группировкой по валютам и статусам, разделенное по временным интервалам

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

fromTime - Начало временного отрезка

toTime - Конец временного отрезка

splitUnit - Единица времени сегмента разбиения

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2006

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPaymentsSubErrorDistribution

public InlineResponse2007 getPaymentsSubErrorDistribution(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                                   throws org.springframework.web.client.RestClientException

Получение распределения ошибок с подошибками

200 - Распределение ошибок с подошибками

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

fromTime - Начало временного отрезка

toTime - Конец временного отрезка

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2007

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getPaymentsToolDistribution

public InlineResponse2002 getPaymentsToolDistribution(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                               throws org.springframework.web.client.RestClientException

Получение распределения использования платежных инструментов

200 - Распределение использования платежных инструментов

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

fromTime - Начало временного отрезка

toTime - Конец временного отрезка

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2002

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getRefundsAmount

public InlineResponse2001 getRefundsAmount(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String xRequestDeadline,
List<String> shopIDs,
List<String> excludeShopIDs,
String paymentInstitutionRealm)
                                    throws org.springframework.web.client.RestClientException

Получение списка возвратов с группировкой по валютам

200 - Список возвратов с группировкой по валютам

400 - Неверные данные

401 - Ошибка авторизации

404 - Заданный ресурс не найден

Parameters:

xRequestID - Уникальный идентификатор запроса к системе

partyID - Уникальный идентификатор участника в рамках платформы

fromTime - Начало временного отрезка

toTime - Конец временного отрезка

xRequestDeadline - Максимальное время обработки запроса

shopIDs - Идентификаторы магазинов

excludeShopIDs - Идентификаторы магазинов не включаемые в запрос

paymentInstitutionRealm - Тип магазина, тестовый или «боевой»

Returns:

InlineResponse2001

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API