Package com.adyen.service.management

Class UsersMerchantLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.UsersMerchantLevelApi

public class UsersMerchantLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

Constructor	Description
UsersMerchantLevelApi(Client client)	Users - merchant level constructor in package.
UsersMerchantLevelApi(Client client, String baseURL)	Users - merchant level constructor in package.

Method Summary

Modifier and Type	Method	Description
CreateUserResponse	createNewUser(String merchantId, CreateMerchantUserRequest createMerchantUserRequest)	Create a new user
CreateUserResponse	createNewUser(String merchantId, CreateMerchantUserRequest createMerchantUserRequest, RequestOptions requestOptions)	Create a new user
User	getUserDetails(String merchantId, String userId)	Get user details
User	getUserDetails(String merchantId, String userId, RequestOptions requestOptions)	Get user details
ListMerchantUsersResponse	listUsers(String merchantId)	Get a list of users
ListMerchantUsersResponse	listUsers(String merchantId, Integer pageNumber, Integer pageSize, String username, RequestOptions requestOptions)	Get a list of users
User	updateUser(String merchantId, String userId, UpdateMerchantUserRequest updateMerchantUserRequest)	Update a user
User	updateUser(String merchantId, String userId, UpdateMerchantUserRequest updateMerchantUserRequest, RequestOptions requestOptions)	Update a user

Methods inherited from class com.adyen.Service

createBaseURL, getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

baseURL

protected String baseURL

Constructor Detail

UsersMerchantLevelApi

public UsersMerchantLevelApi(Client client)

Users - merchant level constructor in package.

Parameters:

client - Client (required)

UsersMerchantLevelApi

public UsersMerchantLevelApi(Client client,
                             String baseURL)

Users - merchant level constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.

Parameters:

client - Client (required)

baseURL - String (required)

Method Detail

createNewUser

public CreateUserResponse createNewUser(String merchantId,
                                        CreateMerchantUserRequest createMerchantUserRequest)
                                 throws ApiException,
                                        IOException

Create a new user

Parameters:

merchantId - String Unique identifier of the merchant. (required)

createMerchantUserRequest - CreateMerchantUserRequest (required)

Returns:

CreateUserResponse

Throws:

ApiException - if fails to make API call

IOException

createNewUser

public CreateUserResponse createNewUser(String merchantId,
                                        CreateMerchantUserRequest createMerchantUserRequest,
                                        RequestOptions requestOptions)
                                 throws ApiException,
                                        IOException

Create a new user

Parameters:

merchantId - String Unique identifier of the merchant. (required)

createMerchantUserRequest - CreateMerchantUserRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

CreateUserResponse

Throws:

ApiException - if fails to make API call

IOException

getUserDetails

public User getUserDetails(String merchantId,
                           String userId)
                    throws ApiException,
                           IOException

Get user details

Parameters:

merchantId - String Unique identifier of the merchant. (required)

userId - String Unique identifier of the user. (required)

Returns:

User

Throws:

ApiException - if fails to make API call

IOException

getUserDetails

public User getUserDetails(String merchantId,
                           String userId,
                           RequestOptions requestOptions)
                    throws ApiException,
                           IOException

Get user details

Parameters:

merchantId - String Unique identifier of the merchant. (required)

userId - String Unique identifier of the user. (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

User

Throws:

ApiException - if fails to make API call

IOException

listUsers

public ListMerchantUsersResponse listUsers(String merchantId)
                                    throws ApiException,
                                           IOException

Get a list of users

Parameters:

merchantId - String Unique identifier of the merchant. (required)

Returns:

ListMerchantUsersResponse

Throws:

ApiException - if fails to make API call

IOException

listUsers

public ListMerchantUsersResponse listUsers(String merchantId,
                                           Integer pageNumber,
                                           Integer pageSize,
                                           String username,
                                           RequestOptions requestOptions)
                                    throws ApiException,
                                           IOException

Get a list of users

Parameters:

merchantId - String Unique identifier of the merchant. (required)

pageNumber - Integer Query: The number of the page to fetch. (optional)

pageSize - Integer Query: The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page. (optional)

username - String Query: The partial or complete username to select all users that match. (optional)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

ListMerchantUsersResponse

Throws:

ApiException - if fails to make API call

IOException

updateUser

public User updateUser(String merchantId,
                       String userId,
                       UpdateMerchantUserRequest updateMerchantUserRequest)
                throws ApiException,
                       IOException

Update a user

Parameters:

merchantId - String Unique identifier of the merchant. (required)

userId - String Unique identifier of the user. (required)

updateMerchantUserRequest - UpdateMerchantUserRequest (required)

Returns:

User

Throws:

ApiException - if fails to make API call

IOException

updateUser

public User updateUser(String merchantId,
                       String userId,
                       UpdateMerchantUserRequest updateMerchantUserRequest,
                       RequestOptions requestOptions)
                throws ApiException,
                       IOException

Update a user

Parameters:

merchantId - String Unique identifier of the merchant. (required)

userId - String Unique identifier of the user. (required)

updateMerchantUserRequest - UpdateMerchantUserRequest (required)

requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)

Returns:

User

Throws:

ApiException - if fails to make API call

IOException