ch.postfinance.sdk.service

Class RefundService

java.lang.Object

ch.postfinance.sdk.service.RefundService

public class RefundService
extends Object

Constructor Summary

Constructors

Constructor and Description
RefundService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Long	count(EntityQueryFilter filter, Long spaceId, Map<String,Object> params) Count Counts the number of items in the database as restricted by the given filter.
Long	count(Long spaceId, EntityQueryFilter filter) Count Counts the number of items in the database as restricted by the given filter.
com.google.api.client.http.HttpResponse	countForHttpResponse(EntityQueryFilter filter, Long spaceId, Map<String,Object> params)
com.google.api.client.http.HttpResponse	countForHttpResponse(Long spaceId, EntityQueryFilter filter)
com.google.api.client.http.HttpResponse	countForHttpResponse(Long spaceId, InputStream filter, String mediaType)
Refund	fail(Long spaceId, Long refundId) fail This operation allows to mark a refund as failed which is in state MANUAL_CHECK.
Refund	fail(Long spaceId, Long refundId, Map<String,Object> params) fail This operation allows to mark a refund as failed which is in state MANUAL_CHECK.
com.google.api.client.http.HttpResponse	failForHttpResponse(Long spaceId, Long refundId)
com.google.api.client.http.HttpResponse	failForHttpResponse(Long spaceId, Long refundId, Map<String,Object> params)
ApiClient	getApiClient()
RenderedDocument	getRefundDocument(Long spaceId, Long id) getRefundDocument Returns the PDF document for the refund with given id.
RenderedDocument	getRefundDocument(Long spaceId, Long id, Map<String,Object> params) getRefundDocument Returns the PDF document for the refund with given id.
com.google.api.client.http.HttpResponse	getRefundDocumentForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	getRefundDocumentForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
RenderedDocument	getRefundDocumentWithTargetMediaType(Long spaceId, Long id, Long targetMediaTypeId) getRefundDocumentWithTargetMediaType Returns the PDF document for the refund with given id and the given target media type.
RenderedDocument	getRefundDocumentWithTargetMediaType(Long spaceId, Long id, Long targetMediaTypeId, Map<String,Object> params) getRefundDocumentWithTargetMediaType Returns the PDF document for the refund with given id and the given target media type.
com.google.api.client.http.HttpResponse	getRefundDocumentWithTargetMediaTypeForHttpResponse(Long spaceId, Long id, Long targetMediaTypeId)
com.google.api.client.http.HttpResponse	getRefundDocumentWithTargetMediaTypeForHttpResponse(Long spaceId, Long id, Long targetMediaTypeId, Map<String,Object> params)
Refund	read(Long spaceId, Long id) Read Reads the entity with the given 'id' and returns it.
Refund	read(Long spaceId, Long id, Map<String,Object> params) Read Reads the entity with the given 'id' and returns it.
com.google.api.client.http.HttpResponse	readForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	readForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
Refund	refund(Long spaceId, RefundCreate refund) create This operation creates and executes a refund of a particular transaction.
Refund	refund(Long spaceId, RefundCreate refund, Map<String,Object> params) create This operation creates and executes a refund of a particular transaction.
com.google.api.client.http.HttpResponse	refundForHttpResponse(Long spaceId, InputStream refund, String mediaType)
com.google.api.client.http.HttpResponse	refundForHttpResponse(Long spaceId, RefundCreate refund)
com.google.api.client.http.HttpResponse	refundForHttpResponse(Long spaceId, RefundCreate refund, Map<String,Object> params)
List<Refund>	search(Long spaceId, EntityQuery query) Search Searches for the entities as specified by the given query.
List<Refund>	search(Long spaceId, EntityQuery query, Map<String,Object> params) Search Searches for the entities as specified by the given query.
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, EntityQuery query)
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, EntityQuery query, Map<String,Object> params)
com.google.api.client.http.HttpResponse	searchForHttpResponse(Long spaceId, InputStream query, String mediaType)
void	setApiClient(ApiClient apiClient)
Refund	succeed(Long spaceId, Long refundId) succeed This operation allows to mark a refund as successful which is in state MANUAL_CHECK.
Refund	succeed(Long spaceId, Long refundId, Map<String,Object> params) succeed This operation allows to mark a refund as successful which is in state MANUAL_CHECK.
com.google.api.client.http.HttpResponse	succeedForHttpResponse(Long spaceId, Long refundId)
com.google.api.client.http.HttpResponse	succeedForHttpResponse(Long spaceId, Long refundId, Map<String,Object> params)

