Package com.chargebee.v4.services

Class ExportService

java.lang.Object

com.chargebee.v4.services.BaseService<ExportService>

com.chargebee.v4.services.ExportService

public final class ExportService
extends BaseService<ExportService>

Field Summary

Fields inherited from class com.chargebee.v4.services.BaseService

client, options

Constructor Summary

Constructors

Constructor	Description
ExportService(ChargebeeClient client)

Method Summary

Modifier and Type	Method	Description
ExportAddonsResponse	addons(ExportAddonsParams params)
CompletableFuture<ExportAddonsResponse>	addonsAsync(ExportAddonsParams params)	Async variant of addons for export with params.
ExportAttachedItemsResponse	attachedItems(ExportAttachedItemsParams params)
CompletableFuture<ExportAttachedItemsResponse>	attachedItemsAsync(ExportAttachedItemsParams params)	Async variant of attachedItems for export with params.
ExportCouponsResponse	coupons(ExportCouponsParams params)
CompletableFuture<ExportCouponsResponse>	couponsAsync(ExportCouponsParams params)	Async variant of coupons for export with params.
ExportCreditNotesResponse	creditNotes(ExportCreditNotesParams params)
CompletableFuture<ExportCreditNotesResponse>	creditNotesAsync(ExportCreditNotesParams params)	Async variant of creditNotes for export with params.
ExportCustomersResponse	customers(ExportCustomersParams params)
CompletableFuture<ExportCustomersResponse>	customersAsync(ExportCustomersParams params)	Async variant of customers for export with params.
ExportDeferredRevenueResponse	deferredRevenue(ExportDeferredRevenueParams params)
CompletableFuture<ExportDeferredRevenueResponse>	deferredRevenueAsync(ExportDeferredRevenueParams params)	Async variant of deferredRevenue for export with params.
ExportDifferentialPricesResponse	differentialPrices(ExportDifferentialPricesParams params)
CompletableFuture<ExportDifferentialPricesResponse>	differentialPricesAsync(ExportDifferentialPricesParams params)	Async variant of differentialPrices for export with params.
ExportInvoicesResponse	invoices(ExportInvoicesParams params)
CompletableFuture<ExportInvoicesResponse>	invoicesAsync(ExportInvoicesParams params)	Async variant of invoices for export with params.
ExportItemFamiliesResponse	itemFamilies(ExportItemFamiliesParams params)
CompletableFuture<ExportItemFamiliesResponse>	itemFamiliesAsync(ExportItemFamiliesParams params)	Async variant of itemFamilies for export with params.
ExportItemPricesResponse	itemPrices(ExportItemPricesParams params)
CompletableFuture<ExportItemPricesResponse>	itemPricesAsync(ExportItemPricesParams params)	Async variant of itemPrices for export with params.
ExportItemsResponse	items(ExportItemsParams params)
CompletableFuture<ExportItemsResponse>	itemsAsync(ExportItemsParams params)	Async variant of items for export with params.
ExportOrdersResponse	orders(ExportOrdersParams params)
CompletableFuture<ExportOrdersResponse>	ordersAsync(ExportOrdersParams params)	Async variant of orders for export with params.
ExportPlansResponse	plans(ExportPlansParams params)
CompletableFuture<ExportPlansResponse>	plansAsync(ExportPlansParams params)	Async variant of plans for export with params.
ExportPriceVariantsResponse	priceVariants(ExportPriceVariantsParams params)
CompletableFuture<ExportPriceVariantsResponse>	priceVariantsAsync(ExportPriceVariantsParams params)	Async variant of priceVariants for export with params.
ExportRetrieveResponse	retrieve(String exportId)
CompletableFuture<ExportRetrieveResponse>	retrieveAsync(String exportId)	Async variant of retrieve for export without params.
ExportRevenueRecognitionResponse	revenueRecognition(ExportRevenueRecognitionParams params)
CompletableFuture<ExportRevenueRecognitionResponse>	revenueRecognitionAsync(ExportRevenueRecognitionParams params)	Async variant of revenueRecognition for export with params.
ExportSubscriptionsResponse	subscriptions(ExportSubscriptionsParams params)
CompletableFuture<ExportSubscriptionsResponse>	subscriptionsAsync(ExportSubscriptionsParams params)	Async variant of subscriptions for export with params.
ExportTransactionsResponse	transactions(ExportTransactionsParams params)
CompletableFuture<ExportTransactionsResponse>	transactionsAsync(ExportTransactionsParams params)	Async variant of transactions for export with params.
Export	waitForExportCompletion(Export export)	Waits for an export operation to complete by polling its status.
ExportService	withOptions(RequestOptions options)	Apply per-request options for this service instance.

