com.mangopay.core.APIs.implementation

Class ReportApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.ReportApiImpl

All Implemented Interfaces:

ReportApi

public class ReportApiImpl
extends ApiBase
implements ReportApi

API for reports.

Field Summary

Fields inherited from class com.mangopay.core.APIs.ApiBase

root

Constructor Summary

Constructors

Constructor and Description
ReportApiImpl(MangoPayApi root) Instantiates new ReportApiImpl object.

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.

Methods inherited from class com.mangopay.core.APIs.ApiBase

createObject, createObject, createObject, getList, getList, getList, getList, getList, getList, getListNoClientId, getObject, getObjectNoClientId, getRequestType, getRequestUrl, getRoot, updateObject, updateObject, updateObject, updateObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportApiImpl

public ReportApiImpl(MangoPayApi root)

Instantiates new ReportApiImpl object.

Parameters:

root - Root/parent instance that holds the OAuthToken and Configuration instance.

Method Detail

create

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

Description copied from interface: ReportApi

Creates new report request.

Specified by:

create in interface ReportApi

Parameters:

reportRequest - Report request details for creation

Returns:

Newly-created ReportRequest

Throws:

java.lang.Exception

create

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

Description copied from interface: ReportApi

Creates new report request.

Specified by:

create in interface ReportApi

Parameters:

idempotencyKey - Idempotency key

reportRequest - Report request details for creation

Returns:

Newly-created ReportRequest

Throws:

java.lang.Exception

createWalletReport

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

Description copied from interface: ReportApi

Request creation of a report for wallets.

Specified by:

createWalletReport in interface ReportApi

Parameters:

reportRequest - The report request details

Returns:

Newly-created wallet report request

Throws:

java.lang.Exception

get

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

Description copied from interface: ReportApi

Gets a report request by its unique identifier.

Specified by:

get in interface ReportApi

Parameters:

reportId - Unique report identifier

Returns:

Corresponding ReportRequest

Throws:

java.lang.Exception

getAll

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

Description copied from interface: ReportApi

Gets a list of all report requests.

Specified by:

getAll in interface ReportApi

Parameters:

pagination - Pagination object

filters - Filtering object

sort - Sorting object

Returns:

List of matching ReportRequests

Throws:

java.lang.Exception

getAll

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

Description copied from interface: ReportApi

Gets a list of all report requests.

Specified by:

getAll in interface ReportApi

Returns:

List of ReportRequests

Throws:

java.lang.Exception