Package org.killbill.billing.jaxrs.resources

Class CustomFieldResource

java.lang.Object

org.killbill.billing.jaxrs.resources.JaxRsResourceBase

org.killbill.billing.jaxrs.resources.CustomFieldResource

All Implemented Interfaces:

JaxrsResource

@Singleton
@Path("/1.0/kb/customFields")
public class CustomFieldResource
extends JaxRsResourceBase

Field Summary

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

accountUserApi, auditUserApi, catalogName, clock, context, customFieldUserApi, DATE_TIME_FORMATTER, invoicePaymentApi, LOCAL_DATE_FORMATTER, mapper, paymentApi, subscriptionApi, tagUserApi, uriBuilder

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

ACCOUNTS, ACCOUNTS_PATH, ADMIN, ADMIN_PATH, ALL_CUSTOM_FIELDS, ALL_TAGS, ANALYTICS, ANALYTICS_PATH, ANYTHING_PATTERN, API_POSTFIX, API_PREFIX, API_VERSION, ATTEMPTS, AUDIT_LOG, AUDIT_LOG_WITH_HISTORY, AUTHORIZATION, BCD, BLOCK, BUNDLES, BUNDLES_PATH, CACHE, CANCEL_SCHEDULED_PAYMENT_TRANSACTION, CAPTURE, CATALOG, CATALOG_PATH, CBA_REBALANCING, CHARGEBACK_REVERSALS, CHARGEBACK_REVERSALS_PATH, CHARGEBACKS, CHARGEBACKS_PATH, CHARGES, CHARGES_PATH, CHILDREN, COMBO, COMMIT_INVOICE, CREDITS, CREDITS_PATH, CUSTOM_FIELDS, CUSTOM_FIELDS_PATH, DRY_RUN, EMAIL_NOTIFICATIONS, EMAILS, ENTITLEMENTS, ENTITLEMENTS_PATH, EVENTS, EXPORT, EXPORT_PATH, FORM, GROUP, 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, HEALTHCHECK, HOSTED, INVOICE_CATALOG_TRANSLATION, INVOICE_ITEMS, INVOICE_MP_TEMPLATE, INVOICE_PAYMENTS, INVOICE_PAYMENTS_PATH, INVOICE_TEMPLATE, INVOICE_TRANSLATION, INVOICES, INVOICES_ITEMS_PATH, INVOICES_PATH, MIGRATION, NODES_INFO, NODES_INFO_PATH, NOTIFICATION, NUMBER_PATTERN, OVERDUE, OVERDUE_PATH, PAGINATION, PATH_PAYMENT_PLUGIN_NAME, PAUSE, PAYMENT_GATEWAYS, PAYMENT_GATEWAYS_PATH, PAYMENT_METHODS, PAYMENT_METHODS_DEFAULT_PATH_POSTFIX, PAYMENT_METHODS_PATH, PAYMENT_TRANSACTIONS, PAYMENT_TRANSACTIONS_PATH, PAYMENTS, PAYMENTS_PATH, PLUGINS, PLUGINS_INFO, PLUGINS_INFO_PATH, PLUGINS_PATH, PREFIX, QUANTITY, QUERY_ACCOUNT_ID, QUERY_ACCOUNT_TREAT_NULL_AS_RESET, QUERY_ACCOUNT_WITH_BALANCE, QUERY_ACCOUNT_WITH_BALANCE_AND_CBA, QUERY_API_KEY, QUERY_AUDIT, QUERY_AUTO_COMMIT, QUERY_BCD_TRANSFER, QUERY_BILLING_POLICY, QUERY_BILLING_REQUESTED_DT, QUERY_BLOCKING_STATE_SVCS, QUERY_BLOCKING_STATE_TYPES, QUERY_BUNDLES_FILTER, QUERY_BUNDLES_RENAME_KEY_IF_EXIST_UNUSED, QUERY_CALL_COMPLETION, QUERY_CALL_TIMEOUT, QUERY_CANCEL_ALL_SUBSCRIPTIONS, QUERY_CUSTOM_FIELD, QUERY_DELETE_DEFAULT_PM_WITH_AUTO_PAY_OFF, QUERY_DELETE_IF_EXISTS, QUERY_END_DATE, QUERY_ENTITLEMENT_EFFECTIVE_FROM_DT, QUERY_ENTITLEMENT_POLICY, QUERY_ENTITLEMENT_REQUESTED_DT, QUERY_EXTERNAL_KEY, QUERY_FORCE_DEFAULT_PM_DELETION, QUERY_FORCE_NEW_BCD_WITH_PAST_EFFECTIVE_DATE, QUERY_FORCE_NEW_QUANTITY_WITH_PAST_EFFECTIVE_DATE, QUERY_INCLUDE_INVOICE_COMPONENTS, QUERY_INCLUDE_VOIDED_INVOICES, QUERY_INCLUDED_DELETED, QUERY_INVOICE_WITH_CHILDREN_ITEMS, QUERY_INVOICES_FILTER, QUERY_ITEM_ADJUST_UNPAID_INVOICES, QUERY_LOCAL_NODE_ONLY, QUERY_MIGRATED, QUERY_NOTIFICATION_CALLBACK, QUERY_OBJECT_TYPE, QUERY_PARALLEL, QUERY_PAY_ALL_UNPAID_INVOICES, QUERY_PAY_INVOICE, QUERY_PAYMENT_AMOUNT, QUERY_PAYMENT_CONTROL_PLUGIN_NAME, QUERY_PAYMENT_EXTERNAL, QUERY_PAYMENT_EXTERNAL_KEY, QUERY_PAYMENT_METHOD_ID, QUERY_PAYMENT_METHOD_IS_DEFAULT, QUERY_PAYMENT_METHOD_PLUGIN_NAME, QUERY_PAYMENT_PLUGIN_NAME, QUERY_PAYMENT_WITH_REFUNDS_AND_CHARGEBACKS, QUERY_PLUGIN_PROPERTY, QUERY_REMOVE_FUTURE_NOTIFICATIONS, QUERY_REQUESTED_DT, QUERY_SEARCH_LIMIT, QUERY_SEARCH_OFFSET, QUERY_SKIP_RESPONSE, QUERY_START_DATE, QUERY_TAG, QUERY_TAGS_INCLUDED_DELETED, QUERY_TARGET_DATE, QUERY_TENANT_USE_GLOBAL_DEFAULT, QUERY_TRANSACTION_EXTERNAL_KEY, QUERY_UNPAID_INVOICES_ONLY, QUERY_USE_REQUESTED_DATE_FOR_BILLING, QUERY_WITH_ATTEMPTS, QUERY_WITH_MIGRATION_INVOICES, QUERY_WITH_PLUGIN_INFO, QUERY_WRITE_OFF_UNPAID_INVOICES, REFUNDS, REGISTER_NOTIFICATION_CALLBACK, RENAME_KEY, RESUME, SEARCH, SECURITY, SECURITY_PATH, STRING_PATTERN, SUBSCRIPTIONS, SUBSCRIPTIONS_PATH, TAG_DEFINITIONS, TAG_DEFINITIONS_PATH, TAGS, TAGS_PATH, TAXES, TENANTS, TENANTS_PATH, TEST, TEST_PATH, TIMELINE, TRANSFER_CREDIT, UNDO_CANCEL, UNDO_CHANGE_PLAN, UPLOAD_PER_TENANT_CONFIG, UPLOAD_PLUGIN_CONFIG, UPLOAD_PLUGIN_PAYMENT_STATE_MACHINE_CONFIG, USAGES, USAGES_PATH, USER_KEY_VALUE, UUID_PATTERN, VOID_INVOICE

