Package dev.vality.anapi.v2.api

Interface ReportsApiDelegate

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

  • Method Summary

    Modifier and Type Method Description
    default org.springframework.http.ResponseEntity<Void> cancelReport​(String xRequestID, String partyID, Long reportID, String xRequestDeadline)
    POST /reports/{reportID}/cancel : Отменить указанный отчет.
    default org.springframework.http.ResponseEntity<Report> createReport​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String reportType, String xRequestDeadline, String shopID)
    POST /reports : Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени
    default org.springframework.http.ResponseEntity<ReportLink> downloadFile​(String xRequestID, String partyID, Long reportID, String fileID, String xRequestDeadline)
    GET /reports/{reportID}/files/{fileID}/download : Скачать файл Скачать файл
    default org.springframework.http.ResponseEntity<Report> getReport​(String xRequestID, String partyID, Long reportID, String xRequestDeadline)
    GET /reports/{reportID} : Получить отчет по данному идентификатору Получить отчет по данному идентификатору
    default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()  
    default org.springframework.http.ResponseEntity<InlineResponse20014> searchReports​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, List<String> reportTypes, String xRequestDeadline, String shopID, String paymentInstitutionRealm, String continuationToken)
    GET /reports : Получить список отчетов по данному магазину за период Получить список отчетов по данному магазину за период

  • Method Details

    • getRequest

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

    • cancelReport

      default org.springframework.http.ResponseEntity<Void> cancelReport​(String xRequestID, String partyID, Long reportID, 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)
      See Also:
      ReportsApi.cancelReport(java.lang.String, java.lang.String, java.lang.Long, java.lang.String)

    • createReport

      default org.springframework.http.ResponseEntity<Report> createReport​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String reportType, String xRequestDeadline, 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)
      See Also:
      ReportsApi.createReport(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.String, java.lang.String, java.lang.String)

    • downloadFile

      default org.springframework.http.ResponseEntity<ReportLink> downloadFile​(String xRequestID, String partyID, Long reportID, String fileID, 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)
      See Also:
      ReportsApi.downloadFile(java.lang.String, java.lang.String, java.lang.Long, java.lang.String, java.lang.String)

    • getReport

      default org.springframework.http.ResponseEntity<Report> getReport​(String xRequestID, String partyID, Long reportID, 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)
      See Also:
      ReportsApi.getReport(java.lang.String, java.lang.String, java.lang.Long, java.lang.String)

    • searchReports

      default org.springframework.http.ResponseEntity<InlineResponse20014> searchReports​(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, Integer limit, List<String> reportTypes, String xRequestDeadline, String shopID, String paymentInstitutionRealm, 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)
      See Also:
      ReportsApi.searchReports(java.lang.String, java.lang.String, java.time.OffsetDateTime, java.time.OffsetDateTime, java.lang.Integer, java.util.List<java.lang.String>, java.lang.String, java.lang.String, java.lang.String, java.lang.String)