org.killbill.billing.jaxrs.resources

Class AccountResource

java.lang.Object

org.killbill.billing.jaxrs.resources.JaxRsResourceBase

org.killbill.billing.jaxrs.resources.AccountResource

All Implemented Interfaces:

JaxrsResource

public class AccountResource
extends JaxRsResourceBase

Field Summary

Fields inherited from class org.killbill.billing.jaxrs.resources.JaxRsResourceBase

accountUserApi, auditUserApi, clock, context, customFieldUserApi, DATE_TIME_FORMATTER, LOCAL_DATE_FORMATTER, mapper, tagUserApi, uriBuilder

Fields inherited from interface org.killbill.billing.jaxrs.resources.JaxrsResource

ACCOUNTS, ACCOUNTS_PATH, ANALYTICS, ANALYTICS_PATH, ANYTHING_PATTERN, API_POSTFIX, API_PREFIX, API_VERSION, BUNDLES, BUNDLES_PATH, CATALOG, CATALOG_PATH, CBA_REBALANCING, CHARGEBACKS, CHARGEBACKS_PATH, CHARGES, CHARGES_PATH, CREDITS, CREDITS_PATH, CUSTOM_FIELDS, CUSTOM_FIELDS_PATH, EMAIL_NOTIFICATIONS, EMAILS, ENTITLEMENTS, ENTITLEMENTS_PATH, EXPORT, EXPORT_PATH, HDR_API_KEY, HDR_API_SECRET, HDR_COMMENT, HDR_CREATED_BY, HDR_PAGINATION_CURRENT_OFFSET, HDR_PAGINATION_MAX_NB_RECORDS, HDR_PAGINATION_NEXT_OFFSET, HDR_PAGINATION_NEXT_PAGE_URI, HDR_PAGINATION_TOTAL_NB_RECORDS, HDR_REASON, INVOICES, INVOICES_PATH, NUMBER_PATTERN, OVERDUE, OVERDUE_PATH, PAGINATION, PAUSE, PAYMENT_METHODS, PAYMENT_METHODS_DEFAULT_PATH_POSTFIX, PAYMENT_METHODS_PATH, PAYMENTS, PAYMENTS_PATH, PLUGINS, PLUGINS_PATH, PREFIX, QUERY_ACCOUNT_ID, QUERY_ACCOUNT_WITH_BALANCE, QUERY_ACCOUNT_WITH_BALANCE_AND_CBA, QUERY_API_KEY, QUERY_AUDIT, QUERY_BILLING_POLICY, QUERY_BUNDLE_TRANSFER_ADDON, QUERY_BUNDLE_TRANSFER_CANCEL_IMM, QUERY_CALL_COMPLETION, QUERY_CALL_TIMEOUT, QUERY_CUSTOM_FIELDS, QUERY_DELETE_DEFAULT_PM_WITH_AUTO_PAY_OFF, QUERY_DRY_RUN, QUERY_END_TIME, QUERY_ENTITLEMENT_POLICY, QUERY_EXTERNAL_KEY, QUERY_INVOICE_WITH_ITEMS, QUERY_NOTIFICATION_CALLBACK, QUERY_PAY_ALL_UNPAID_INVOICES, QUERY_PAY_INVOICE, QUERY_PAYMENT_EXTERNAL, QUERY_PAYMENT_METHOD_IS_DEFAULT, QUERY_PAYMENT_METHOD_PLUGIN_INFO, QUERY_PAYMENT_METHOD_PLUGIN_NAME, QUERY_PAYMENT_PLUGIN_NAME, QUERY_PAYMENT_WITH_REFUNDS_AND_CHARGEBACKS, QUERY_REQUESTED_DT, QUERY_SEARCH_LIMIT, QUERY_SEARCH_OFFSET, QUERY_START_TIME, QUERY_TAGS, QUERY_TAGS_INCLUDED_DELETED, QUERY_TARGET_DATE, QUERY_UNPAID_INVOICES_ONLY, QUERY_USE_REQUESTED_DATE_FOR_BILLING, REFUNDS, REFUNDS_PATH, REGISTER_NOTIFICATION_CALLBACK, RESUME, SEARCH, SECURITY, SECURITY_PATH, STRING_PATTERN, SUBSCRIPTIONS, SUBSCRIPTIONS_PATH, TAG_DEFINITIONS, TAG_DEFINITIONS_PATH, TAGS, TAGS_PATH, TENANTS, TENANTS_PATH, TIMELINE, USAGES, USAGES_PATH, UUID_PATTERN

