Package com.chargebee.internal

Class Request<U extends Request>

java.lang.Object

com.chargebee.internal.RequestBase<U>

com.chargebee.internal.Request<U>

Direct Known Subclasses:

Addon.CopyRequest, Addon.CreateRequest, Addon.UpdateRequest, Address.RetrieveRequest, Address.UpdateRequest, AttachedItem.CreateRequest, AttachedItem.DeleteRequest, AttachedItem.RetrieveRequest, AttachedItem.UpdateRequest, BatchRequest, BusinessEntity.CreateTransfersRequest, Card.CopyCardForCustomerRequest, Card.SwitchGatewayForCustomerRequest, Card.UpdateCardForCustomerRequest, Comment.CreateRequest, Coupon.CopyRequest, Coupon.CreateForItemsRequest, Coupon.CreateRequest, Coupon.UpdateForItemsRequest, Coupon.UpdateRequest, CouponCode.CreateRequest, CouponSet.AddCouponCodesRequest, CouponSet.CreateRequest, CouponSet.UpdateRequest, CreditNote.CreateRequest, CreditNote.DeleteRequest, CreditNote.ImportCreditNoteRequest, CreditNote.PdfRequest, CreditNote.RecordRefundRequest, CreditNote.RefundRequest, CreditNote.RemoveTaxWithheldRefundRequest, CreditNote.RetrieveRequest, CreditNote.VoidCreditNoteRequest, CsvTaxRule.CreateRequest, Currency.AddScheduleRequest, Currency.CreateRequest, Currency.UpdateRequest, Customer.AddContactRequest, Customer.AddPromotionalCreditsRequest, Customer.AssignPaymentRoleRequest, Customer.ChangeBillingDateRequest, Customer.CollectPaymentRequest, Customer.CreateRequest, Customer.DeductPromotionalCreditsRequest, Customer.DeleteContactRequest, Customer.DeleteRequest, Customer.HierarchyRequest, Customer.MergeRequest, Customer.MoveRequest, Customer.RecordExcessPaymentRequest, Customer.RelationshipsRequest, Customer.SetPromotionalCreditsRequest, Customer.UpdateBillingInfoRequest, Customer.UpdateContactRequest, Customer.UpdateHierarchySettingsRequest, Customer.UpdatePaymentMethodRequest, Customer.UpdateRequest, DifferentialPrice.CreateRequest, DifferentialPrice.DeleteRequest, DifferentialPrice.RetrieveRequest, DifferentialPrice.UpdateRequest, Entitlement.CreateRequest, EntitlementOverride.AddEntitlementOverrideForSubscriptionRequest, Estimate.AdvanceInvoiceEstimateRequest, Estimate.CancelSubscriptionForItemsRequest, Estimate.CancelSubscriptionRequest, Estimate.ChangeTermEndRequest, Estimate.CreateInvoiceForItemsRequest, Estimate.CreateInvoiceRequest, Estimate.CreateSubForCustomerEstimateRequest, Estimate.CreateSubItemEstimateRequest, Estimate.CreateSubItemForCustomerEstimateRequest, Estimate.CreateSubscriptionRequest, Estimate.GiftSubscriptionForItemsRequest, Estimate.GiftSubscriptionRequest, Estimate.PauseSubscriptionRequest, Estimate.PaymentSchedulesRequest, Estimate.RegenerateInvoiceEstimateRequest, Estimate.RenewalEstimateRequest, Estimate.ResumeSubscriptionRequest, Estimate.UpdateSubscriptionForItemsRequest, Estimate.UpdateSubscriptionRequest, Export.AddonsRequest, Export.AttachedItemsRequest, Export.CouponsRequest, Export.CreditNotesRequest, Export.CustomersRequest, Export.DeferredRevenueRequest, Export.DifferentialPricesRequest, Export.InvoicesRequest, Export.ItemFamiliesRequest, Export.ItemPricesRequest, Export.ItemsRequest, Export.OrdersRequest, Export.PlansRequest, Export.PriceVariantsRequest, Export.RevenueRecognitionRequest, Export.SubscriptionsRequest, Export.TransactionsRequest, Feature.CreateRequest, Feature.UpdateRequest, Gift.CreateForItemsRequest, Gift.CreateRequest, Gift.UpdateGiftRequest, HostedPage.AcceptQuoteRequest, HostedPage.CheckoutExistingForItemsRequest, HostedPage.CheckoutExistingRequest, HostedPage.CheckoutGiftForItemsRequest, HostedPage.CheckoutGiftRequest, HostedPage.CheckoutNewForItemsRequest, HostedPage.CheckoutNewRequest, HostedPage.CheckoutOneTimeForItemsRequest, HostedPage.CheckoutOneTimeRequest, HostedPage.ClaimGiftRequest, HostedPage.CollectNowRequest, HostedPage.EventsRequest, HostedPage.ExtendSubscriptionRequest, HostedPage.ManagePaymentSourcesRequest, HostedPage.PreCancelRequest, HostedPage.RetrieveAgreementPdfRequest, HostedPage.UpdateCardRequest, HostedPage.UpdatePaymentMethodRequest, HostedPage.ViewVoucherRequest, InAppSubscription.ImportReceiptRequest, InAppSubscription.ImportSubscriptionRequest, InAppSubscription.ProcessReceiptRequest, InAppSubscription.RetrieveStoreSubsRequest, Invoice.AddAddonChargeRequest, Invoice.AddChargeItemRequest, Invoice.AddChargeRequest, Invoice.ApplyCreditsRequest, Invoice.ApplyPaymentScheduleSchemeRequest, Invoice.ApplyPaymentsRequest, Invoice.ChargeAddonRequest, Invoice.ChargeRequest, Invoice.CloseRequest, Invoice.CollectPaymentRequest, Invoice.CreateForChargeItemRequest, Invoice.CreateForChargeItemsAndChargesRequest, Invoice.CreateRequest, Invoice.DeleteLineItemsRequest, Invoice.DeleteRequest, Invoice.ImportInvoiceRequest, Invoice.PauseDunningRequest, Invoice.PdfRequest, Invoice.RecordPaymentRequest, Invoice.RecordRefundRequest, Invoice.RecordTaxWithheldRequest, Invoice.RefundRequest, Invoice.RemoveCreditNoteRequest, Invoice.RemovePaymentRequest, Invoice.RemoveTaxWithheldRequest, Invoice.ResumeDunningRequest, Invoice.RetrieveRequest, Invoice.StopDunningRequest, Invoice.UpdateDetailsRequest, Invoice.VoidInvoiceRequest, Invoice.WriteOffRequest, Item.CreateRequest, Item.UpdateRequest, ItemEntitlement.AddItemEntitlementsRequest, ItemEntitlement.UpsertOrRemoveItemEntitlementsForItemRequest, ItemFamily.CreateRequest, ItemFamily.UpdateRequest, ItemPrice.CreateRequest, ItemPrice.MoveItemPriceRequest, ItemPrice.UpdateRequest, OfferEvent.OfferEventsRequest, OfferFulfillment.OfferFulfillmentsRequest, OfferFulfillment.OfferFulfillmentsUpdateRequest, OmnichannelSubscription.MoveRequest, Order.CancelRequest, Order.CreateRefundableCreditNoteRequest, Order.CreateRequest, Order.ImportOrderRequest, Order.ReopenRequest, Order.ResendRequest, Order.UpdateRequest, PaymentIntent.CreateRequest, PaymentIntent.UpdateRequest, PaymentScheduleScheme.CreateRequest, PaymentSource.CreateBankAccountRequest, PaymentSource.CreateCardRequest, PaymentSource.CreateUsingPaymentIntentRequest, PaymentSource.CreateUsingPermanentTokenRequest, PaymentSource.CreateUsingTempTokenRequest, PaymentSource.CreateUsingTokenRequest, PaymentSource.CreateVoucherPaymentSourceRequest, PaymentSource.ExportPaymentSourceRequest, PaymentSource.SwitchGatewayAccountRequest, PaymentSource.UpdateBankAccountRequest, PaymentSource.UpdateCardRequest, PaymentSource.VerifyBankAccountRequest, PaymentVoucher.CreateRequest, PersonalizedOffer.PersonalizedOffersRequest, Plan.CopyRequest, Plan.CreateRequest, Plan.UpdateRequest, PortalSession.ActivateRequest, PortalSession.CreateRequest, PriceVariant.CreateRequest, PriceVariant.UpdateRequest, PricingPageSession.CreateForExistingSubscriptionRequest, PricingPageSession.CreateForNewSubscriptionRequest, PromotionalCredit.AddRequest, PromotionalCredit.DeductRequest, PromotionalCredit.SetRequest, Purchase.CreateRequest, Purchase.EstimateRequest, Quote.ConvertRequest, Quote.CreateForChargeItemsAndChargesRequest, Quote.CreateForOnetimeChargesRequest, Quote.CreateSubForCustomerQuoteRequest, Quote.CreateSubItemsForCustomerQuoteRequest, Quote.DeleteRequest, Quote.EditCreateSubCustomerQuoteForItemsRequest, Quote.EditCreateSubForCustomerQuoteRequest, Quote.EditForChargeItemsAndChargesRequest, Quote.EditOneTimeQuoteRequest, Quote.EditUpdateSubscriptionQuoteForItemsRequest, Quote.EditUpdateSubscriptionQuoteRequest, Quote.ExtendExpiryDateRequest, Quote.PdfRequest, Quote.UpdateStatusRequest, Quote.UpdateSubscriptionQuoteForItemsRequest, Quote.UpdateSubscriptionQuoteRequest, Ramp.CreateForSubscriptionRequest, Ramp.UpdateRequest, RecordedPurchase.CreateRequest, ResourceMigration.RetrieveLatestRequest, Subscription.AddChargeAtTermEndRequest, Subscription.CancelForItemsRequest, Subscription.CancelRequest, Subscription.ChangeTermEndRequest, Subscription.ChargeAddonAtTermEndRequest, Subscription.ChargeFutureRenewalsRequest, Subscription.CreateForCustomerRequest, Subscription.CreateRequest, Subscription.CreateWithItemsRequest, Subscription.EditAdvanceInvoiceScheduleRequest, Subscription.ImportContractTermRequest, Subscription.ImportForCustomerRequest, Subscription.ImportForItemsRequest, Subscription.ImportSubscriptionRequest, Subscription.ImportUnbilledChargesRequest, Subscription.MoveRequest, Subscription.OverrideBillingProfileRequest, Subscription.PauseRequest, Subscription.ReactivateRequest, Subscription.RegenerateInvoiceRequest, Subscription.RemoveAdvanceInvoiceScheduleRequest, Subscription.RemoveCouponsRequest, Subscription.RemoveScheduledCancellationRequest, Subscription.ResumeRequest, Subscription.UpdateForItemsRequest, Subscription.UpdateRequest, SubscriptionEntitlement.SetSubscriptionEntitlementAvailabilityRequest, TimeMachine.StartAfreshRequest, TimeMachine.TravelForwardRequest, Transaction.CreateAuthorizationRequest, Transaction.DeleteOfflineTransactionRequest, Transaction.ReconcileRequest, Transaction.RecordRefundRequest, Transaction.RefundRequest, UnbilledCharge.CreateRequest, UnbilledCharge.CreateUnbilledChargeRequest, UnbilledCharge.InvoiceNowEstimateRequest, UnbilledCharge.InvoiceUnbilledChargesRequest, Usage.CreateRequest, Usage.DeleteRequest, Usage.PdfRequest, Usage.RetrieveRequest, UsageEvent.BatchIngestRequest, UsageEvent.CreateRequest, UsageFile.UploadUrlRequest, VirtualBankAccount.CreateRequest, VirtualBankAccount.CreateUsingPermanentTokenRequest, WebhookEndpoint.CreateRequest, WebhookEndpoint.UpdateRequest