Methods inherited from class com.chargebee.v4.services.BaseService

buildPathWithParams, clientForBuilders, clientWithOptions, get, getAsync, getMergedHeaders, getWithSubDomain, getWithSubDomainAsync, header, headers, options, parseResponse, post, postAsync, postJson, postJsonAsync, postJsonWithSubDomain, postJsonWithSubDomainAsync, postWithSubDomain, postWithSubDomainAsync

Methods inherited from class java.lang.Object

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

Constructor Details

ExportService

public ExportService(ChargebeeClient client)

Method Details

withOptions

public ExportService withOptions(RequestOptions options)

Apply per-request options for this service instance. Users can chain .withOptions or .options to set headers and other options.

Overrides:

withOptions in class BaseService<ExportService>

customers

public ExportCustomersResponse customers(ExportCustomersParams params)
                                  throws ChargebeeException

Throws:

ChargebeeException

customersAsync

public CompletableFuture<ExportCustomersResponse> customersAsync(ExportCustomersParams params)

Async variant of customers for export with params.

attachedItems

public ExportAttachedItemsResponse attachedItems(ExportAttachedItemsParams params)
                                          throws ChargebeeException

Throws:

ChargebeeException

attachedItemsAsync

public CompletableFuture<ExportAttachedItemsResponse> attachedItemsAsync(ExportAttachedItemsParams params)

Async variant of attachedItems for export with params.

transactions

public ExportTransactionsResponse transactions(ExportTransactionsParams params)
                                        throws ChargebeeException

Throws:

ChargebeeException

transactionsAsync

public CompletableFuture<ExportTransactionsResponse> transactionsAsync(ExportTransactionsParams params)

Async variant of transactions for export with params.

differentialPrices

public ExportDifferentialPricesResponse differentialPrices(ExportDifferentialPricesParams params)
                                                    throws ChargebeeException

Throws:

ChargebeeException

differentialPricesAsync

public CompletableFuture<ExportDifferentialPricesResponse> differentialPricesAsync(ExportDifferentialPricesParams params)

Async variant of differentialPrices for export with params.

itemFamilies

public ExportItemFamiliesResponse itemFamilies(ExportItemFamiliesParams params)
                                        throws ChargebeeException

Throws:

ChargebeeException

itemFamiliesAsync

public CompletableFuture<ExportItemFamiliesResponse> itemFamiliesAsync(ExportItemFamiliesParams params)

Async variant of itemFamilies for export with params.

invoices

public ExportInvoicesResponse invoices(ExportInvoicesParams params)
                                throws ChargebeeException

Throws:

ChargebeeException

invoicesAsync

public CompletableFuture<ExportInvoicesResponse> invoicesAsync(ExportInvoicesParams params)

Async variant of invoices for export with params.

retrieve

public ExportRetrieveResponse retrieve(String exportId)
                                throws ChargebeeException

Throws:

ChargebeeException

retrieveAsync

public CompletableFuture<ExportRetrieveResponse> retrieveAsync(String exportId)

Async variant of retrieve for export without params.

priceVariants

public ExportPriceVariantsResponse priceVariants(ExportPriceVariantsParams params)
                                          throws ChargebeeException

Throws:

ChargebeeException

