Package io.mailtrap.api.accountaccesses

Class AccountAccessesImpl

java.lang.Object

io.mailtrap.api.apiresource.ApiResource

io.mailtrap.api.accountaccesses.AccountAccessesImpl

All Implemented Interfaces:

AccountAccesses

public class AccountAccessesImpl
extends ApiResource
implements AccountAccesses

Field Summary

Fields inherited from class io.mailtrap.api.apiresource.ApiResource

apiHost, httpClient, token

Constructor Summary

Constructors

Constructor	Description
AccountAccessesImpl(MailtrapConfig config)

Method Summary

Modifier and Type	Method	Description
List<AccountAccessResponse>	listUserAndInviteAccountAccesses(long accountId, @NonNull ListAccountAccessQueryParams params)	Get list of account accesses for which specifier_type is User or Invite.
RemoveAccountAccessResponse	removeAccountAccess(long accountAccessId, long accountId)	If specifier type is User, it removes user permissions.

Methods inherited from class java.lang.Object

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

Constructor Details

AccountAccessesImpl

public AccountAccessesImpl(MailtrapConfig config)

Method Details

listUserAndInviteAccountAccesses

public List<AccountAccessResponse> listUserAndInviteAccountAccesses(long accountId,
 @NonNull
 @NonNull ListAccountAccessQueryParams params)

Description copied from interface: AccountAccesses

Get list of account accesses for which specifier_type is User or Invite. Account admin/owner permissions for this endpoint to work.

Specified by:

listUserAndInviteAccountAccesses in interface AccountAccesses

Parameters:

accountId - unique account ID

params - additional query params. If specified - the endpoint will return account accesses for these resources

Returns:

account access details

removeAccountAccess

public RemoveAccountAccessResponse removeAccountAccess(long accountAccessId,
 long accountId)

Description copied from interface: AccountAccesses

If specifier type is User, it removes user permissions. If specifier type is Invite or ApiToken, it removes specifier along with permissions.

Account admin/owner permissions for this endpoint to work

Specified by:

removeAccountAccess in interface AccountAccesses

Parameters:

accountAccessId - unique account access ID

accountId - unique account ID

Returns:

confirmation of successful deletion and id of the deleted access