ch.postfinance.sdk.service

Class CustomerAddressService

java.lang.Object

ch.postfinance.sdk.service.CustomerAddressService

public class CustomerAddressService
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomerAddressService(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)
CustomerAddress	create(Long spaceId, CustomerAddressCreate entity) Create Creates the entity with the given properties.
CustomerAddress	create(Long spaceId, CustomerAddressCreate entity, Map<String,Object> params) Create Creates the entity with the given properties.
com.google.api.client.http.HttpResponse	createForHttpResponse(Long spaceId, CustomerAddressCreate entity)
com.google.api.client.http.HttpResponse	createForHttpResponse(Long spaceId, CustomerAddressCreate entity, Map<String,Object> params)
com.google.api.client.http.HttpResponse	createForHttpResponse(Long spaceId, InputStream entity, String mediaType)
void	delete(Long spaceId, Long id) Delete Deletes the entity with the given id.
void	delete(Long spaceId, Long id, Map<String,Object> params) Delete Deletes the entity with the given id.
com.google.api.client.http.HttpResponse	deleteForHttpResponse(Long spaceId, InputStream id, String mediaType)
com.google.api.client.http.HttpResponse	deleteForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	deleteForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
ApiClient	getApiClient()
CustomerAddress	read(Long spaceId, Long id) Read Reads the entity with the given 'id' and returns it.
CustomerAddress	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)
List<CustomerAddress>	search(Long spaceId, EntityQuery query) Search Searches for the entities as specified by the given query.
List<CustomerAddress>	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	selectDefaultAddress(Long spaceId, Long id) selectDefaultAddress
void	selectDefaultAddress(Long spaceId, Long id, Map<String,Object> params) selectDefaultAddress
com.google.api.client.http.HttpResponse	selectDefaultAddressForHttpResponse(Long spaceId, Long id)
com.google.api.client.http.HttpResponse	selectDefaultAddressForHttpResponse(Long spaceId, Long id, Map<String,Object> params)
void	setApiClient(ApiClient apiClient)
CustomerAddress	update(Long spaceId, CustomerAddressActive entity) Update This updates the entity with the given properties.
CustomerAddress	update(Long spaceId, CustomerAddressActive entity, Map<String,Object> params) Update This updates the entity with the given properties.
com.google.api.client.http.HttpResponse	updateForHttpResponse(Long spaceId, CustomerAddressActive entity)
com.google.api.client.http.HttpResponse	updateForHttpResponse(Long spaceId, CustomerAddressActive entity, Map<String,Object> params)
com.google.api.client.http.HttpResponse	updateForHttpResponse(Long spaceId, InputStream entity, String mediaType)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerAddressService

public CustomerAddressService(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

create

public CustomerAddress create(Long spaceId,
                              CustomerAddressCreate entity)
                       throws IOException

Create Creates the entity with the given properties.

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 -

entity - The customer object which should be created.

Returns:

CustomerAddress

Throws:

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

See Also:

Create Documentation

create

public CustomerAddress create(Long spaceId,
                              CustomerAddressCreate entity,
                              Map<String,Object> params)
                       throws IOException

Create Creates the entity with the given properties.

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 -

entity - The customer 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:

CustomerAddress

Throws:

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

See Also:

Create Documentation

createForHttpResponse

public com.google.api.client.http.HttpResponse createForHttpResponse(Long spaceId,
                                                                     CustomerAddressCreate entity)
                                                              throws IOException

Throws:

IOException

createForHttpResponse

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

Throws:

IOException

createForHttpResponse

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

Throws:

IOException

delete

public void delete(Long spaceId,
                   Long id)
            throws IOException

Delete Deletes the entity with the given id.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

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 -

Throws:

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

See Also:

Delete Documentation

delete

public void delete(Long spaceId,
                   Long id,
                   Map<String,Object> params)
            throws IOException

Delete Deletes the entity with the given id.

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

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 -

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

Throws:

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

See Also:

Delete Documentation

deleteForHttpResponse

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

Throws:

IOException

deleteForHttpResponse

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

Throws:

IOException

deleteForHttpResponse

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

Throws:

IOException

read

public CustomerAddress 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 customer which should be returned.

Returns:

CustomerAddress

Throws:

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

See Also:

Read Documentation

read

public CustomerAddress 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 customer 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:

CustomerAddress

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

search

public List<CustomerAddress> 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 customers which are returned by the search.

Returns:

List<CustomerAddress>

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<CustomerAddress> 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 customers 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<CustomerAddress>

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

selectDefaultAddress

public void selectDefaultAddress(Long spaceId,
                                 Long id)
                          throws IOException

selectDefaultAddress

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

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 customer address to set as default.

Throws:

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

See Also:

selectDefaultAddress Documentation

selectDefaultAddress

public void selectDefaultAddress(Long spaceId,
                                 Long id,
                                 Map<String,Object> params)
                          throws IOException

selectDefaultAddress

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

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 customer address to set as default.

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

Throws:

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

See Also:

selectDefaultAddress Documentation

selectDefaultAddressForHttpResponse

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

Throws:

IOException

selectDefaultAddressForHttpResponse

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

Throws:

IOException

update

public CustomerAddress update(Long spaceId,
                              CustomerAddressActive entity)
                       throws IOException

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

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

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

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 -

entity - The customer object with the properties which should be updated.

Returns:

CustomerAddress

Throws:

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

See Also:

Update Documentation

update

public CustomerAddress update(Long spaceId,
                              CustomerAddressActive entity,
                              Map<String,Object> params)
                       throws IOException

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The 'id' and 'version' are required to identify the entity.

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

409 - This status code indicates that there was a conflict with the current version of the data in the database and the provided data in the request.

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 -

entity - The customer object with the properties which should be updated.

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

Returns:

CustomerAddress

Throws:

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

See Also:

Update Documentation

updateForHttpResponse

public com.google.api.client.http.HttpResponse updateForHttpResponse(Long spaceId,
                                                                     CustomerAddressActive entity)
                                                              throws IOException

Throws:

IOException

updateForHttpResponse

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

Throws:

IOException

updateForHttpResponse

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

Throws:

IOException