priceVariantsAsync

public CompletableFuture<ExportPriceVariantsResponse> priceVariantsAsync(ExportPriceVariantsParams params)

Async variant of priceVariants for export with params.

items

public ExportItemsResponse items(ExportItemsParams params)
                          throws ChargebeeException

Throws:

ChargebeeException

itemsAsync

public CompletableFuture<ExportItemsResponse> itemsAsync(ExportItemsParams params)

Async variant of items for export with params.

deferredRevenue

public ExportDeferredRevenueResponse deferredRevenue(ExportDeferredRevenueParams params)
                                              throws ChargebeeException

Throws:

ChargebeeException

deferredRevenueAsync

public CompletableFuture<ExportDeferredRevenueResponse> deferredRevenueAsync(ExportDeferredRevenueParams params)

Async variant of deferredRevenue for export with params.

revenueRecognition

public ExportRevenueRecognitionResponse revenueRecognition(ExportRevenueRecognitionParams params)
                                                    throws ChargebeeException

Throws:

ChargebeeException

revenueRecognitionAsync

public CompletableFuture<ExportRevenueRecognitionResponse> revenueRecognitionAsync(ExportRevenueRecognitionParams params)

Async variant of revenueRecognition for export with params.

creditNotes

public ExportCreditNotesResponse creditNotes(ExportCreditNotesParams params)
                                      throws ChargebeeException

Throws:

ChargebeeException

creditNotesAsync

public CompletableFuture<ExportCreditNotesResponse> creditNotesAsync(ExportCreditNotesParams params)

Async variant of creditNotes for export with params.

coupons

public ExportCouponsResponse coupons(ExportCouponsParams params)
                              throws ChargebeeException

Throws:

ChargebeeException

couponsAsync

public CompletableFuture<ExportCouponsResponse> couponsAsync(ExportCouponsParams params)

Async variant of coupons for export with params.

orders

public ExportOrdersResponse orders(ExportOrdersParams params)
                            throws ChargebeeException

Throws:

ChargebeeException

ordersAsync

public CompletableFuture<ExportOrdersResponse> ordersAsync(ExportOrdersParams params)

Async variant of orders for export with params.

itemPrices

public ExportItemPricesResponse itemPrices(ExportItemPricesParams params)
                                    throws ChargebeeException

Throws:

ChargebeeException

itemPricesAsync

public CompletableFuture<ExportItemPricesResponse> itemPricesAsync(ExportItemPricesParams params)

Async variant of itemPrices for export with params.

subscriptions

public ExportSubscriptionsResponse subscriptions(ExportSubscriptionsParams params)
                                          throws ChargebeeException

Throws:

ChargebeeException

subscriptionsAsync

public CompletableFuture<ExportSubscriptionsResponse> subscriptionsAsync(ExportSubscriptionsParams params)

Async variant of subscriptions for export with params.

addons

public ExportAddonsResponse addons(ExportAddonsParams params)
                            throws ChargebeeException

Throws:

ChargebeeException

addonsAsync

public CompletableFuture<ExportAddonsResponse> addonsAsync(ExportAddonsParams params)

Async variant of addons for export with params.

plans

public ExportPlansResponse plans(ExportPlansParams params)
                          throws ChargebeeException

Throws:

ChargebeeException

plansAsync

public CompletableFuture<ExportPlansResponse> plansAsync(ExportPlansParams params)

Async variant of plans for export with params.

waitForExportCompletion

public Export waitForExportCompletion(Export export)
                               throws ChargebeeException,
InterruptedException

Waits for an export operation to complete by polling its status. Polls every 10 seconds (configurable via cb.java.export.sleep.millis system property).

Parameters:

export - The export to wait for (must have a valid ID)

Returns:

The completed Export object with COMPLETED or FAILED status

Throws:

ChargebeeException - if API call fails during polling

RuntimeException - if export takes too long (over 50 polling attempts)

InterruptedException - if thread is interrupted while waiting