Class BundleResource
- java.lang.Object
-
- org.killbill.billing.jaxrs.resources.JaxRsResourceBase
-
- org.killbill.billing.jaxrs.resources.BundleResource
-
- All Implemented Interfaces:
JaxrsResource
@Singleton @Path("/1.0/kb/bundles") public class BundleResource 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, 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 BundleResource(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, SubscriptionApi subscriptionApi, EntitlementApi entitlementApi, PaymentApi paymentApi, InvoicePaymentApi invoicePaymentApi, org.killbill.clock.Clock clock, Context context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description javax.ws.rs.core.ResponseaddBundleBlockingState(UUID id, BlockingStateJson json, String requestedDate, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)javax.ws.rs.core.ResponsecreateBundleCustomFields(UUID bundleId, List<CustomFieldJson> customFields, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)javax.ws.rs.core.ResponsecreateBundleTags(UUID bundleId, List<UUID> tagList, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsedeleteBundleCustomFields(UUID bundleId, List<UUID> customFieldList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsedeleteBundleTags(UUID bundleId, List<UUID> tagList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsegetBundle(UUID bundleId, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsegetBundleAuditLogsWithHistory(UUID bundleId, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsegetBundleByKey(String externalKey, Boolean includedDeleted, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsegetBundles(Long offset, Long limit, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsegetCustomFields(UUID bundleId, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)protected org.killbill.billing.ObjectTypegetObjectType()javax.ws.rs.core.ResponsegetTags(UUID bundleId, Boolean includedDeleted, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsemodifyBundleCustomFields(UUID bundleId, List<CustomFieldJson> customFields, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsepauseBundle(UUID bundleId, String requestedDate, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponserenameExternalKey(UUID bundleId, BundleJson json, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponseresumeBundle(UUID bundleId, String requestedDate, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsesearchBundles(String searchKey, Long offset, Long limit, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)javax.ws.rs.core.ResponsetransferBundle(UUID bundleId, BundleJson json, String requestedDate, BillingActionPolicy billingPolicy, BcdTransfer bcdTransfer, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, 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, getPaymentByIdOrKey, getPaymentTransactions, getTagDefinitionUUIDs, getTags, isDateTime, lookupPendingOrSuccessTransaction, modifyCustomFields, toDateTime, toLocalDate, toLocalDateDefaultToday, toLocalDateDefaultToday, validatePaymentMethodForAccount, validateSanitizeAndTranformInputItems, verifyNonNull, verifyNonNullOrEmpty
-
-
-
-
Constructor Detail
-
BundleResource
@Inject public BundleResource(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, SubscriptionApi subscriptionApi, EntitlementApi entitlementApi, PaymentApi paymentApi, InvoicePaymentApi invoicePaymentApi, org.killbill.clock.Clock clock, Context context)
-
-
Method Detail
-
getBundle
@GET @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}") @Produces("application/json") public javax.ws.rs.core.Response getBundle(@PathParam("bundleId") UUID bundleId, @QueryParam("audit") @DefaultValue("NONE") AuditMode auditMode, @Context javax.servlet.http.HttpServletRequest request) throws SubscriptionApiException, AccountApiException, CatalogApiException
-
getBundleByKey
@GET @Produces("application/json") public javax.ws.rs.core.Response getBundleByKey(@QueryParam("externalKey") String externalKey, @QueryParam("includedDeleted") @DefaultValue("false") Boolean includedDeleted, @QueryParam("audit") @DefaultValue("NONE") AuditMode auditMode, @Context javax.servlet.http.HttpServletRequest request) throws SubscriptionApiException, AccountApiException, CatalogApiException
-
getBundleAuditLogsWithHistory
@GET @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/auditLogsWithHistory") @Produces("application/json") public javax.ws.rs.core.Response getBundleAuditLogsWithHistory(@PathParam("bundleId") UUID bundleId, @Context javax.servlet.http.HttpServletRequest request)
-
getBundles
@GET @Path("/pagination") @Produces("application/json") public javax.ws.rs.core.Response getBundles(@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 SubscriptionApiException- Throws:
SubscriptionApiException
-
searchBundles
@GET @Path("/search/{searchKey:.*}") @Produces("application/json") public javax.ws.rs.core.Response searchBundles(@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 SubscriptionApiException- Throws:
SubscriptionApiException
-
pauseBundle
@PUT @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/pause") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response pauseBundle(@PathParam("bundleId") UUID bundleId, @QueryParam("requestedDate") String requestedDate, @QueryParam("pluginProperty") List<String> pluginPropertiesString, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("X-Killbill-Comment") String comment, @Context javax.servlet.http.HttpServletRequest request) throws SubscriptionApiException, EntitlementApiException, AccountApiException
-
resumeBundle
@PUT @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/resume") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response resumeBundle(@PathParam("bundleId") UUID bundleId, @QueryParam("requestedDate") String requestedDate, @QueryParam("pluginProperty") List<String> pluginPropertiesString, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("X-Killbill-Comment") String comment, @Context javax.servlet.http.HttpServletRequest request) throws SubscriptionApiException, EntitlementApiException, AccountApiException
-
addBundleBlockingState
@POST @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/block") @Consumes("application/json") public javax.ws.rs.core.Response addBundleBlockingState(@PathParam("bundleId") UUID id, BlockingStateJson json, @QueryParam("requestedDate") String requestedDate, @QueryParam("pluginProperty") List<String> pluginPropertiesString, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("X-Killbill-Comment") String comment, @Context javax.servlet.http.HttpServletRequest request, @Context javax.ws.rs.core.UriInfo uriInfo) throws SubscriptionApiException, EntitlementApiException, AccountApiException
-
getCustomFields
@GET @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields") @Produces("application/json") public javax.ws.rs.core.Response getCustomFields(@PathParam("bundleId") UUID bundleId, @QueryParam("audit") @DefaultValue("NONE") AuditMode auditMode, @Context javax.servlet.http.HttpServletRequest request)
-
createBundleCustomFields
@POST @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response createBundleCustomFields(@PathParam("bundleId") UUID bundleId, List<CustomFieldJson> customFields, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("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
-
modifyBundleCustomFields
@PUT @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response modifyBundleCustomFields(@PathParam("bundleId") UUID bundleId, List<CustomFieldJson> customFields, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("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
-
deleteBundleCustomFields
@DELETE @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response deleteBundleCustomFields(@PathParam("bundleId") UUID bundleId, @QueryParam("customField") List<UUID> customFieldList, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("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
@GET @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/tags") @Produces("application/json") public javax.ws.rs.core.Response getTags(@PathParam("bundleId") UUID bundleId, @QueryParam("includedDeleted") @DefaultValue("false") Boolean includedDeleted, @QueryParam("audit") @DefaultValue("NONE") AuditMode auditMode, @Context javax.servlet.http.HttpServletRequest request) throws org.killbill.billing.util.api.TagDefinitionApiException, SubscriptionApiException- Throws:
org.killbill.billing.util.api.TagDefinitionApiExceptionSubscriptionApiException
-
transferBundle
@POST @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response transferBundle(@PathParam("bundleId") UUID bundleId, BundleJson json, @QueryParam("requestedDate") String requestedDate, @QueryParam("billingPolicy") @DefaultValue("END_OF_TERM") BillingActionPolicy billingPolicy, @QueryParam("bcdTransfer") @DefaultValue("USE_EXISTING") BcdTransfer bcdTransfer, @QueryParam("pluginProperty") List<String> pluginPropertiesString, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("X-Killbill-Comment") String comment, @Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.servlet.http.HttpServletRequest request) throws EntitlementApiException, SubscriptionApiException, AccountApiException
-
renameExternalKey
@PUT @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/renameKey") @Consumes("application/json") public javax.ws.rs.core.Response renameExternalKey(@PathParam("bundleId") UUID bundleId, BundleJson json, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("X-Killbill-Comment") String comment, @Context javax.ws.rs.core.UriInfo uriInfo, @Context javax.servlet.http.HttpServletRequest request) throws EntitlementApiException- Throws:
EntitlementApiException
-
createBundleTags
@POST @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/tags") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response createBundleTags(@PathParam("bundleId") UUID bundleId, List<UUID> tagList, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("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
-
deleteBundleTags
@DELETE @Path("/{bundleId:\\w+-\\w+-\\w+-\\w+-\\w+}/tags") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response deleteBundleTags(@PathParam("bundleId") UUID bundleId, @QueryParam("tagDef") List<UUID> tagList, @HeaderParam("X-Killbill-CreatedBy") String createdBy, @HeaderParam("X-Killbill-Reason") String reason, @HeaderParam("X-Killbill-Comment") String comment, @Context javax.servlet.http.HttpServletRequest request) throws org.killbill.billing.util.api.TagApiException- Throws:
org.killbill.billing.util.api.TagApiException
-
getObjectType
protected org.killbill.billing.ObjectType getObjectType()
- Overrides:
getObjectTypein classJaxRsResourceBase
-
-