Package com.adyen.model.management
Class CreateCompanyUserRequest
- java.lang.Object
-
- com.adyen.model.management.CreateCompanyUserRequest
-
public class CreateCompanyUserRequest extends Object
CreateCompanyUserRequest
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACCOUNT_GROUPSstatic StringJSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTSstatic StringJSON_PROPERTY_EMAILstatic StringJSON_PROPERTY_LOGIN_METHODstatic StringJSON_PROPERTY_NAMEstatic StringJSON_PROPERTY_ROLESstatic StringJSON_PROPERTY_TIME_ZONE_CODEstatic StringJSON_PROPERTY_USERNAME
-
Constructor Summary
Constructors Constructor Description CreateCompanyUserRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateCompanyUserRequestaccountGroups(List<String> accountGroups)The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.CreateCompanyUserRequestaddAccountGroupsItem(String accountGroupsItem)CreateCompanyUserRequestaddAssociatedMerchantAccountsItem(String associatedMerchantAccountsItem)CreateCompanyUserRequestaddRolesItem(String rolesItem)CreateCompanyUserRequestassociatedMerchantAccounts(List<String> associatedMerchantAccounts)The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.CreateCompanyUserRequestemail(String email)The email address of the user.booleanequals(Object o)Return true if this CreateCompanyUserRequest object is equal to o.static CreateCompanyUserRequestfromJson(String jsonString)Create an instance of CreateCompanyUserRequest given an JSON stringList<String>getAccountGroups()The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.List<String>getAssociatedMerchantAccounts()The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.StringgetEmail()The email address of the user.Map<String,Object>getExplicitNulls()Returns a map of properties to be merged into the JSON payload as explicit null values.StringgetLoginMethod()The requested login method for the user.NamegetName()Get nameList<String>getRoles()The list of [roles](https://docs.adyen.com/account/user-roles) for this user.StringgetTimeZoneCode()The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user.StringgetUsername()The user's email address that will be their username.inthashCode()CreateCompanyUserRequestincludeNullValues(boolean includeNullValues)Configures whether null values are explicitly serialized in the JSON payload.booleanisIncludeNullValues()Returns whether null values are explicitly serialized in the JSON payload.CreateCompanyUserRequestloginMethod(String loginMethod)The requested login method for the user.CreateCompanyUserRequestname(Name name)nameCreateCompanyUserRequestroles(List<String> roles)The list of [roles](https://docs.adyen.com/account/user-roles) for this user.voidsetAccountGroups(List<String> accountGroups)The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.voidsetAssociatedMerchantAccounts(List<String> associatedMerchantAccounts)The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.voidsetEmail(String email)The email address of the user.voidsetIncludeNullValues(boolean includeNullValues)Sets whether null values should be explicitly serialized in the JSON payload.voidsetLoginMethod(String loginMethod)The requested login method for the user.voidsetName(Name name)namevoidsetRoles(List<String> roles)The list of [roles](https://docs.adyen.com/account/user-roles) for this user.voidsetTimeZoneCode(String timeZoneCode)The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user.voidsetUsername(String username)The user's email address that will be their username.CreateCompanyUserRequesttimeZoneCode(String timeZoneCode)The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user.StringtoJson()Convert an instance of CreateCompanyUserRequest to an JSON stringStringtoString()CreateCompanyUserRequestusername(String username)The user's email address that will be their username.
-
-
-
Field Detail
-
JSON_PROPERTY_ACCOUNT_GROUPS
public static final String JSON_PROPERTY_ACCOUNT_GROUPS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS
public static final String JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EMAIL
public static final String JSON_PROPERTY_EMAIL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LOGIN_METHOD
public static final String JSON_PROPERTY_LOGIN_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NAME
public static final String JSON_PROPERTY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ROLES
public static final String JSON_PROPERTY_ROLES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TIME_ZONE_CODE
public static final String JSON_PROPERTY_TIME_ZONE_CODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_USERNAME
public static final String JSON_PROPERTY_USERNAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
accountGroups
public CreateCompanyUserRequest accountGroups(List<String> accountGroups)
The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.- Parameters:
accountGroups- The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.- Returns:
- the current
CreateCompanyUserRequestinstance, allowing for method chaining
-
addAccountGroupsItem
public CreateCompanyUserRequest addAccountGroupsItem(String accountGroupsItem)
-
getAccountGroups
public List<String> getAccountGroups()
The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.- Returns:
- accountGroups The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.
-
setAccountGroups
public void setAccountGroups(List<String> accountGroups)
The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.- Parameters:
accountGroups- The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.
-
associatedMerchantAccounts
public CreateCompanyUserRequest associatedMerchantAccounts(List<String> associatedMerchantAccounts)
The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.- Parameters:
associatedMerchantAccounts- The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.- Returns:
- the current
CreateCompanyUserRequestinstance, allowing for method chaining
-
addAssociatedMerchantAccountsItem
public CreateCompanyUserRequest addAssociatedMerchantAccountsItem(String associatedMerchantAccountsItem)
-
getAssociatedMerchantAccounts
public List<String> getAssociatedMerchantAccounts()
The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.- Returns:
- associatedMerchantAccounts The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.
-
setAssociatedMerchantAccounts
public void setAssociatedMerchantAccounts(List<String> associatedMerchantAccounts)
The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.- Parameters:
associatedMerchantAccounts- The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.
-
email
public CreateCompanyUserRequest email(String email)
The email address of the user.- Parameters:
email- The email address of the user.- Returns:
- the current
CreateCompanyUserRequestinstance, allowing for method chaining
-
getEmail
public String getEmail()
The email address of the user.- Returns:
- email The email address of the user.
-
setEmail
public void setEmail(String email)
The email address of the user.- Parameters:
email- The email address of the user.
-
loginMethod
public CreateCompanyUserRequest loginMethod(String loginMethod)
The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user. Possible values: **Email** or **SSO**- Parameters:
loginMethod- The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user. Possible values: **Email** or **SSO**- Returns:
- the current
CreateCompanyUserRequestinstance, allowing for method chaining
-
getLoginMethod
public String getLoginMethod()
The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user. Possible values: **Email** or **SSO**- Returns:
- loginMethod The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user. Possible values: **Email** or **SSO**
-
setLoginMethod
public void setLoginMethod(String loginMethod)
The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user. Possible values: **Email** or **SSO**- Parameters:
loginMethod- The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user. Possible values: **Email** or **SSO**
-
name
public CreateCompanyUserRequest name(Name name)
name- Parameters:
name-- Returns:
- the current
CreateCompanyUserRequestinstance, allowing for method chaining
-
getName
public Name getName()
Get name- Returns:
- name
-
setName
public void setName(Name name)
name- Parameters:
name-
-
roles
public CreateCompanyUserRequest roles(List<String> roles)
The list of [roles](https://docs.adyen.com/account/user-roles) for this user.- Parameters:
roles- The list of [roles](https://docs.adyen.com/account/user-roles) for this user.- Returns:
- the current
CreateCompanyUserRequestinstance, allowing for method chaining
-
addRolesItem
public CreateCompanyUserRequest addRolesItem(String rolesItem)
-
getRoles
public List<String> getRoles()
The list of [roles](https://docs.adyen.com/account/user-roles) for this user.- Returns:
- roles The list of [roles](https://docs.adyen.com/account/user-roles) for this user.
-
setRoles
public void setRoles(List<String> roles)
The list of [roles](https://docs.adyen.com/account/user-roles) for this user.- Parameters:
roles- The list of [roles](https://docs.adyen.com/account/user-roles) for this user.
-
timeZoneCode
public CreateCompanyUserRequest timeZoneCode(String timeZoneCode)
The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.- Parameters:
timeZoneCode- The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.- Returns:
- the current
CreateCompanyUserRequestinstance, allowing for method chaining
-
getTimeZoneCode
public String getTimeZoneCode()
The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.- Returns:
- timeZoneCode The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.
-
setTimeZoneCode
public void setTimeZoneCode(String timeZoneCode)
The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.- Parameters:
timeZoneCode- The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.
-
username
public CreateCompanyUserRequest username(String username)
The user's email address that will be their username. Must be the same as the one in the `email` field.- Parameters:
username- The user's email address that will be their username. Must be the same as the one in the `email` field.- Returns:
- the current
CreateCompanyUserRequestinstance, allowing for method chaining
-
getUsername
public String getUsername()
The user's email address that will be their username. Must be the same as the one in the `email` field.- Returns:
- username The user's email address that will be their username. Must be the same as the one in the `email` field.
-
setUsername
public void setUsername(String username)
The user's email address that will be their username. Must be the same as the one in the `email` field.- Parameters:
username- The user's email address that will be their username. Must be the same as the one in the `email` field.
-
includeNullValues
public CreateCompanyUserRequest includeNullValues(boolean includeNullValues)
Configures whether null values are explicitly serialized in the JSON payload. Default is false.
-
isIncludeNullValues
public boolean isIncludeNullValues()
Returns whether null values are explicitly serialized in the JSON payload.
-
setIncludeNullValues
public void setIncludeNullValues(boolean includeNullValues)
Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
-
equals
public boolean equals(Object o)
Return true if this CreateCompanyUserRequest object is equal to o.
-
getExplicitNulls
public Map<String,Object> getExplicitNulls()
Returns a map of properties to be merged into the JSON payload as explicit null values.
-
fromJson
public static CreateCompanyUserRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of CreateCompanyUserRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of CreateCompanyUserRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to CreateCompanyUserRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of CreateCompanyUserRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-