Methods inherited from class java.lang.Object

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

Constructor Detail

RefundService

public RefundService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

count

public Long count(Long spaceId,
                  EntityQueryFilter filter)
           throws IOException

Count Counts the number of items in the database as restricted by the given filter.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

filter - The filter which restricts the entities which are used to calculate the count.

Returns:

Long

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Count Documentation

count

public Long count(EntityQueryFilter filter,
                  Long spaceId,
                  Map<String,Object> params)
           throws IOException

Count Counts the number of items in the database as restricted by the given filter.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

Long

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Count Documentation

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(Long spaceId,
                                                                    EntityQueryFilter filter)
                                                             throws IOException

Throws:

IOException

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(Long spaceId,
                                                                    InputStream filter,
                                                                    String mediaType)
                                                             throws IOException

Throws:

IOException

countForHttpResponse

public com.google.api.client.http.HttpResponse countForHttpResponse(EntityQueryFilter filter,
                                                                    Long spaceId,
                                                                    Map<String,Object> params)
                                                             throws IOException

Throws:

IOException

fail

public Refund fail(Long spaceId,
                   Long refundId)
            throws IOException

fail This operation allows to mark a refund as failed which is in state MANUAL_CHECK.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

refundId - The id of the refund which should be marked as failed.

Returns:

Refund

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

fail Documentation

fail

public Refund fail(Long spaceId,
                   Long refundId,
                   Map<String,Object> params)
            throws IOException

fail This operation allows to mark a refund as failed which is in state MANUAL_CHECK.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

refundId - The id of the refund which should be marked as failed.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

Refund

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

fail Documentation

failForHttpResponse

public com.google.api.client.http.HttpResponse failForHttpResponse(Long spaceId,
                                                                   Long refundId)
                                                            throws IOException

Throws:

IOException

failForHttpResponse

public com.google.api.client.http.HttpResponse failForHttpResponse(Long spaceId,
                                                                   Long refundId,
                                                                   Map<String,Object> params)
                                                            throws IOException

Throws:

IOException

getRefundDocument

public RenderedDocument getRefundDocument(Long spaceId,
                                          Long id)
                                   throws IOException

getRefundDocument Returns the PDF document for the refund with given id.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the refund to get the document for.

Returns:

RenderedDocument

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

getRefundDocument Documentation

getRefundDocument

public RenderedDocument getRefundDocument(Long spaceId,
                                          Long id,
                                          Map<String,Object> params)
                                   throws IOException

getRefundDocument Returns the PDF document for the refund with given id.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the refund to get the document for.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

RenderedDocument

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

getRefundDocument Documentation

getRefundDocumentForHttpResponse

public com.google.api.client.http.HttpResponse getRefundDocumentForHttpResponse(Long spaceId,
                                                                                Long id)
                                                                         throws IOException

Throws:

IOException

getRefundDocumentForHttpResponse

public com.google.api.client.http.HttpResponse getRefundDocumentForHttpResponse(Long spaceId,
                                                                                Long id,
                                                                                Map<String,Object> params)
                                                                         throws IOException

Throws:

IOException

getRefundDocumentWithTargetMediaType

public RenderedDocument getRefundDocumentWithTargetMediaType(Long spaceId,
                                                             Long id,
                                                             Long targetMediaTypeId)
                                                      throws IOException

getRefundDocumentWithTargetMediaType Returns the PDF document for the refund with given id and the given target media type.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the refund to get the document for.

targetMediaTypeId - The id of the target media type for which the refund should be generated for.

Returns:

RenderedDocument

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

getRefundDocumentWithTargetMediaType Documentation

getRefundDocumentWithTargetMediaType

public RenderedDocument getRefundDocumentWithTargetMediaType(Long spaceId,
                                                             Long id,
                                                             Long targetMediaTypeId,
                                                             Map<String,Object> params)
                                                      throws IOException

getRefundDocumentWithTargetMediaType Returns the PDF document for the refund with given id and the given target media type.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the refund to get the document for.

targetMediaTypeId - The id of the target media type for which the refund should be generated for.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

RenderedDocument

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

getRefundDocumentWithTargetMediaType Documentation

getRefundDocumentWithTargetMediaTypeForHttpResponse

