Package dev.vality.swag.analytics.api

Interface AnalyticsApi

All Known Implementing Classes:

AnalyticsApiController

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
default Optional<String>	getAcceptHeader()
default org.springframework.http.ResponseEntity<InlineResponse2001>	getAveragePayment(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default org.springframework.http.ResponseEntity<InlineResponse2001>	getCurrentBalances(String xRequestID, String partyID, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default org.springframework.http.ResponseEntity<InlineResponse200>	getCurrentBalancesGroupByShop(String xRequestID, String partyID, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs)
default Optional<com.fasterxml.jackson.databind.ObjectMapper>	getObjectMapper()
default org.springframework.http.ResponseEntity<InlineResponse2001>	getPaymentsAmount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default org.springframework.http.ResponseEntity<InlineResponse2003>	getPaymentsCount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default org.springframework.http.ResponseEntity<InlineResponse2004>	getPaymentsErrorDistribution(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default org.springframework.http.ResponseEntity<InlineResponse2005>	getPaymentsSplitAmount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String splitUnit, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default org.springframework.http.ResponseEntity<InlineResponse2006>	getPaymentsSplitCount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String splitUnit, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default org.springframework.http.ResponseEntity<InlineResponse2007>	getPaymentsSubErrorDistribution(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default org.springframework.http.ResponseEntity<InlineResponse2002>	getPaymentsToolDistribution(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default org.springframework.http.ResponseEntity<InlineResponse2001>	getRefundsAmount(String xRequestID, String partyID, OffsetDateTime fromTime, OffsetDateTime toTime, String xRequestDeadline, List<String> shopIDs, List<String> excludeShopIDs, String paymentInstitutionRealm)
default Optional<javax.servlet.http.HttpServletRequest>	getRequest()

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()

getAveragePayment

@RequestMapping(value="/analytics/payments/average",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2001> getAveragePayment(@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,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)

getCurrentBalances

@RequestMapping(value="/analytics/balances/current",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2001> getCurrentBalances(@RequestHeader(value="X-Request-ID",required=true)
String xRequestID,
@NotNull @Size(min=1,max=40) @RequestParam(value="partyID",required=true)
String partyID,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)

getCurrentBalancesGroupByShop

@RequestMapping(value="/analytics/balances/current-shop-balances",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse200> getCurrentBalancesGroupByShop(@RequestHeader(value="X-Request-ID",required=true)
String xRequestID,
@NotNull @Size(min=1,max=40) @RequestParam(value="partyID",required=true)
String partyID,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs)

getPaymentsAmount

@RequestMapping(value="/analytics/payments/amount",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2001> getPaymentsAmount(@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,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)

getPaymentsCount

@RequestMapping(value="/analytics/payments/count",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2003> getPaymentsCount(@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,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)

getPaymentsErrorDistribution

@RequestMapping(value="/analytics/payments/errors",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2004> getPaymentsErrorDistribution(@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,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)

getPaymentsSplitAmount

@RequestMapping(value="/analytics/payments/split-amount",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2005> getPaymentsSplitAmount(@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="splitUnit",required=true)
String splitUnit,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)

getPaymentsSplitCount

@RequestMapping(value="/analytics/payments/split-count",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2006> getPaymentsSplitCount(@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="splitUnit",required=true)
String splitUnit,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)

getPaymentsSubErrorDistribution

@RequestMapping(value="/analytics/payments/sub-errors",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2007> getPaymentsSubErrorDistribution(@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,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)

getPaymentsToolDistribution

@RequestMapping(value="/analytics/payments-tool",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2002> getPaymentsToolDistribution(@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,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)

getRefundsAmount

@RequestMapping(value="/analytics/refunds/amount",
                produces="application/json; charset=utf-8",
                consumes="application/json; charset=utf-8",
                method=GET)
default org.springframework.http.ResponseEntity<InlineResponse2001> getRefundsAmount(@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,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@RequestParam(value="shopIDs",required=false)
List<String> shopIDs,
@RequestParam(value="excludeShopIDs",required=false)
List<String> excludeShopIDs,
@RequestParam(value="paymentInstitutionRealm",required=false)
String paymentInstitutionRealm)