org.killbill.billing.account.api

Interface AccountUserApi

All Superinterfaces:

KillbillApi

public interface AccountUserApi
extends KillbillApi

The interface AccountUserApi offers APIs related to account operations.

Method Summary

Modifier and Type	Method and Description
void	addEmail(java.util.UUID accountId, AccountEmail email, CallContext context)
Account	createAccount(AccountData data, CallContext context)
Account	getAccountById(java.util.UUID accountId, TenantContext context)
Account	getAccountByKey(java.lang.String key, TenantContext context) Retrieves an account by specifying its external key.
Pagination<Account>	getAccounts(java.lang.Long offset, java.lang.Long limit, TenantContext context)
java.util.List<AuditLogWithHistory>	getAuditLogsWithHistoryForId(java.util.UUID accountId, AuditLevel auditLevel, TenantContext context) Get all the audit entries with history for a given account.
java.util.List<Account>	getChildrenAccounts(java.util.UUID parentAccountId, TenantContext context)
java.util.List<AuditLogWithHistory>	getEmailAuditLogsWithHistoryForId(java.util.UUID accountEmailId, AuditLevel auditLevel, TenantContext context) Get all the audit entries with history for a given account email.
java.util.List<AccountEmail>	getEmails(java.util.UUID accountId, TenantContext context)
java.util.UUID	getIdFromKey(java.lang.String externalKey, TenantContext context)
void	removeEmail(java.util.UUID accountId, AccountEmail email, CallContext context)
Pagination<Account>	searchAccounts(java.lang.String searchKey, java.lang.Long offset, java.lang.Long limit, TenantContext context) Find all accounts having their name, email, external_key or company_name matching the search key
void	updateAccount(Account account, CallContext context) Updates the account by specifying the destination Account object
void	updateAccount(java.lang.String key, AccountData accountData, CallContext context) Updates the account by specifying the AccountData object
void	updateAccount(java.util.UUID accountId, AccountData accountData, CallContext context) Updates the account by specifying the AccountData object

Method Detail

createAccount

Account createAccount(AccountData data,
                      CallContext context)
               throws AccountApiException

Parameters:

data - the account data

context - the user context

Returns:

the created Account

Throws:

AccountApiException

updateAccount

void updateAccount(Account account,
                   CallContext context)
            throws AccountApiException

Updates the account by specifying the destination Account object

Parameters:

account - account to be updated

context - contains specific information about the call

Throws:

AccountApiException - if a failure occurs

updateAccount

void updateAccount(java.lang.String key,
                   AccountData accountData,
                   CallContext context)
            throws AccountApiException

Updates the account by specifying the AccountData object

Parameters:

key - account external key

context - contains specific information about the call

Throws:

AccountApiException - if a failure occurs

updateAccount

void updateAccount(java.util.UUID accountId,
                   AccountData accountData,
                   CallContext context)
            throws AccountApiException

Updates the account by specifying the AccountData object

Parameters:

accountId - account unique id

context - contains specific information about the call

Throws:

AccountApiException - if a failure occurs

getAccountByKey

Account getAccountByKey(java.lang.String key,
                        TenantContext context)
                 throws AccountApiException

Retrieves an account by specifying its external key.

Note that the system will enforce that only one account for a given external key exists in the system

Parameters:

key - the externalKey for the account

context - the user context

Returns:

the account

Throws:

AccountApiException - if there is no such account

getAccountById

Account getAccountById(java.util.UUID accountId,
                       TenantContext context)
                throws AccountApiException

Parameters:

accountId - the unique id for the account

context - the user context

Returns:

the account

Throws:

AccountApiException - if there is no such account

searchAccounts

Pagination<Account> searchAccounts(java.lang.String searchKey,
                                   java.lang.Long offset,
                                   java.lang.Long limit,
                                   TenantContext context)

Find all accounts having their name, email, external_key or company_name matching the search key

Parameters:

searchKey - the search key

offset - the offset of the first result

limit - the maximum number of results to retrieve

context - the user context

Returns:

the list of accounts matching this search key for that tenant

getAccounts

Pagination<Account> getAccounts(java.lang.Long offset,
                                java.lang.Long limit,
                                TenantContext context)

Parameters:

context - the user context

offset - the offset of the first result

limit - the maximum number of results to retrieve

Returns:

the list of accounts for that tenant

getIdFromKey

java.util.UUID getIdFromKey(java.lang.String externalKey,
                            TenantContext context)
                     throws AccountApiException

Parameters:

externalKey - the externalKey for the account

context - the user context

Returns:

the unique id for that account

Throws:

AccountApiException - if there is no such account

getEmails

java.util.List<AccountEmail> getEmails(java.util.UUID accountId,
                                       TenantContext context)

Parameters:

accountId - the account unique id

context - the user context

Returns:

the list of emails configured for that account

addEmail

void addEmail(java.util.UUID accountId,
              AccountEmail email,
              CallContext context)
       throws AccountApiException

Parameters:

accountId - the account unique id

email - the email to be added

context - the user context

Throws:

AccountApiException

removeEmail

void removeEmail(java.util.UUID accountId,
                 AccountEmail email,
                 CallContext context)

Parameters:

accountId - the account unique id

email - the email to be removed

context - the user context

getChildrenAccounts

java.util.List<Account> getChildrenAccounts(java.util.UUID parentAccountId,
                                            TenantContext context)
                                     throws AccountApiException

Parameters:

parentAccountId - the parent account unique id

context - the user context

Returns:

the list of children accounts for that parent account id

Throws:

AccountApiException

getAuditLogsWithHistoryForId

java.util.List<AuditLogWithHistory> getAuditLogsWithHistoryForId(java.util.UUID accountId,
                                                                 AuditLevel auditLevel,
                                                                 TenantContext context)
                                                          throws AccountApiException

Get all the audit entries with history for a given account.

Parameters:

accountId - the account id

auditLevel - audit level (verbosity)

context - the tenant context

Returns:

all audit entries with history for an account

Throws:

AccountApiException

getEmailAuditLogsWithHistoryForId

java.util.List<AuditLogWithHistory> getEmailAuditLogsWithHistoryForId(java.util.UUID accountEmailId,
                                                                      AuditLevel auditLevel,
                                                                      TenantContext context)
                                                               throws AccountApiException

Get all the audit entries with history for a given account email.

Parameters:

accountEmailId - the account email id

auditLevel - audit level (verbosity)

context - the tenant context

Returns:

all audit entries with history for an account email

Throws:

AccountApiException