Constructor Summary

Constructors

Constructor and Description

AccountResource(JaxrsUriBuilder uriBuilder, AccountUserApi accountApi, InvoiceUserApi invoiceApi, InvoicePaymentApi invoicePaymentApi, PaymentApi paymentApi, org.killbill.billing.util.api.TagUserApi tagUserApi, org.killbill.billing.util.api.AuditUserApi auditUserApi, org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi, SubscriptionApi subscriptionApi, OverdueUserApi overdueApi, org.killbill.clock.Clock clock, Context context)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addEmail(AccountEmailJson json, String id, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	cancelAccount(String accountId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	createAccount(AccountJson json, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createCustomFields(String id, List<CustomFieldJson> customFields, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createPaymentMethod(PaymentMethodJson json, String accountId, Boolean isDefault, Boolean payAllUnpaidInvoices, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	createTags(String id, String tagList, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteCustomFields(String id, String customFieldList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteTags(String id, String tagList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccount(String accountId, Boolean accountWithBalance, Boolean accountWithBalanceAndCBA, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountBundles(String accountId, String externalKey, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountByKey(String externalKey, Boolean accountWithBalance, Boolean accountWithBalanceAndCBA, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccounts(Long offset, Long limit, Boolean accountWithBalance, Boolean accountWithBalanceAndCBA, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountTimeline(String accountIdString, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getChargebacksForAccount(String accountIdStr, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getCustomFields(String id, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getEmailNotificationsForAccount(InvoiceEmailJson json, String accountIdString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getEmailNotificationsForAccount(String accountId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getEmails(String id, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getInvoices(String accountIdString, boolean withItems, boolean unpaidInvoicesOnly, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
protected org.killbill.billing.ObjectType	getObjectType()
javax.ws.rs.core.Response	getOverdueAccount(String accountId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getPaymentMethods(String accountId, Boolean withPluginInfo, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getPayments(String accountId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getRefunds(String accountId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getTags(String accountIdString, AuditMode auditMode, Boolean includedDeleted, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	payAllInvoices(String accountId, Boolean externalPayment, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	rebalanceExistingCBAOnAccount(String accountIdString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	removeEmail(String id, String email, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	searchAccounts(String searchKey, Long offset, Long limit, Boolean accountWithBalance, Boolean accountWithBalanceAndCBA, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	setDefaultPaymentMethod(String accountId, String paymentMethodId, Boolean payAllUnpaidInvoices, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	updateAccount(AccountJson json, String accountId, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.killbill.billing.jaxrs.resources.JaxRsResourceBase

buildStreamingPaginationResponse, createCustomFields, createTags, deleteCustomFields, deleteTags, getCustomFields, getTagDefinitionUUIDs, getTags, toLocalDate, toLocalDate

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountResource

@Inject
public AccountResource(JaxrsUriBuilder uriBuilder,
                      AccountUserApi accountApi,
                      InvoiceUserApi invoiceApi,
                      InvoicePaymentApi invoicePaymentApi,
                      PaymentApi paymentApi,
                      org.killbill.billing.util.api.TagUserApi tagUserApi,
                      org.killbill.billing.util.api.AuditUserApi auditUserApi,
                      org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi,
                      SubscriptionApi subscriptionApi,
                      OverdueUserApi overdueApi,
                      org.killbill.clock.Clock clock,
                      Context context)

Method Detail

getAccount

public javax.ws.rs.core.Response getAccount(String accountId,
                                   Boolean accountWithBalance,
                                   Boolean accountWithBalanceAndCBA,
                                   AuditMode auditMode,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws AccountApiException

Throws:

AccountApiException

getAccounts

public javax.ws.rs.core.Response getAccounts(Long offset,
                                    Long limit,
                                    Boolean accountWithBalance,
                                    Boolean accountWithBalanceAndCBA,
                                    AuditMode auditMode,
                                    @Context
                                    javax.servlet.http.HttpServletRequest request)
                                      throws AccountApiException

Throws:

AccountApiException

searchAccounts

public javax.ws.rs.core.Response searchAccounts(String searchKey,
                                       Long offset,
                                       Long limit,
                                       Boolean accountWithBalance,
                                       Boolean accountWithBalanceAndCBA,
                                       AuditMode auditMode,
                                       @Context
                                       javax.servlet.http.HttpServletRequest request)
                                         throws AccountApiException

Throws:

AccountApiException

getAccountBundles

public javax.ws.rs.core.Response getAccountBundles(String accountId,
                                          String externalKey,
                                          @Context
                                          javax.servlet.http.HttpServletRequest request)
                                            throws AccountApiException,
                                                   SubscriptionApiException

Throws:

AccountApiException

SubscriptionApiException

getAccountByKey

public javax.ws.rs.core.Response getAccountByKey(String externalKey,
                                        Boolean accountWithBalance,
                                        Boolean accountWithBalanceAndCBA,
                                        AuditMode auditMode,
                                        @Context
                                        javax.servlet.http.HttpServletRequest request)
                                          throws AccountApiException

Throws:

AccountApiException

createAccount

public javax.ws.rs.core.Response createAccount(AccountJson json,
                                      @HeaderParam(value="X-Killbill-CreatedBy")
                                      String createdBy,
                                      @HeaderParam(value="X-Killbill-Reason")
                                      String reason,
                                      @HeaderParam(value="X-Killbill-Comment")
                                      String comment,
                                      @Context
                                      javax.servlet.http.HttpServletRequest request,
                                      @Context
                                      javax.ws.rs.core.UriInfo uriInfo)
                                        throws AccountApiException

Throws:

AccountApiException

updateAccount

public javax.ws.rs.core.Response updateAccount(AccountJson json,
                                      String accountId,
                                      @HeaderParam(value="X-Killbill-CreatedBy")
                                      String createdBy,
                                      @HeaderParam(value="X-Killbill-Reason")
                                      String reason,
                                      @HeaderParam(value="X-Killbill-Comment")
                                      String comment,
                                      @Context
                                      javax.servlet.http.HttpServletRequest request)
                                        throws AccountApiException

Throws:

AccountApiException

cancelAccount

public javax.ws.rs.core.Response cancelAccount(String accountId,
                                      @Context
                                      javax.servlet.http.HttpServletRequest request)

getAccountTimeline

public javax.ws.rs.core.Response getAccountTimeline(String accountIdString,
                                           AuditMode auditMode,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)
                                             throws AccountApiException,
                                                    PaymentApiException,
                                                    SubscriptionApiException

Throws:

AccountApiException

PaymentApiException

SubscriptionApiException

getEmailNotificationsForAccount

public javax.ws.rs.core.Response getEmailNotificationsForAccount(String accountId,
                                                        @Context
                                                        javax.servlet.http.HttpServletRequest request)
                                                          throws AccountApiException

Throws:

AccountApiException

getEmailNotificationsForAccount

public javax.ws.rs.core.Response getEmailNotificationsForAccount(InvoiceEmailJson json,
                                                        String accountIdString,
                                                        @HeaderParam(value="X-Killbill-CreatedBy")
                                                        String createdBy,
                                                        @HeaderParam(value="X-Killbill-Reason")
                                                        String reason,
                                                        @HeaderParam(value="X-Killbill-Comment")
                                                        String comment,
                                                        @Context
                                                        javax.servlet.http.HttpServletRequest request)
                                                          throws AccountApiException

Throws:

AccountApiException

rebalanceExistingCBAOnAccount

public javax.ws.rs.core.Response rebalanceExistingCBAOnAccount(String accountIdString,
                                                      @HeaderParam(value="X-Killbill-CreatedBy")
                                                      String createdBy,
                                                      @HeaderParam(value="X-Killbill-Reason")
                                                      String reason,
                                                      @HeaderParam(value="X-Killbill-Comment")
                                                      String comment,
                                                      @Context
                                                      javax.servlet.http.HttpServletRequest request)
                                                        throws AccountApiException

Throws:

AccountApiException

getInvoices

public javax.ws.rs.core.Response getInvoices(String accountIdString,
                                    boolean withItems,
                                    boolean unpaidInvoicesOnly,
                                    AuditMode auditMode,
                                    @Context
                                    javax.servlet.http.HttpServletRequest request)
                                      throws AccountApiException

Throws:

AccountApiException

getPayments

public javax.ws.rs.core.Response getPayments(String accountId,
                                    @Context
                                    javax.servlet.http.HttpServletRequest request)
                                      throws PaymentApiException

Throws:

PaymentApiException

payAllInvoices

public javax.ws.rs.core.Response payAllInvoices(String accountId,
                                       Boolean externalPayment,
                                       @HeaderParam(value="X-Killbill-CreatedBy")
                                       String createdBy,
                                       @HeaderParam(value="X-Killbill-Reason")
                                       String reason,
                                       @HeaderParam(value="X-Killbill-Comment")
                                       String comment,
                                       @Context
                                       javax.servlet.http.HttpServletRequest request)
                                         throws AccountApiException,
                                                PaymentApiException

Throws:

AccountApiException

PaymentApiException

createPaymentMethod

public javax.ws.rs.core.Response createPaymentMethod(PaymentMethodJson json,
                                            String accountId,
                                            Boolean isDefault,
                                            Boolean payAllUnpaidInvoices,
                                            @HeaderParam(value="X-Killbill-CreatedBy")
                                            String createdBy,
                                            @HeaderParam(value="X-Killbill-Reason")
                                            String reason,
                                            @HeaderParam(value="X-Killbill-Comment")
                                            String comment,
                                            @Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            @Context
                                            javax.servlet.http.HttpServletRequest request)
                                              throws AccountApiException,
                                                     PaymentApiException

Throws:

AccountApiException

PaymentApiException

getPaymentMethods

public javax.ws.rs.core.Response getPaymentMethods(String accountId,
                                          Boolean withPluginInfo,
                                          AuditMode auditMode,
                                          @Context
                                          javax.servlet.http.HttpServletRequest request)
                                            throws AccountApiException,
                                                   PaymentApiException

Throws:

AccountApiException

PaymentApiException

setDefaultPaymentMethod

public javax.ws.rs.core.Response setDefaultPaymentMethod(String accountId,
                                                String paymentMethodId,
                                                Boolean payAllUnpaidInvoices,
                                                @HeaderParam(value="X-Killbill-CreatedBy")
                                                String createdBy,
                                                @HeaderParam(value="X-Killbill-Reason")
                                                String reason,
                                                @HeaderParam(value="X-Killbill-Comment")
                                                String comment,
                                                @Context
                                                javax.servlet.http.HttpServletRequest request)
                                                  throws AccountApiException,
                                                         PaymentApiException

Throws:

AccountApiException

PaymentApiException

getChargebacksForAccount

public javax.ws.rs.core.Response getChargebacksForAccount(String accountIdStr,
                                                 @Context
                                                 javax.servlet.http.HttpServletRequest request)

getRefunds

public javax.ws.rs.core.Response getRefunds(String accountId,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws AccountApiException,
                                            PaymentApiException

Throws:

AccountApiException

PaymentApiException

getOverdueAccount

public javax.ws.rs.core.Response getOverdueAccount(String accountId,
                                          @Context
                                          javax.servlet.http.HttpServletRequest request)
                                            throws AccountApiException,
                                                   OverdueException,
                                                   OverdueApiException

Throws:

AccountApiException

OverdueException

OverdueApiException

getCustomFields

public javax.ws.rs.core.Response getCustomFields(String id,
                                        AuditMode auditMode,
                                        @Context
                                        javax.servlet.http.HttpServletRequest request)

createCustomFields

public javax.ws.rs.core.Response createCustomFields(String id,
                                           List<CustomFieldJson> customFields,
                                           @HeaderParam(value="X-Killbill-CreatedBy")
                                           String createdBy,
                                           @HeaderParam(value="X-Killbill-Reason")
                                           String reason,
                                           @HeaderParam(value="X-Killbill-Comment")
                                           String comment,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo)
                                             throws org.killbill.billing.util.api.CustomFieldApiException

Throws:

org.killbill.billing.util.api.CustomFieldApiException

deleteCustomFields

public javax.ws.rs.core.Response deleteCustomFields(String id,
                                           String customFieldList,
                                           @HeaderParam(value="X-Killbill-CreatedBy")
                                           String createdBy,
                                           @HeaderParam(value="X-Killbill-Reason")
                                           String reason,
                                           @HeaderParam(value="X-Killbill-Comment")
                                           String comment,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)
                                             throws org.killbill.billing.util.api.CustomFieldApiException

Throws:

org.killbill.billing.util.api.CustomFieldApiException

getTags

public javax.ws.rs.core.Response getTags(String accountIdString,
                                AuditMode auditMode,
                                Boolean includedDeleted,
                                @Context
                                javax.servlet.http.HttpServletRequest request)
                                  throws org.killbill.billing.util.api.TagDefinitionApiException

Throws:

org.killbill.billing.util.api.TagDefinitionApiException

createTags

public javax.ws.rs.core.Response createTags(String id,
                                   String tagList,
                                   @HeaderParam(value="X-Killbill-CreatedBy")
                                   String createdBy,
                                   @HeaderParam(value="X-Killbill-Reason")
                                   String reason,
                                   @HeaderParam(value="X-Killbill-Comment")
                                   String comment,
                                   @Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws org.killbill.billing.util.api.TagApiException

Throws:

org.killbill.billing.util.api.TagApiException

deleteTags

public javax.ws.rs.core.Response deleteTags(String id,
                                   String tagList,
                                   @HeaderParam(value="X-Killbill-CreatedBy")
                                   String createdBy,
                                   @HeaderParam(value="X-Killbill-Reason")
                                   String reason,
                                   @HeaderParam(value="X-Killbill-Comment")
                                   String comment,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws org.killbill.billing.util.api.TagApiException,
                                            AccountApiException

Throws:

org.killbill.billing.util.api.TagApiException

AccountApiException

getEmails

public javax.ws.rs.core.Response getEmails(String id,
                                  @Context
                                  javax.servlet.http.HttpServletRequest request)

addEmail

public javax.ws.rs.core.Response addEmail(AccountEmailJson json,
                                 String id,
                                 @HeaderParam(value="X-Killbill-CreatedBy")
                                 String createdBy,
                                 @HeaderParam(value="X-Killbill-Reason")
                                 String reason,
                                 @HeaderParam(value="X-Killbill-Comment")
                                 String comment,
                                 @Context
                                 javax.servlet.http.HttpServletRequest request,
                                 @Context
                                 javax.ws.rs.core.UriInfo uriInfo)
                                   throws AccountApiException

Throws:

AccountApiException

removeEmail

public javax.ws.rs.core.Response removeEmail(String id,
                                    String email,
                                    @HeaderParam(value="X-Killbill-CreatedBy")
                                    String createdBy,
                                    @HeaderParam(value="X-Killbill-Reason")
                                    String reason,
                                    @HeaderParam(value="X-Killbill-Comment")
                                    String comment,
                                    @Context
                                    javax.servlet.http.HttpServletRequest request)

getObjectType

protected org.killbill.billing.ObjectType getObjectType()

Overrides:

getObjectType in class JaxRsResourceBase