Package com.adyen.service.management

Class UsersCompanyLevelApi

java.lang.Object

com.adyen.Service

com.adyen.service.management.UsersCompanyLevelApi

public class UsersCompanyLevelApi
extends Service

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_VERSION
protected String	baseURL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CreateCompanyUserResponse	createNewUser(String companyId, CreateCompanyUserRequest createCompanyUserRequest)	Create a new user
CreateCompanyUserResponse	createNewUser(String companyId, CreateCompanyUserRequest createCompanyUserRequest, RequestOptions requestOptions)	Create a new user
CompanyUser	getUserDetails(String companyId, String userId)	Get user details
CompanyUser	getUserDetails(String companyId, String userId, RequestOptions requestOptions)	Get user details
ListCompanyUsersResponse	listUsers(String companyId)	Get a list of users
ListCompanyUsersResponse	listUsers(String companyId, Integer pageNumber, Integer pageSize, String username, RequestOptions requestOptions)	Get a list of users
CompanyUser	updateUserDetails(String companyId, String userId, UpdateCompanyUserRequest updateCompanyUserRequest)	Update user details
CompanyUser	updateUserDetails(String companyId, String userId, UpdateCompanyUserRequest updateCompanyUserRequest, RequestOptions requestOptions)	Update user details

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

UsersCompanyLevelApi

public UsersCompanyLevelApi(Client client)

Users - company level constructor in package.

Parameters:

client - Client (required)

UsersCompanyLevelApi

public UsersCompanyLevelApi(Client client,
                            String baseURL)

Users - company 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 CreateCompanyUserResponse createNewUser(String companyId,
                                               CreateCompanyUserRequest createCompanyUserRequest)
                                        throws ApiException,
                                               IOException

Create a new user

Parameters:

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

createCompanyUserRequest - CreateCompanyUserRequest (required)

Returns:

CreateCompanyUserResponse

Throws:

ApiException - if fails to make API call

IOException

createNewUser

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

Create a new user

Parameters:

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

createCompanyUserRequest - CreateCompanyUserRequest (required)

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

Returns:

CreateCompanyUserResponse

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 - String The unique identifier of the company account. (required)

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

Returns:

CompanyUser

Throws:

ApiException - if fails to make API call

IOException

getUserDetails

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

Get user details

Parameters:

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

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

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

Returns:

CompanyUser

Throws:

ApiException - if fails to make API call

IOException

listUsers

public ListCompanyUsersResponse listUsers(String companyId)
                                   throws ApiException,
                                          IOException

Get a list of users

Parameters:

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

Returns:

ListCompanyUsersResponse

Throws:

ApiException - if fails to make API call

IOException

listUsers

public ListCompanyUsersResponse listUsers(String companyId,
                                          Integer pageNumber,
                                          Integer pageSize,
                                          String username,
                                          RequestOptions requestOptions)
                                   throws ApiException,
                                          IOException

Get a list of users

Parameters:

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

pageNumber - Integer Query: The number of the page to return. (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:

ListCompanyUsersResponse

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 - String The unique identifier of the company account. (required)

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

updateCompanyUserRequest - UpdateCompanyUserRequest (required)

Returns:

CompanyUser

Throws:

ApiException - if fails to make API call

IOException

updateUserDetails

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

Update user details

Parameters:

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

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

updateCompanyUserRequest - UpdateCompanyUserRequest (required)

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

Returns:

CompanyUser

Throws:

ApiException - if fails to make API call

IOException