public class Request<U extends Request>
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
Request(HttpUtil.Method httpMeth, String uri)
Request(HttpUtil.Method httpMeth, String uri, String pathParam)
Request(HttpUtil.Method httpMeth, String uri, String pathParam, String subDomain)
Request(HttpUtil.Method httpMethod, String uri, String pathParam, String subDomain, boolean isContentTypeJson)

Method Summary

Modifier and Type	Method	Description
HttpUtil.Method	httpMeth()
U	param(String paramName, Object value)
Params	params()
String	pathParam()
Result	request()
Result	request(Environment env)
U	setIdempotency(boolean isIdempotent)

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

Request

public Request(HttpUtil.Method httpMeth,
 String uri)

Request

public Request(HttpUtil.Method httpMeth,
 String uri,
 String pathParam)

Request

public Request(HttpUtil.Method httpMeth,
 String uri,
 String pathParam,
 String subDomain)

Request

public Request(HttpUtil.Method httpMethod,
 String uri,
 String pathParam,
 String subDomain,
 boolean isContentTypeJson)

Method Details

setIdempotency

public U setIdempotency(boolean isIdempotent)

param

public U param(String paramName,
 Object value)

request

public Result request()
               throws Exception

Throws:

Exception

request

public Result request(Environment env)
               throws Exception

Throws:

Exception

params

public Params params()

Overrides:

params in class RequestBase<U extends Request>

httpMeth

public HttpUtil.Method httpMeth()

pathParam

public String pathParam()