Package dev.vality.swag.analytics.api

Interface ReportsApi

All Known Implementing Classes:

ReportsApiController

@Generated(value="io.swagger.codegen.languages.SpringCodegen",
           date="2022-03-18T10:44:56.284Z")
public interface ReportsApi

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	log

Method Summary

Modifier and Type	Method	Description
default org.springframework.http.ResponseEntity<Void>	cancelReport(String xRequestID, Long reportID, String xRequestDeadline)
default org.springframework.http.ResponseEntity<Report>	createReport(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String reportType, String xRequestDeadline, String shopID)
default org.springframework.http.ResponseEntity<ReportLink>	downloadFile(String xRequestID, Long reportID, String fileID, String xRequestDeadline)
default Optional<String>	getAcceptHeader()
default Optional<com.fasterxml.jackson.databind.ObjectMapper>	getObjectMapper()
default org.springframework.http.ResponseEntity<Report>	getReport(String xRequestID, Long reportID, String xRequestDeadline)
default Optional<javax.servlet.http.HttpServletRequest>	getRequest()
default org.springframework.http.ResponseEntity<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)

Field Details

log

static final org.slf4j.Logger log

Method Details

getObjectMapper

default Optional<com.fasterxml.jackson.databind.ObjectMapper> getObjectMapper()

getRequest

default Optional<javax.servlet.http.HttpServletRequest> getRequest()

getAcceptHeader

default Optional<String> getAcceptHeader()

cancelReport

@RequestMapping(value="/reports/{reportID}/cancel",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=POST)
default org.springframework.http.ResponseEntity<Void> cancelReport(@RequestHeader(value="X-Request-ID",required=true)
String xRequestID,
@PathVariable("reportID")
Long reportID,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline)

createReport

@RequestMapping(value="/reports",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=POST)
default org.springframework.http.ResponseEntity<Report> createReport(@RequestHeader(value="X-Request-ID",required=true)
String xRequestID,
@NotNull @Size(min=1,max=40) @RequestParam(value="partyID",required=true)
String partyID,
@NotNull @RequestParam(value="fromTime",required=true)
OffsetDateTime fromTime,
@NotNull @RequestParam(value="toTime",required=true)
OffsetDateTime toTime,
@NotNull @RequestParam(value="reportType",required=true)
String reportType,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@Size(min=1,max=40) @RequestParam(value="shopID",required=false)
String shopID)

downloadFile

@RequestMapping(value="/reports/{reportID}/files/{fileID}/download",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<ReportLink> downloadFile(@RequestHeader(value="X-Request-ID",required=true)
String xRequestID,
@PathVariable("reportID")
Long reportID,
@Size(min=1,max=40) @PathVariable("fileID")
String fileID,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline)

getReport

@RequestMapping(value="/reports/{reportID}",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<Report> getReport(@RequestHeader(value="X-Request-ID",required=true)
String xRequestID,
@PathVariable("reportID")
Long reportID,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline)

searchReports

@RequestMapping(value="/reports",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse20013> searchReports(@RequestHeader(value="X-Request-ID",required=true)
String xRequestID,
@NotNull @Size(min=1,max=40) @RequestParam(value="partyID",required=true)
String partyID,
@NotNull @RequestParam(value="fromTime",required=true)
OffsetDateTime fromTime,
@NotNull @RequestParam(value="toTime",required=true)
OffsetDateTime toTime,
@NotNull @RequestParam(value="reportTypes",required=true)
List<String> reportTypes,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@Size(min=1,max=40) @RequestParam(value="shopID",required=false)
String shopID,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm,
@Min(1L) @Max(1000L) @RequestParam(value="limit",required=false)
Integer limit,
@RequestParam(value="continuationToken",required=false)
String continuationToken)