Package com.adyen.service.management

Class UsersCompanyLevel

java.lang.Object

com.adyen.Service

com.adyen.ApiKeyAuthenticatedService

com.adyen.service.management.UsersCompanyLevel

public class UsersCompanyLevel
extends ApiKeyAuthenticatedService

Field Summary

Fields inherited from class com.adyen.Service

GSON

Constructor Summary

Constructors

Constructor	Description
UsersCompanyLevel(Client client)

Method Summary

Modifier and Type	Method	Description
CreateCompanyUserResponse	createNewUser(String companyId, CreateCompanyUserRequest createCompanyUserRequest)	Create a new user
CompanyUser	getUserDetails(String companyId, String userId)	Get user details
ListCompanyUsersResponse	listUsers(String companyId, Map<String,String> queryParams)	Get a list of users
CompanyUser	updateUserDetails(String companyId, String userId, UpdateCompanyUserRequest updateCompanyUserRequest)	Update user details

Methods inherited from class com.adyen.Service

getClient, isApiKeyRequired, setApiKeyRequired, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersCompanyLevel

public UsersCompanyLevel(Client client)

Method Detail

listUsers

public ListCompanyUsersResponse listUsers(String companyId,
                                          Map<String,String> queryParams)
                                   throws ApiException,
                                          IOException

Get a list of users

Parameters:

companyId - The unique identifier of the company account. (required)

queryParams - (optional) pageNumber: The number of the page to return. (optional) pageSize: The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page. (optional)

Returns:

ListCompanyUsersResponse

Throws:

ApiException - if fails to make API call

IOException

getUserDetails

public CompanyUser getUserDetails(String companyId,
                                  String userId)
                           throws ApiException,
                                  IOException

Get user details

Parameters:

companyId - The unique identifier of the company account. (required)

userId - The unique identifier of the user. (required)

Returns:

CompanyUser

Throws:

ApiException - if fails to make API call

IOException

updateUserDetails

public CompanyUser updateUserDetails(String companyId,
                                     String userId,
                                     UpdateCompanyUserRequest updateCompanyUserRequest)
                              throws ApiException,
                                     IOException

Update user details

Parameters:

companyId - The unique identifier of the company account. (required)

userId - The unique identifier of the user. (required)

updateCompanyUserRequest - (optional)

Returns:

CompanyUser

Throws:

ApiException - if fails to make API call

IOException

createNewUser

public CreateCompanyUserResponse createNewUser(String companyId,
                                               CreateCompanyUserRequest createCompanyUserRequest)
                                        throws ApiException,
                                               IOException

Create a new user

Parameters:

companyId - The unique identifier of the company account. (required)

createCompanyUserRequest - (optional)

Returns:

CreateCompanyUserResponse

Throws:

ApiException - if fails to make API call

IOException