Package com.stripe.net

Class ApiResource

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

All Implemented Interfaces:

StripeActiveObject, StripeObjectInterface

Direct Known Subclasses:

Account, Account, AccountInferredBalance, AccountLink, AccountNotice, AccountSession, ApplePayDomain, ApplicationFee, Authorization, Balance, BalanceTransaction, BankAccount, Calculation, Capability, Card, Card, Card, Cardholder, CashBalance, Charge, Configuration, Configuration, ConfirmationToken, ConnectionToken, CountrySpec, Coupon, CreditNote, CreditReversal, CreditUnderwritingRecord, Customer, CustomerBalanceTransaction, CustomerSession, DebitReversal, Dispute, Dispute, EarlyFraudWarning, EphemeralKey, Event, ExchangeRate, FeeRefund, File, FileLink, FinancialAccount, FinancingOffer, FinancingSummary, FinancingTransaction, Form, InboundTransfer, Invoice, InvoiceItem, Location, LoginLink, Mandate, Margin, Order, Order, OutboundPayment, OutboundTransfer, PagingIterator, PaymentIntent, PaymentLink, PaymentMethod, PaymentMethodConfiguration, PaymentMethodDomain, Payout, Person, PersonalizationDesign, PhysicalBundle, Plan, Price, Product, Product, PromotionCode, Quote, QuotePhase, QuotePreviewInvoice, QuotePreviewSubscriptionSchedule, Reader, ReceivedCredit, ReceivedDebit, Refund, Registration, ReportRun, ReportType, Review, ScheduledQueryRun, SearchPagingIterator, Secret, Session, Session, Session, Settings, SetupAttempt, SetupIntent, ShippingRate, Source, Subscription, SubscriptionItem, SubscriptionSchedule, Supplier, TaxCode, TaxId, TaxRate, TestClock, Token, Token, Topup, Transaction, Transaction, Transaction, Transaction, Transaction, TransactionEntry, Transfer, TransferReversal, UsageRecord, ValueList, ValueListItem, VerificationReport, VerificationSession, WebhookEndpoint

public abstract class ApiResource
extends StripeObject
implements StripeActiveObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiResource.RequestMethod

Field Summary

Fields

Modifier and Type	Field	Description
static final Charset	CHARSET
static final com.google.gson.Gson	GSON
static final com.google.gson.Gson	INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
ApiResource()

Method Summary

Modifier and Type	Method	Description
static void	checkNullTypedParams(String url, ApiRequestParams params)	Invalidate null typed parameters.
static StripeResponseGetter	getGlobalResponseGetter()
protected StripeResponseGetter	getResponseGetter()
static StripeResponse	rawRequest(ApiResource.RequestMethod method, String url, String content, RawRequestOptions options)
static <T extends HasId> ExpandableField<T>	setExpandableFieldId(String newId, ExpandableField<T> currentObject)	When setting a String ID for an ExpandableField, we need to be careful about keeping the String ID and the expanded object in sync.
void	setResponseGetter(StripeResponseGetter srg)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
static void	setStripeResponseGetter(StripeResponseGetter srg)
static String	urlEncode(String str)	URL-encodes a string.
static String	urlEncodeId(String id)	URL-encode a string ID in url path formatting.

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Field Details

CHARSET

public static final Charset CHARSET

INTERNAL_GSON

public static final com.google.gson.Gson INTERNAL_GSON

GSON

public static final com.google.gson.Gson GSON

Constructor Details

ApiResource

public ApiResource()

Method Details

setStripeResponseGetter

public static void setStripeResponseGetter(StripeResponseGetter srg)

getGlobalResponseGetter

public static StripeResponseGetter getGlobalResponseGetter()

setResponseGetter

public void setResponseGetter(StripeResponseGetter srg)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Parameters:

srg - the StripeResponseGetter instance to use for making further requests.

getResponseGetter

protected StripeResponseGetter getResponseGetter()

urlEncode

public static String urlEncode(String str)

URL-encodes a string.

urlEncodeId

public static String urlEncodeId(String id)
                          throws InvalidRequestException

URL-encode a string ID in url path formatting.

Throws:

InvalidRequestException

rawRequest

public static StripeResponse rawRequest(ApiResource.RequestMethod method,
 String url,
 String content,
 RawRequestOptions options)
                                 throws StripeException

Throws:

StripeException

checkNullTypedParams

public static void checkNullTypedParams(String url,
 ApiRequestParams params)

Invalidate null typed parameters.

Parameters:

url - request url associated with the given parameters.

params - typed parameters to check for null value.

setExpandableFieldId

public static <T extends HasId> ExpandableField<T> setExpandableFieldId(String newId,
 ExpandableField<T> currentObject)

When setting a String ID for an ExpandableField, we need to be careful about keeping the String ID and the expanded object in sync. If they specify a new String ID that is different from the ID within the expanded object, we don't keep the object.