Package com.stripe.net

Class ApiResource

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

All Implemented Interfaces:

StripeObjectInterface

Direct Known Subclasses:

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

public abstract class ApiResource
extends StripeObject

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

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.
protected static String	classUrl(Class<?> clazz)	Deprecated.
protected static String	classUrl(Class<?> clazz, String apiBase)	Deprecated.
static String	fullUrl(String defaultBaseUrl, RequestOptions options, String relativeUrl)
protected static String	instanceUrl(Class<?> clazz, String id)	Deprecated.
protected static String	instanceUrl(Class<?> clazz, String id, String apiBase)	Deprecated.
static <T extends StripeObjectInterface> T	request(ApiResource.RequestMethod method, String url, ApiRequestParams params, Class<T> clazz, RequestOptions options)
static <T extends StripeObjectInterface> T	request(ApiResource.RequestMethod method, String url, Map<String,Object> params, Class<T> clazz, RequestOptions options)
static <T extends StripeCollectionInterface<?>> T	requestCollection(String url, ApiRequestParams params, Class<T> clazz, RequestOptions options)
static <T extends StripeCollectionInterface<?>> T	requestCollection(String url, Map<String,Object> params, Class<T> clazz, RequestOptions options)	Similar to #request, but specific for use with collection types that come from the API (i.e.
static <T extends StripeSearchResultInterface<?>> T	requestSearchResult(String url, ApiRequestParams params, Class<T> clazz, RequestOptions options)
static <T extends StripeSearchResultInterface<?>> T	requestSearchResult(String url, Map<String,Object> params, Class<T> clazz, RequestOptions options)	Similar to #request, but specific for use with searchResult types that come from the API
static InputStream	requestStream(ApiResource.RequestMethod method, String url, ApiRequestParams params, RequestOptions options)
static InputStream	requestStream(ApiResource.RequestMethod method, String url, Map<String,Object> params, RequestOptions 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.
static void	setStripeResponseGetter(StripeResponseGetter srg)
protected static String	singleClassUrl(Class<?> clazz)	Deprecated.
protected static String	singleClassUrl(Class<?> clazz, String apiBase)	Deprecated.
protected static String	subresourceUrl(Class<?> clazz, String id, Class<?> subClazz)	Deprecated.
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

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Field Details

CHARSET

public static final Charset CHARSET

GSON

public static final com.google.gson.Gson GSON

Constructor Details

ApiResource

public ApiResource()

Method Details

setStripeResponseGetter

public static void setStripeResponseGetter(StripeResponseGetter srg)

fullUrl

public static String fullUrl(String defaultBaseUrl,
 RequestOptions options,
 String relativeUrl)

singleClassUrl

@Deprecated
protected static String singleClassUrl(Class<?> clazz)

Deprecated.

singleClassUrl

@Deprecated
protected static String singleClassUrl(Class<?> clazz,
 String apiBase)

Deprecated.

classUrl

@Deprecated
protected static String classUrl(Class<?> clazz)

Deprecated.

classUrl

@Deprecated
protected static String classUrl(Class<?> clazz,
 String apiBase)

Deprecated.

instanceUrl

@Deprecated
protected static String instanceUrl(Class<?> clazz,
 String id)
                             throws InvalidRequestException

Deprecated.

Throws:

InvalidRequestException

instanceUrl

@Deprecated
protected static String instanceUrl(Class<?> clazz,
 String id,
 String apiBase)
                             throws InvalidRequestException

Deprecated.

Throws:

InvalidRequestException

subresourceUrl

@Deprecated
protected static String subresourceUrl(Class<?> clazz,
 String id,
 Class<?> subClazz)
                                throws InvalidRequestException

Deprecated.

Throws:

InvalidRequestException

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

request

public static <T extends StripeObjectInterface> T request(ApiResource.RequestMethod method,
 String url,
 ApiRequestParams params,
 Class<T> clazz,
 RequestOptions options)
                                                   throws StripeException

Throws:

StripeException

request

public static <T extends StripeObjectInterface> T request(ApiResource.RequestMethod method,
 String url,
 Map<String,Object> params,
 Class<T> clazz,
 RequestOptions options)
                                                   throws StripeException

Throws:

StripeException

requestStream

public static InputStream requestStream(ApiResource.RequestMethod method,
 String url,
 ApiRequestParams params,
 RequestOptions options)
                                 throws StripeException

Throws:

StripeException

requestStream

public static InputStream requestStream(ApiResource.RequestMethod method,
 String url,
 Map<String,Object> params,
 RequestOptions options)
                                 throws StripeException

Throws:

StripeException

requestCollection

public static <T extends StripeCollectionInterface<?>>
T requestCollection(String url,
 ApiRequestParams params,
 Class<T> clazz,
 RequestOptions options)
             throws StripeException

Throws:

StripeException

requestCollection

public static <T extends StripeCollectionInterface<?>>
T requestCollection(String url,
 Map<String,Object> params,
 Class<T> clazz,
 RequestOptions options)
             throws StripeException

Similar to #request, but specific for use with collection types that come from the API (i.e. lists of resources).

Collections need a little extra work because we need to plumb request options and params through so that we can iterate to the next page if necessary.

Throws:

StripeException

requestSearchResult

public static <T extends StripeSearchResultInterface<?>>
T requestSearchResult(String url,
 ApiRequestParams params,
 Class<T> clazz,
 RequestOptions options)
               throws StripeException

Throws:

StripeException

requestSearchResult

public static <T extends StripeSearchResultInterface<?>>
T requestSearchResult(String url,
 Map<String,Object> params,
 Class<T> clazz,
 RequestOptions options)
               throws StripeException

Similar to #request, but specific for use with searchResult types that come from the API

SearchResults, like collections need a little extra work because we need to plumb request options and params through so that we can iterate to the next page if necessary.

Please note, requestSearchResult is beta functionality and is subject to charge or removal at any time.

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.