ch.postfinance.sdk.service

Class UserAccountRoleService

java.lang.Object

ch.postfinance.sdk.service.UserAccountRoleService

public class UserAccountRoleService
extends Object

Constructor Summary

Constructors

Constructor and Description
UserAccountRoleService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UserAccountRole	addRole(Long userId, Long accountId, Long roleId, Boolean appliesOnSubaccount) Add Role This operation grants the role to the given user with in the given account.
UserAccountRole	addRole(Long userId, Long accountId, Long roleId, Map<String,Object> params) Add Role This operation grants the role to the given user with in the given account.
com.google.api.client.http.HttpResponse	addRoleForHttpResponse(Long userId, Long accountId, Long roleId, Boolean appliesOnSubaccount)
com.google.api.client.http.HttpResponse	addRoleForHttpResponse(Long userId, Long accountId, Long roleId, Map<String,Object> params)
ApiClient	getApiClient()
List<UserAccountRole>	list(Long userId, Long accountId) List Roles List all the roles that are assigned to the given user in the given account.
List<UserAccountRole>	list(Long userId, Long accountId, Map<String,Object> params) List Roles List all the roles that are assigned to the given user in the given account.
com.google.api.client.http.HttpResponse	listForHttpResponse(Long userId, Long accountId)
com.google.api.client.http.HttpResponse	listForHttpResponse(Long userId, Long accountId, Map<String,Object> params)
void	removeRole(Long id) Remove Role This operation removes the specified user account role.
void	removeRole(Long id, Map<String,Object> params) Remove Role This operation removes the specified user account role.
com.google.api.client.http.HttpResponse	removeRoleForHttpResponse(Long id)
com.google.api.client.http.HttpResponse	removeRoleForHttpResponse(Long id, Map<String,Object> params)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAccountRoleService

public UserAccountRoleService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addRole

public UserAccountRole addRole(Long userId,
                               Long accountId,
                               Long roleId,
                               Boolean appliesOnSubaccount)
                        throws IOException

Add Role This operation grants the role to the given user with in the given account.

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:

userId - The id of the user to whom the role is assigned.

accountId - The account to which the role is mapped.

roleId - The role which is mapped to the user and account.

appliesOnSubaccount - Whether the role applies only on subaccount.

Returns:

UserAccountRole

Throws:

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

See Also:

Add Role Documentation

addRole

public UserAccountRole addRole(Long userId,
                               Long accountId,
                               Long roleId,
                               Map<String,Object> params)
                        throws IOException

Add Role This operation grants the role to the given user with in the given account.

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:

userId - The id of the user to whom the role is assigned.

accountId - The account to which the role is mapped.

roleId - The role which is mapped to the user and account.

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

Returns:

UserAccountRole

Throws:

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

See Also:

Add Role Documentation

addRoleForHttpResponse

public com.google.api.client.http.HttpResponse addRoleForHttpResponse(Long userId,
                                                                      Long accountId,
                                                                      Long roleId,
                                                                      Boolean appliesOnSubaccount)
                                                               throws IOException

Throws:

IOException

addRoleForHttpResponse

public com.google.api.client.http.HttpResponse addRoleForHttpResponse(Long userId,
                                                                      Long accountId,
                                                                      Long roleId,
                                                                      Map<String,Object> params)
                                                               throws IOException

Throws:

IOException

list

public List<UserAccountRole> list(Long userId,
                                  Long accountId)
                           throws IOException

List Roles List all the roles that are assigned to the given user in the given account.

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:

userId - The id of the user to whom the role is assigned.

accountId - The account to which the role is mapped.

Returns:

List<UserAccountRole>

Throws:

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

See Also:

List Roles Documentation

list

public List<UserAccountRole> list(Long userId,
                                  Long accountId,
                                  Map<String,Object> params)
                           throws IOException

List Roles List all the roles that are assigned to the given user in the given account.

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:

userId - The id of the user to whom the role is assigned.

accountId - The account to which the role is mapped.

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

Returns:

List<UserAccountRole>

Throws:

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

See Also:

List Roles Documentation

listForHttpResponse

public com.google.api.client.http.HttpResponse listForHttpResponse(Long userId,
                                                                   Long accountId)
                                                            throws IOException

Throws:

IOException

listForHttpResponse

public com.google.api.client.http.HttpResponse listForHttpResponse(Long userId,
                                                                   Long accountId,
                                                                   Map<String,Object> params)
                                                            throws IOException

Throws:

IOException

removeRole

public void removeRole(Long id)
                throws IOException

Remove Role This operation removes the specified user account role.

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:

id - The id of user account role which should be removed

Throws:

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

See Also:

Remove Role Documentation

removeRole

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

Remove Role This operation removes the specified user account role.

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:

id - The id of user account role which should be removed

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:

Remove Role Documentation

removeRoleForHttpResponse

public com.google.api.client.http.HttpResponse removeRoleForHttpResponse(Long id)
                                                                  throws IOException

Throws:

IOException

removeRoleForHttpResponse

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

Throws:

IOException