Package com.chargebee.v4.services

Class OrderService

java.lang.Object

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

com.chargebee.v4.services.OrderService

public final class OrderService
extends BaseService<OrderService>

Field Summary

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

client, options

Constructor Summary

Constructors

Constructor	Description
OrderService(ChargebeeClient client)

Method Summary

Modifier and Type	Method	Description
AssignOrderNumberResponse	assignOrderNumber(String orderId)
CompletableFuture<AssignOrderNumberResponse>	assignOrderNumberAsync(String orderId)	Async variant of assignOrderNumber for order without params.
OrderCancelResponse	cancel(String orderId, OrderCancelParams params)
CompletableFuture<OrderCancelResponse>	cancelAsync(String orderId, OrderCancelParams params)	Async variant of cancel for order with params.
OrderCreateResponse	create(OrderCreateParams params)
CompletableFuture<OrderCreateResponse>	createAsync(OrderCreateParams params)	Async variant of create for order with params.
OrderCreateRefundableCreditNoteResponse	createRefundableCreditNote(String orderId)
OrderCreateRefundableCreditNoteResponse	createRefundableCreditNote(String orderId, OrderCreateRefundableCreditNoteParams params)
CompletableFuture<OrderCreateRefundableCreditNoteResponse>	createRefundableCreditNoteAsync(String orderId)	Async variant of createRefundableCreditNote for order without params.
CompletableFuture<OrderCreateRefundableCreditNoteResponse>	createRefundableCreditNoteAsync(String orderId, OrderCreateRefundableCreditNoteParams params)	Async variant of createRefundableCreditNote for order with params.
OrderDeleteResponse	delete(String orderId)
CompletableFuture<OrderDeleteResponse>	deleteAsync(String orderId)	Async variant of delete for order without params.
ImportOrderResponse	importOrder(ImportOrderParams params)
CompletableFuture<ImportOrderResponse>	importOrderAsync(ImportOrderParams params)	Async variant of importOrder for order with params.
OrderListResponse	list()
OrderListResponse	list(OrderListParams params)
CompletableFuture<OrderListResponse>	listAsync()	Async variant of list for order without params.
CompletableFuture<OrderListResponse>	listAsync(OrderListParams params)	Async variant of list for order with params.
OrdersForInvoiceResponse	ordersForInvoice(String invoiceId)
OrdersForInvoiceResponse	ordersForInvoice(String invoiceId, OrdersForInvoiceParams params)
CompletableFuture<OrdersForInvoiceResponse>	ordersForInvoiceAsync(String invoiceId)	Async variant of ordersForInvoice for order without params.
CompletableFuture<OrdersForInvoiceResponse>	ordersForInvoiceAsync(String invoiceId, OrdersForInvoiceParams params)	Async variant of ordersForInvoice for order with params.
OrderReopenResponse	reopen(String orderId)
OrderReopenResponse	reopen(String orderId, OrderReopenParams params)
CompletableFuture<OrderReopenResponse>	reopenAsync(String orderId)	Async variant of reopen for order without params.
CompletableFuture<OrderReopenResponse>	reopenAsync(String orderId, OrderReopenParams params)	Async variant of reopen for order with params.
OrderResendResponse	resend(String orderId)
OrderResendResponse	resend(String orderId, OrderResendParams params)
CompletableFuture<OrderResendResponse>	resendAsync(String orderId)	Async variant of resend for order without params.
CompletableFuture<OrderResendResponse>	resendAsync(String orderId, OrderResendParams params)	Async variant of resend for order with params.
OrderRetrieveResponse	retrieve(String orderId)
CompletableFuture<OrderRetrieveResponse>	retrieveAsync(String orderId)	Async variant of retrieve for order without params.
OrderUpdateResponse	update(String orderId)
OrderUpdateResponse	update(String orderId, OrderUpdateParams params)
CompletableFuture<OrderUpdateResponse>	updateAsync(String orderId)	Async variant of update for order without params.
CompletableFuture<OrderUpdateResponse>	updateAsync(String orderId, OrderUpdateParams params)	Async variant of update for order with params.
OrderService	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

OrderService

public OrderService(ChargebeeClient client)

Method Details

withOptions

public OrderService 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<OrderService>

list

public OrderListResponse list(OrderListParams params)
                       throws ChargebeeException

Throws:

ChargebeeException

listAsync

public CompletableFuture<OrderListResponse> listAsync(OrderListParams params)

Async variant of list for order with params.

list

public OrderListResponse list()
                       throws ChargebeeException

Throws:

ChargebeeException

listAsync

public CompletableFuture<OrderListResponse> listAsync()

Async variant of list for order without params.

create

public OrderCreateResponse create(OrderCreateParams params)
                           throws ChargebeeException

Throws:

ChargebeeException

createAsync

public CompletableFuture<OrderCreateResponse> createAsync(OrderCreateParams params)