public com.google.api.client.http.HttpResponse getRefundDocumentWithTargetMediaTypeForHttpResponse(Long spaceId,
                                                                                                   Long id,
                                                                                                   Long targetMediaTypeId)
                                                                                            throws IOException

Throws:

IOException

getRefundDocumentWithTargetMediaTypeForHttpResponse

public com.google.api.client.http.HttpResponse getRefundDocumentWithTargetMediaTypeForHttpResponse(Long spaceId,
                                                                                                   Long id,
                                                                                                   Long targetMediaTypeId,
                                                                                                   Map<String,Object> params)
                                                                                            throws IOException

Throws:

IOException

read

public Refund read(Long spaceId,
                   Long id)
            throws IOException

Read Reads the entity with the given 'id' and returns it.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the refund which should be returned.

Returns:

Refund

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Read Documentation

read

public Refund read(Long spaceId,
                   Long id,
                   Map<String,Object> params)
            throws IOException

Read Reads the entity with the given 'id' and returns it.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

id - The id of the refund which should be returned.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

Refund

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Read Documentation

readForHttpResponse

public com.google.api.client.http.HttpResponse readForHttpResponse(Long spaceId,
                                                                   Long id)
                                                            throws IOException

Throws:

IOException

readForHttpResponse

public com.google.api.client.http.HttpResponse readForHttpResponse(Long spaceId,
                                                                   Long id,
                                                                   Map<String,Object> params)
                                                            throws IOException

Throws:

IOException

refund

public Refund refund(Long spaceId,
                     RefundCreate refund)
              throws IOException

create This operation creates and executes a refund of a particular transaction.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

refund - The refund object which should be created.

Returns:

Refund

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

create Documentation

refund

public Refund refund(Long spaceId,
                     RefundCreate refund,
                     Map<String,Object> params)
              throws IOException

create This operation creates and executes a refund of a particular transaction.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

refund - The refund object which should be created.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

Refund

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

create Documentation

refundForHttpResponse

public com.google.api.client.http.HttpResponse refundForHttpResponse(Long spaceId,
                                                                     RefundCreate refund)
                                                              throws IOException

Throws:

IOException

refundForHttpResponse

public com.google.api.client.http.HttpResponse refundForHttpResponse(Long spaceId,
                                                                     InputStream refund,
                                                                     String mediaType)
                                                              throws IOException

Throws:

IOException

refundForHttpResponse

public com.google.api.client.http.HttpResponse refundForHttpResponse(Long spaceId,
                                                                     RefundCreate refund,
                                                                     Map<String,Object> params)
                                                              throws IOException

Throws:

IOException

search

public List<Refund> search(Long spaceId,
                           EntityQuery query)
                    throws IOException

Search Searches for the entities as specified by the given query.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

query - The query restricts the refunds which are returned by the search.

Returns:

List<Refund>

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Search Documentation

search

public List<Refund> search(Long spaceId,
                           EntityQuery query,
                           Map<String,Object> params)
                    throws IOException

Search Searches for the entities as specified by the given query.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

query - The query restricts the refunds which are returned by the search.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

List<Refund>

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Search Documentation

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     EntityQuery query)
                                                              throws IOException

Throws:

IOException

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     InputStream query,
                                                                     String mediaType)
                                                              throws IOException

Throws:

IOException

searchForHttpResponse

public com.google.api.client.http.HttpResponse searchForHttpResponse(Long spaceId,
                                                                     EntityQuery query,
                                                                     Map<String,Object> params)
                                                              throws IOException

Throws:

IOException

succeed

public Refund succeed(Long spaceId,
                      Long refundId)
               throws IOException

succeed This operation allows to mark a refund as successful which is in state MANUAL_CHECK.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

refundId - The id of the refund which should be marked as successful.

Returns:

Refund

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

succeed Documentation

succeed

public Refund succeed(Long spaceId,
                      Long refundId,
                      Map<String,Object> params)
               throws IOException

succeed This operation allows to mark a refund as successful which is in state MANUAL_CHECK.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

spaceId -

refundId - The id of the refund which should be marked as successful.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

Refund

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

succeed Documentation

succeedForHttpResponse

public com.google.api.client.http.HttpResponse succeedForHttpResponse(Long spaceId,
                                                                      Long refundId)
                                                               throws IOException

Throws:

IOException

succeedForHttpResponse

public com.google.api.client.http.HttpResponse succeedForHttpResponse(Long spaceId,
                                                                      Long refundId,
                                                                      Map<String,Object> params)
                                                               throws IOException

Throws:

IOException