com.mangopay.core.APIs

Interface ReportApi

All Known Implementing Classes:

ReportApiImpl

public interface ReportApi

Created by thepa on 18-Jan-17.

Method Summary

Modifier and Type	Method and Description
ReportRequest	create(ReportRequest reportRequest) Creates new report request.
ReportRequest	create(java.lang.String idempotencyKey, ReportRequest reportRequest) Creates new report request.
ReportRequest	createWalletReport(ReportRequest reportRequest) Request creation of a report for wallets.
ReportRequest	get(java.lang.String reportId) Gets a report request by its unique identifier.
java.util.List<ReportRequest>	getAll() Gets a list of all report requests.
java.util.List<ReportRequest>	getAll(Pagination pagination, FilterReportsList filters, Sorting sort) Gets a list of all report requests.

Method Detail

create

ReportRequest create(ReportRequest reportRequest)
              throws java.lang.Exception

Creates new report request.

Parameters:

reportRequest - Report request details for creation

Returns:

Newly-created ReportRequest

Throws:

java.lang.Exception

create

ReportRequest create(java.lang.String idempotencyKey,
                     ReportRequest reportRequest)
              throws java.lang.Exception

Creates new report request.

Parameters:

idempotencyKey - Idempotency key

reportRequest - Report request details for creation

Returns:

Newly-created ReportRequest

Throws:

java.lang.Exception

createWalletReport

ReportRequest createWalletReport(ReportRequest reportRequest)
                          throws java.lang.Exception

Request creation of a report for wallets.

Parameters:

reportRequest - The report request details

Returns:

Newly-created wallet report request

Throws:

java.lang.Exception

get

ReportRequest get(java.lang.String reportId)
           throws java.lang.Exception

Gets a report request by its unique identifier.

Parameters:

reportId - Unique report identifier

Returns:

Corresponding ReportRequest

Throws:

java.lang.Exception

getAll

java.util.List<ReportRequest> getAll(Pagination pagination,
                                     FilterReportsList filters,
                                     Sorting sort)
                              throws java.lang.Exception

Gets a list of all report requests.

Parameters:

pagination - Pagination object

filters - Filtering object

sort - Sorting object

Returns:

List of matching ReportRequests

Throws:

java.lang.Exception

getAll

java.util.List<ReportRequest> getAll()
                              throws java.lang.Exception

Gets a list of all report requests.

Returns:

List of ReportRequests

Throws:

java.lang.Exception