Package dev.vality.swag.analytics.api

Class ReportsApi

java.lang.Object

dev.vality.swag.analytics.api.ReportsApi

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

Constructor Summary

Constructors

Constructor	Description
ReportsApi()
ReportsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	cancelReport(String xRequestID, Long reportID, String xRequestDeadline)	Отменить указанный отчет.
Report	createReport(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String reportType, String xRequestDeadline, String shopID)	Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени
ReportLink	downloadFile(String xRequestID, Long reportID, String fileID, String xRequestDeadline)	Скачать файл
ApiClient	getApiClient()
Report	getReport(String xRequestID, Long reportID, String xRequestDeadline)	Получить отчет по данному идентификатору
InlineResponse20013	searchReports(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, List<String> reportTypes, String xRequestDeadline, String shopID, List<String> shopIDs, String paymentInstitutionRealm, Integer limit, String continuationToken)	Получить список отчетов по данному магазину за период
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

ReportsApi

public ReportsApi()

ReportsApi

@Autowired
public ReportsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

cancelReport

public void cancelReport(String xRequestID,
Long reportID,
String xRequestDeadline)
                  throws org.springframework.web.client.RestClientException

Отменить указанный отчет. Отчеты типа `provisionOfService` отменить нельзя

202 - Запрос на отмену отчета принят

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

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

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

Parameters:

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

reportID - Идентификатор отчета

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

Throws:

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

createReport

public Report createReport(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
String reportType,
String xRequestDeadline,
String shopID)
                    throws org.springframework.web.client.RestClientException

Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени

201 - Отчет создан

400 - Ошибочные данные для генерации

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

Parameters:

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

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

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

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

reportType - Тип отчета

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

shopID - Идентификатор магазина

Returns:

Report

Throws:

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

downloadFile

public ReportLink downloadFile(String xRequestID,
Long reportID,
String fileID,
String xRequestDeadline)
                        throws org.springframework.web.client.RestClientException

Скачать файл

200 - Download link

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

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

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

Parameters:

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

reportID - Идентификатор отчета

fileID - Идентификатор файла

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

Returns:

ReportLink

Throws:

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

getReport

public Report getReport(String xRequestID,
Long reportID,
String xRequestDeadline)
                 throws org.springframework.web.client.RestClientException

Получить отчет по данному идентификатору

200 - Найденный отчет

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

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

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

Parameters:

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

reportID - Идентификатор отчета

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

Returns:

Report

Throws:

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

searchReports

public InlineResponse20013 searchReports(String xRequestID,
String partyID,
OffsetDateTime fromTime,
OffsetDateTime toTime,
List<String> reportTypes,
String xRequestDeadline,
String shopID,
List<String> shopIDs,
String paymentInstitutionRealm,
Integer limit,
String continuationToken)
                                  throws org.springframework.web.client.RestClientException

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

200 - Найденные отчеты

400 - Ошибочные данные для получения

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

Parameters:

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

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

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

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

reportTypes - Типы отчетов

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

shopID - Идентификатор магазина

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

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

limit - Лимит выборки

continuationToken - Токен, сигнализирующий о том, что в ответе передана только часть данных. Для получения следующей части нужно повторно обратиться к сервису, указав тот же набор условий и полученый токен. Если токена нет, получена последняя часть данных.

Returns:

InlineResponse20013

Throws:

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