All Known Implementing Classes:: ReportsApiController

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2023-07-07T08:12:11.951968249Z[Etc/UTC]")
@Validated
public interface ReportsApi

Method Summary

Modifier and Type	Method	Description
`default org.springframework.http.ResponseEntity<Void>`	`cancelReport(String xRequestID, @NotNull @Size(min=1,max=40) @Valid String partyID, Long reportID, String xRequestDeadline)`	POST /reports/{reportID}/cancel : Отменить указанный отчет.
`default org.springframework.http.ResponseEntity<Report>`	`createReport(String xRequestID, @NotNull @Size(min=1,max=40) @Valid String partyID, @NotNull @Valid OffsetDateTime fromTime, @NotNull @Valid OffsetDateTime toTime, @NotNull @Valid String reportType, String xRequestDeadline, @Size(min=1,max=40) @Valid String shopID)`	POST /reports : Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени
`default org.springframework.http.ResponseEntity<ReportLink>`	`downloadFile(String xRequestID, @NotNull @Size(min=1,max=40) @Valid String partyID, Long reportID, @Size(min=1,max=40) String fileID, String xRequestDeadline)`	GET /reports/{reportID}/files/{fileID}/download : Скачать файл Скачать файл
`default ReportsApiDelegate`	`getDelegate()`
`default org.springframework.http.ResponseEntity<Report>`	`getReport(String xRequestID, @NotNull @Size(min=1,max=40) @Valid String partyID, Long reportID, String xRequestDeadline)`	GET /reports/{reportID} : Получить отчет по данному идентификатору Получить отчет по данному идентификатору
`default org.springframework.http.ResponseEntity<InlineResponse20014>`	`searchReports(String xRequestID, @NotNull @Size(min=1,max=40) @Valid String partyID, @NotNull @Valid OffsetDateTime fromTime, @NotNull @Valid OffsetDateTime toTime, @NotNull @Min(1L) @Max(1000L) @Valid Integer limit, @NotNull @Valid List<String> reportTypes, String xRequestDeadline, @Size(min=1,max=40) @Valid String shopID, @Valid String paymentInstitutionRealm, @Valid String continuationToken)`	GET /reports : Получить список отчетов по данному магазину за период Получить список отчетов по данному магазину за период

Method Details
- getDelegate
  
  default ReportsApiDelegate getDelegate()
- cancelReport
  
  @RequestMapping(method=POST, value="/reports/{reportID}/cancel", produces="application/json; charset=utf-8") default org.springframework.http.ResponseEntity<Void> cancelReport(@RequestHeader(value="X-Request-ID",required=true) String xRequestID, @NotNull @Size(min=1,max=40) @Valid @RequestParam(value="partyID",required=true) @NotNull @Size(min=1,max=40) @Valid String partyID, @PathVariable("reportID") Long reportID, @RequestHeader(value="X-Request-Deadline",required=false) String xRequestDeadline)
  
  POST /reports/{reportID}/cancel : Отменить указанный отчет. Отчеты типа `provisionOfService` отменить нельзя Отменить указанный отчет. Отчеты типа `provisionOfService` отменить нельзя
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе (required)
  
  partyID - Уникальный идентификатор участника в рамках платформы (required)
  
  reportID - Идентификатор отчета (required)
  
  xRequestDeadline - Максимальное время обработки запроса (optional)
  
  Returns:
  
  Запрос на отмену отчета принят (status code 202) or Неверные данные (status code 400) or Ошибка авторизации (status code 401) or Заданный ресурс не найден (status code 404)
- createReport
  
  @RequestMapping(method=POST, value="/reports", produces="application/json; charset=utf-8") default org.springframework.http.ResponseEntity<Report> createReport(@RequestHeader(value="X-Request-ID",required=true) String xRequestID, @NotNull @Size(min=1,max=40) @Valid @RequestParam(value="partyID",required=true) @NotNull @Size(min=1,max=40) @Valid String partyID, @NotNull @Valid @RequestParam(value="fromTime",required=true) @DateTimeFormat(iso=DATE_TIME) @NotNull @Valid OffsetDateTime fromTime, @NotNull @Valid @RequestParam(value="toTime",required=true) @DateTimeFormat(iso=DATE_TIME) @NotNull @Valid OffsetDateTime toTime, @NotNull @Valid @RequestParam(value="reportType",required=true) @NotNull @Valid String reportType, @RequestHeader(value="X-Request-Deadline",required=false) String xRequestDeadline, @Size(min=1,max=40) @Valid @RequestParam(value="shopID",required=false) @Size(min=1,max=40) @Valid String shopID)
  
  POST /reports : Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе (required)
  
  partyID - Уникальный идентификатор участника в рамках платформы (required)
  
  fromTime - Начало временного отрезка (required)
  
  toTime - Конец временного отрезка (required)
  
  reportType - Тип отчета (required)
  
  xRequestDeadline - Максимальное время обработки запроса (optional)
  
  shopID - Идентификатор магазина (optional)
  
  Returns:
  
  Отчет создан (status code 201) or Ошибочные данные для генерации (status code 400) or Ошибка авторизации (status code 401)