Constructor Summary

Constructors

Constructor	Description
CustomFieldResource(JaxrsUriBuilder uriBuilder, org.killbill.billing.util.api.TagUserApi tagUserApi, org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi, org.killbill.billing.util.api.AuditUserApi auditUserApi, AccountUserApi accountUserApi, PaymentApi paymentApi, InvoicePaymentApi invoicePaymentApi, org.killbill.clock.Clock clock, Context context)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getCustomFieldAuditLogsWithHistory(UUID customFieldId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getCustomFields(Long offset, Long limit, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	searchCustomFields(String searchKey, Long offset, Long limit, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	searchCustomFieldsByTypeName(String objectType, String fieldName, String fieldValue, Long offset, Long limit, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)

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

addBlockingState, buildStreamingPaginationResponse, completeTransactionInternal, createControlPluginApiPaymentOptions, createControlPluginApiPaymentOptions, createCustomFieldResponse, createCustomFields, createInvoicePaymentControlPluginApiPaymentOptions, createPaymentResponse, createPurchaseForInvoice, createPurchaseForInvoice, createTagResponse, createTags, deleteCustomFields, deleteTags, extractPluginProperties, extractPluginProperties, getAuditLogsWithHistory, getCustomFields, getInvoiceId, getObjectType, getPaymentByIdOrKey, getPaymentTransactions, getTagDefinitionUUIDs, getTags, isDateTime, lookupPendingOrSuccessTransaction, modifyCustomFields, toDateTime, toLocalDate, toLocalDateDefaultToday, toLocalDateDefaultToday, validatePaymentMethodForAccount, validateSanitizeAndTranformInputItems, verifyNonNull, verifyNonNullOrEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFieldResource

@Inject
public CustomFieldResource(JaxrsUriBuilder uriBuilder,
                           org.killbill.billing.util.api.TagUserApi tagUserApi,
                           org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi,
                           org.killbill.billing.util.api.AuditUserApi auditUserApi,
                           AccountUserApi accountUserApi,
                           PaymentApi paymentApi,
                           InvoicePaymentApi invoicePaymentApi,
                           org.killbill.clock.Clock clock,
                           Context context)

Method Detail

getCustomFields

@GET
@Path("/pagination")
@Produces("application/json")
public javax.ws.rs.core.Response getCustomFields(@QueryParam("offset") @DefaultValue("0")
                                                 Long offset,
                                                 @QueryParam("limit") @DefaultValue("100")
                                                 Long limit,
                                                 @QueryParam("audit") @DefaultValue("NONE")
                                                 AuditMode auditMode,
                                                 @Context
                                                 javax.servlet.http.HttpServletRequest request)
                                          throws org.killbill.billing.util.api.CustomFieldApiException

Throws:

org.killbill.billing.util.api.CustomFieldApiException

searchCustomFieldsByTypeName

@GET
@Path("/search")
@Produces("application/json")
public javax.ws.rs.core.Response searchCustomFieldsByTypeName(@QueryParam("objectType")
                                                              String objectType,
                                                              @QueryParam("fieldName")
                                                              String fieldName,
                                                              @Nullable @QueryParam("fieldValue")
                                                              String fieldValue,
                                                              @QueryParam("offset") @DefaultValue("0")
                                                              Long offset,
                                                              @QueryParam("limit") @DefaultValue("100")
                                                              Long limit,
                                                              @QueryParam("audit") @DefaultValue("NONE")
                                                              AuditMode auditMode,
                                                              @Context
                                                              javax.servlet.http.HttpServletRequest request)

searchCustomFields

@GET
@Path("/search/{searchKey:.*}")
@Produces("application/json")
public javax.ws.rs.core.Response searchCustomFields(@PathParam("searchKey")
                                                    String searchKey,
                                                    @QueryParam("offset") @DefaultValue("0")
                                                    Long offset,
                                                    @QueryParam("limit") @DefaultValue("100")
                                                    Long limit,
                                                    @QueryParam("audit") @DefaultValue("NONE")
                                                    AuditMode auditMode,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request)
                                             throws org.killbill.billing.util.api.CustomFieldApiException

Throws:

org.killbill.billing.util.api.CustomFieldApiException

getCustomFieldAuditLogsWithHistory

@GET
@Path("/{customFieldId:\\w+-\\w+-\\w+-\\w+-\\w+}/auditLogsWithHistory")
@Produces("application/json")
public javax.ws.rs.core.Response getCustomFieldAuditLogsWithHistory(@PathParam("customFieldId")
                                                                    UUID customFieldId,
                                                                    @Context
                                                                    javax.servlet.http.HttpServletRequest request)
                                                             throws AccountApiException

Throws:

AccountApiException