stripe-core/com.stripe.android.core.networking

Package-level declarations

Types

AnalyticsEvent

interface AnalyticsEvent

AnalyticsFields

object AnalyticsFields

Only common analytics field keys should be declared within this object.

AnalyticsRequest

data class AnalyticsRequest(val params: Map<String, *>, val headers: Map<String, String>) : StripeRequest

Analytics request sent to q.stripe.com, which is a legacy analytics service used mostly by Payment SDK, analytics are saved in a shared DB table with payment-specific schema.

AnalyticsRequestExecutor

fun interface AnalyticsRequestExecutor

AnalyticsRequestFactory

open class AnalyticsRequestFactory(packageManager: PackageManager?, packageInfo: PackageInfo?, packageName: String, publishableKeyProvider: Provider<String>, networkTypeProvider: Provider<String?>, pluginTypeProvider: Provider<String?> = PLUGIN_TYPE_PROVIDER)

AnalyticsRequestV2

@Serializable

data class AnalyticsRequestV2 : StripeRequest

Analytics request sent to r.stripe.com, which is the preferred service for analytics. This is a POST request with MimeType.Form ContentType.

AnalyticsRequestV2Executor

fun interface AnalyticsRequestV2Executor

AnalyticsRequestV2Factory

class AnalyticsRequestV2Factory(context: Context, clientId: String, origin: String, pluginType: String = PluginDetector.pluginType ?: PLUGIN_NATIVE)

Factory to generate AnalyticsRequestV2, can be optionally configured to add the following standard SDK specific parameters. os_version - Android version sdk_platform - always "android" sdk_version - current SDK version device_type - MANUFACTURER, brand and model app_name - the host application name app_version - the host app version plugin_type - whether SDK is integrated natively or through other wrappers(e.g react native) platform_info - information about current platform

AnalyticsRequestV2Storage

interface AnalyticsRequestV2Storage

ApiRequest

data class ApiRequest : StripeRequest

A class representing a Stripe API or Analytics request.

ConnectionFactory

interface ConnectionFactory

Factory to create StripeConnection, which encapsulates an HttpsURLConnection, triggers the request and parses the response with different body type as StripeResponse.

DefaultAnalyticsRequestExecutor

class DefaultAnalyticsRequestExecutor(stripeNetworkClient: StripeNetworkClient, workContext: CoroutineContext, logger: Logger) : AnalyticsRequestExecutor

DefaultAnalyticsRequestV2Executor

class DefaultAnalyticsRequestV2Executor @Inject constructor(application: Application, networkClient: StripeNetworkClient, logger: Logger, storage: AnalyticsRequestV2Storage, isWorkManagerAvailable: IsWorkManagerAvailable) : AnalyticsRequestV2Executor

DefaultStripeNetworkClient

class DefaultStripeNetworkClient @JvmOverloads constructor(workContext: CoroutineContext = Dispatchers.IO, connectionFactory: ConnectionFactory = ConnectionFactory.Default, retryDelaySupplier: RetryDelaySupplier = ExponentialBackoffRetryDelaySupplier(), maxRetries: Int = DEFAULT_MAX_RETRIES, logger: Logger = Logger.noop()) : StripeNetworkClient

ExponentialBackoffRetryDelaySupplier

@Singleton

class ExponentialBackoffRetryDelaySupplier(incrementDuration: Duration) : RetryDelaySupplier

FileUploadRequest

open class FileUploadRequest(fileParams: StripeFileParams, options: ApiRequest.Options, appInfo: AppInfo? = null, boundary: String = createBoundary()) : StripeRequest

A StripeRequest for uploading a file using MimeType.MultipartForm.

LinearRetryDelaySupplier

@Singleton

class LinearRetryDelaySupplier(delay: Duration) : RetryDelaySupplier

NetworkTypeDetector

class NetworkTypeDetector

QueryStringFactory

object QueryStringFactory

Factory for HTTP request query strings, converts a Map of into a query string like "?p1=v1&p2=v2"

