Package com.chargebee.internal

Class ListRequest<U extends ListRequest>

java.lang.Object

com.chargebee.internal.RequestBase<U>

com.chargebee.internal.ListRequest<U>

Direct Known Subclasses:

Addon.AddonListRequest, Alert.AlertApplicationAlertsForSubscriptionRequest, Alert.AlertListRequest, AlertStatus.AlertStatusAlertStatusesForAlertRequest, AlertStatus.AlertStatusAlertStatusesForSubscriptionRequest, AttachedItem.AttachedItemListRequest, BusinessEntity.BusinessEntityGetTransfersRequest, Comment.CommentListRequest, Coupon.CouponListRequest, CouponCode.CouponCodeListRequest, CouponSet.CouponSetListRequest, CreditNote.CreditNoteListRequest, Customer.CustomerListHierarchyDetailRequest, Customer.CustomerListRequest, CustomerEntitlement.CustomerEntitlementEntitlementsForCustomerRequest, DifferentialPrice.DifferentialPriceListRequest, Entitlement.EntitlementListRequest, EntitlementOverride.EntitlementOverrideListEntitlementOverrideForSubscriptionRequest, Event.EventListRequest, Feature.FeatureListRequest, Gift.GiftListRequest, HostedPage.HostedPageListRequest, Invoice.InvoiceListPaymentReferenceNumbersRequest, Invoice.InvoiceListRequest, Item.ItemListRequest, ItemEntitlement.ItemEntitlementItemEntitlementsForFeatureRequest, ItemEntitlement.ItemEntitlementItemEntitlementsForItemRequest, ItemFamily.ItemFamilyListRequest, ItemPrice.ItemPriceFindApplicableItemPricesRequest, ItemPrice.ItemPriceFindApplicableItemsRequest, ItemPrice.ItemPriceListRequest, OmnichannelOneTimeOrder.OmnichannelOneTimeOrderListRequest, OmnichannelSubscription.OmnichannelSubscriptionListRequest, Order.OrderListRequest, PaymentSource.PaymentSourceListRequest, PaymentVoucher.PaymentVoucherPaymentVouchersForCustomerRequest, PaymentVoucher.PaymentVoucherPaymentVouchersForInvoiceRequest, Plan.PlanListRequest, PriceVariant.PriceVariantListRequest, PromotionalCredit.PromotionalCreditListRequest, Quote.QuoteListRequest, Ramp.RampListRequest, SiteMigrationDetail.SiteMigrationDetailListRequest, Subscription.SubscriptionContractTermsForSubscriptionRequest, Subscription.SubscriptionListRequest, SubscriptionEntitlement.SubscriptionEntitlementSubscriptionEntitlementsForSubscriptionRequest, Transaction.TransactionListRequest, UnbilledCharge.UnbilledChargeListRequest, Usage.UsageListRequest, UsageCharge.UsageChargeRetrieveUsageChargesForSubscriptionRequest, UsageSummary.UsageSummaryRetrieveUsageSummaryForSubscriptionRequest, VirtualBankAccount.VirtualBankAccountListRequest

public class ListRequest<U extends ListRequest>
extends RequestBase<U>

Field Summary

Fields inherited from class com.chargebee.internal.RequestBase

headers, isIdempotent, isJsonRequest, params, paramsV2, subDomain, uri

Constructor Summary

Constructors

Constructor	Description
ListRequest(String uri)
ListRequest(String uri, String subDomain)

Method Summary

Modifier and Type	Method	Description
BooleanFilter<U>	booleanFilterParam(String paramName)
DateFilter<Date,U>	dateFilterParam(String paramName)
U	limit(int limit)
NumberFilter<Long,U>	longFilterParam(String paramName)
U	offset(String offset)
Params	params()
final ListResult	request()
final ListResult	request(Environment env)
StringFilter<U>	stringFilterParam(String paramName)
TimestampFilter<U>	timestampFilterParam(String paramName)

Methods inherited from class com.chargebee.internal.RequestBase

header, headers, paramsV2, setIdempotencyKey, uri

Methods inherited from class java.lang.Object

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

Constructor Details

ListRequest

public ListRequest(String uri)

ListRequest

public ListRequest(String uri,
 String subDomain)

Method Details

limit

public U limit(int limit)

offset

public U offset(String offset)

stringFilterParam

public StringFilter<U> stringFilterParam(String paramName)

booleanFilterParam

public BooleanFilter<U> booleanFilterParam(String paramName)

longFilterParam

public NumberFilter<Long,U> longFilterParam(String paramName)

timestampFilterParam

public TimestampFilter<U> timestampFilterParam(String paramName)

dateFilterParam

public DateFilter<Date,U> dateFilterParam(String paramName)

request

public final ListResult request()
                         throws Exception

Throws:

Exception

request

public final ListResult request(Environment env)
                         throws IOException,
Exception

Throws:

IOException

Exception

params

public Params params()

Overrides:

params in class RequestBase<U extends ListRequest>