- downloadFile
  
  @RequestMapping(method=GET, value="/reports/{reportID}/files/{fileID}/download", produces="application/json; charset=utf-8") default org.springframework.http.ResponseEntity<ReportLink> downloadFile(@RequestHeader(value="X-Request-ID",required=true) String xRequestID, @NotNull @Size(min=1,max=40) @Valid @RequestParam(value="partyID",required=true) @NotNull @Size(min=1,max=40) @Valid String partyID, @PathVariable("reportID") Long reportID, @Size(min=1,max=40) @PathVariable("fileID") @Size(min=1,max=40) String fileID, @RequestHeader(value="X-Request-Deadline",required=false) String xRequestDeadline)
  
  GET /reports/{reportID}/files/{fileID}/download : Скачать файл Скачать файл
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе (required)
  
  partyID - Уникальный идентификатор участника в рамках платформы (required)
  
  reportID - Идентификатор отчета (required)
  
  fileID - Идентификатор файла (required)
  
  xRequestDeadline - Максимальное время обработки запроса (optional)
  
  Returns:
  
  Download link (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401) or Заданный ресурс не найден (status code 404)
- getReport
  
  @RequestMapping(method=GET, value="/reports/{reportID}", produces="application/json; charset=utf-8") default org.springframework.http.ResponseEntity<Report> getReport(@RequestHeader(value="X-Request-ID",required=true) String xRequestID, @NotNull @Size(min=1,max=40) @Valid @RequestParam(value="partyID",required=true) @NotNull @Size(min=1,max=40) @Valid String partyID, @PathVariable("reportID") Long reportID, @RequestHeader(value="X-Request-Deadline",required=false) String xRequestDeadline)
  
  GET /reports/{reportID} : Получить отчет по данному идентификатору Получить отчет по данному идентификатору
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе (required)
  
  partyID - Уникальный идентификатор участника в рамках платформы (required)
  
  reportID - Идентификатор отчета (required)
  
  xRequestDeadline - Максимальное время обработки запроса (optional)
  
  Returns:
  
  Найденный отчет (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401) or Заданный ресурс не найден (status code 404)
- searchReports
  
  @RequestMapping(method=GET, value="/reports", produces="application/json; charset=utf-8") default org.springframework.http.ResponseEntity<InlineResponse20014> searchReports(@RequestHeader(value="X-Request-ID",required=true) String xRequestID, @NotNull @Size(min=1,max=40) @Valid @RequestParam(value="partyID",required=true) @NotNull @Size(min=1,max=40) @Valid String partyID, @NotNull @Valid @RequestParam(value="fromTime",required=true) @DateTimeFormat(iso=DATE_TIME) @NotNull @Valid OffsetDateTime fromTime, @NotNull @Valid @RequestParam(value="toTime",required=true) @DateTimeFormat(iso=DATE_TIME) @NotNull @Valid OffsetDateTime toTime, @NotNull @Min(1L) @Max(1000L) @Valid @RequestParam(value="limit",required=true) @NotNull @Min(1L) @Max(1000L) @Valid Integer limit, @NotNull @Valid @RequestParam(value="reportTypes",required=true) @NotNull @Valid List<String> reportTypes, @RequestHeader(value="X-Request-Deadline",required=false) String xRequestDeadline, @Size(min=1,max=40) @Valid @RequestParam(value="shopID",required=false) @Size(min=1,max=40) @Valid String shopID, @Valid @RequestParam(value="paymentInstitutionRealm",required=false) @Valid String paymentInstitutionRealm, @Valid @RequestParam(value="continuationToken",required=false) @Valid String continuationToken)
  
  GET /reports : Получить список отчетов по данному магазину за период Получить список отчетов по данному магазину за период
  
  Parameters:
  
  xRequestID - Уникальный идентификатор запроса к системе (required)
  
  partyID - Уникальный идентификатор участника в рамках платформы (required)
  
  fromTime - Начало временного отрезка (required)
  
  toTime - Конец временного отрезка (required)
  
  limit - Лимит выборки (required)
  
  reportTypes - Типы отчетов (required)
  
  xRequestDeadline - Максимальное время обработки запроса (optional)
  
  shopID - Идентификатор магазина (optional)
  
  paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)
  
  continuationToken - (optional)
  
  Returns:
  
  Найденные отчеты (status code 200) or Ошибочные данные для получения (status code 400) or Ошибка авторизации (status code 401)

Interface ReportsApi

Method Summary

Method Details

getDelegate

cancelReport

createReport

downloadFile

getReport

searchReports