RealAnalyticsRequestV2Storage

class RealAnalyticsRequestV2Storage : AnalyticsRequestV2Storage

RequestHeadersFactory

sealed class RequestHeadersFactory

RequestId

data class RequestId(val value: String)

The identifier for a Stripe API request.

RetryDelaySupplier

interface RetryDelaySupplier

StripeClientUserAgentHeaderFactory

class StripeClientUserAgentHeaderFactory(systemPropertySupplier: (String) -> String = DEFAULT_SYSTEM_PROPERTY_SUPPLIER)

StripeConnection

interface StripeConnection<ResponseBodyType> : Closeable

A wrapper for accessing a HttpURLConnection. Implements Closeable to simplify closing related resources.

StripeNetworkClient

interface StripeNetworkClient

HTTP client to execute different types of StripeRequest and return StripeResponse.

StripeRequest

abstract class StripeRequest

A class representing a request to a Stripe-owned service.

StripeResponse

data class StripeResponse<ResponseBody>(val code: Int, val body: ResponseBody?, val headers: Map<String, List<String>> = emptyMap())

Represents a response from the Stripe servers. Upon receiving the HTTP response, its body is parsed into ResponseBody, such as a String or a File.

Properties

DEFAULT_RETRY_CODES

val DEFAULT_RETRY_CODES: Iterable<Int>

HEADER_ACCEPT

const val HEADER_ACCEPT: String

HEADER_ACCEPT_CHARSET

const val HEADER_ACCEPT_CHARSET: String

HEADER_ACCEPT_LANGUAGE

const val HEADER_ACCEPT_LANGUAGE: String

HEADER_AUTHORIZATION

const val HEADER_AUTHORIZATION: String

HEADER_CONTENT_TYPE

const val HEADER_CONTENT_TYPE: String

HEADER_IDEMPOTENCY_KEY

const val HEADER_IDEMPOTENCY_KEY: String

HEADER_STRIPE_ACCOUNT

const val HEADER_STRIPE_ACCOUNT: String

HEADER_STRIPE_LIVEMODE

const val HEADER_STRIPE_LIVEMODE: String

HEADER_STRIPE_VERSION

const val HEADER_STRIPE_VERSION: String

HEADER_USER_AGENT

const val HEADER_USER_AGENT: String

HEADER_X_STRIPE_USER_AGENT

const val HEADER_X_STRIPE_USER_AGENT: String

HTTP_TOO_MANY_REQUESTS

const val HTTP_TOO_MANY_REQUESTS: Int = 429

If the SDK receives a "Too Many Requests" (429) status code from Stripe, it will automatically retry the request using exponential backoff.

Functions

executeRequestWithModelJsonParser

suspend fun <Response : StripeModel> executeRequestWithModelJsonParser(stripeNetworkClient: StripeNetworkClient, stripeErrorJsonParser: StripeErrorJsonParser, request: StripeRequest, responseJsonParser: ModelJsonParser<Response>): Response

executeRequestWithResultParser

suspend fun <Response : StripeModel> executeRequestWithResultParser(stripeNetworkClient: StripeNetworkClient, stripeErrorJsonParser: StripeErrorJsonParser, request: StripeRequest, responseJsonParser: ModelJsonParser<Response>): Result<Response>

responseJson

fun StripeResponse<String>.responseJson(): JSONObject

toMap

fun JsonElement.toMap(): Map<String, *>

Convert a JsonElement to a Map so it's compatible with QueryStringFactory. Note that this only supports JsonObjects currently. Other types will result in an InvalidSerializationException.

fun JsonObject.toMap(): Map<String, *>

Convert a JsonObject to a Map so it's compatible with QueryStringFactory.

toPrimitives

fun JsonArray.toPrimitives(): List<*>

Convert all elements of an array to their equivalent kotlin primitives.

fun JsonElement.toPrimitives(): Any?

Recursively convert a JsonElement to its equivalent primitive kotlin values.