Async variant of create for order with params.

importOrder

public ImportOrderResponse importOrder(ImportOrderParams params)
                                throws ChargebeeException

Throws:

ChargebeeException

importOrderAsync

public CompletableFuture<ImportOrderResponse> importOrderAsync(ImportOrderParams params)

Async variant of importOrder for order with params.

assignOrderNumber

public AssignOrderNumberResponse assignOrderNumber(String orderId)
                                            throws ChargebeeException

Throws:

ChargebeeException

assignOrderNumberAsync

public CompletableFuture<AssignOrderNumberResponse> assignOrderNumberAsync(String orderId)

Async variant of assignOrderNumber for order without params.

resend

public OrderResendResponse resend(String orderId,
 OrderResendParams params)
                           throws ChargebeeException

Throws:

ChargebeeException

resendAsync

public CompletableFuture<OrderResendResponse> resendAsync(String orderId,
 OrderResendParams params)

Async variant of resend for order with params.

resend

public OrderResendResponse resend(String orderId)
                           throws ChargebeeException

Throws:

ChargebeeException

resendAsync

public CompletableFuture<OrderResendResponse> resendAsync(String orderId)

Async variant of resend for order without params.

reopen

public OrderReopenResponse reopen(String orderId,
 OrderReopenParams params)
                           throws ChargebeeException

Throws:

ChargebeeException

reopenAsync

public CompletableFuture<OrderReopenResponse> reopenAsync(String orderId,
 OrderReopenParams params)

Async variant of reopen for order with params.

reopen

public OrderReopenResponse reopen(String orderId)
                           throws ChargebeeException

Throws:

ChargebeeException

reopenAsync

public CompletableFuture<OrderReopenResponse> reopenAsync(String orderId)

Async variant of reopen for order without params.

ordersForInvoice

public OrdersForInvoiceResponse ordersForInvoice(String invoiceId,
 OrdersForInvoiceParams params)
                                          throws ChargebeeException

Throws:

ChargebeeException

ordersForInvoice

public OrdersForInvoiceResponse ordersForInvoice(String invoiceId)
                                          throws ChargebeeException

Throws:

ChargebeeException

ordersForInvoiceAsync

public CompletableFuture<OrdersForInvoiceResponse> ordersForInvoiceAsync(String invoiceId,
 OrdersForInvoiceParams params)

Async variant of ordersForInvoice for order with params.

ordersForInvoiceAsync

public CompletableFuture<OrdersForInvoiceResponse> ordersForInvoiceAsync(String invoiceId)

Async variant of ordersForInvoice for order without params.

cancel

public OrderCancelResponse cancel(String orderId,
 OrderCancelParams params)
                           throws ChargebeeException

Throws:

ChargebeeException

cancelAsync

public CompletableFuture<OrderCancelResponse> cancelAsync(String orderId,
 OrderCancelParams params)

Async variant of cancel for order with params.

retrieve

public OrderRetrieveResponse retrieve(String orderId)
                               throws ChargebeeException

Throws:

ChargebeeException

retrieveAsync

public CompletableFuture<OrderRetrieveResponse> retrieveAsync(String orderId)

Async variant of retrieve for order without params.

update

public OrderUpdateResponse update(String orderId,
 OrderUpdateParams params)
                           throws ChargebeeException

Throws:

ChargebeeException

updateAsync

public CompletableFuture<OrderUpdateResponse> updateAsync(String orderId,
 OrderUpdateParams params)

Async variant of update for order with params.

update

public OrderUpdateResponse update(String orderId)
                           throws ChargebeeException

Throws:

ChargebeeException

updateAsync

public CompletableFuture<OrderUpdateResponse> updateAsync(String orderId)

Async variant of update for order without params.

delete

public OrderDeleteResponse delete(String orderId)
                           throws ChargebeeException

Throws:

ChargebeeException

deleteAsync

public CompletableFuture<OrderDeleteResponse> deleteAsync(String orderId)

Async variant of delete for order without params.

createRefundableCreditNote

public OrderCreateRefundableCreditNoteResponse createRefundableCreditNote(String orderId,
 OrderCreateRefundableCreditNoteParams params)
                                                                   throws ChargebeeException

Throws:

ChargebeeException

createRefundableCreditNoteAsync

public CompletableFuture<OrderCreateRefundableCreditNoteResponse> createRefundableCreditNoteAsync(String orderId,
 OrderCreateRefundableCreditNoteParams params)

Async variant of createRefundableCreditNote for order with params.

createRefundableCreditNote

public OrderCreateRefundableCreditNoteResponse createRefundableCreditNote(String orderId)
                                                                   throws ChargebeeException

Throws:

ChargebeeException

createRefundableCreditNoteAsync

public CompletableFuture<OrderCreateRefundableCreditNoteResponse> createRefundableCreditNoteAsync(String orderId)

Async variant of createRefundableCreditNote for order without params.