ClientConfiguration

data class ClientConfiguration(val key: String?, val secret: String?, val environment: ClientEnvironment?, val requestTimeout: Long? = null, val connectionTimeout: Long? = null, val socketTimeout: Long? = null, val maskedLoggingHeaders: Set<String>? = null, val maskedLoggingBodyFields: Set<String>? = null)

A configuration class that holds the necessary credentials and settings for API clients.

This class is used to configure SDK clients by providing essential details such as API keys, environment, timeouts, and logging settings.

It also provides a fluent Builder pattern for easy creation of configuration instances.

Constructors

Link copied to clipboard
constructor(key: String?, secret: String?, environment: ClientEnvironment?, requestTimeout: Long? = null, connectionTimeout: Long? = null, socketTimeout: Long? = null, maskedLoggingHeaders: Set<String>? = null, maskedLoggingBodyFields: Set<String>? = null)

Types

Link copied to clipboard
class Builder

A builder for creating ClientConfiguration instances.

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val connectionTimeout: Long? = null

The connection timeout duration in milliseconds (optional).

Link copied to clipboard

The environment in which the API client will operate (e.g., production or test).

Link copied to clipboard
val key: String?

The API key used for authentication.

Link copied to clipboard

A set of fields in the request body whose values should be masked in logs (optional).

Link copied to clipboard

A set of HTTP headers whose values should be masked in logs (optional).

Link copied to clipboard
val requestTimeout: Long? = null

The request timeout duration in milliseconds (optional).

Link copied to clipboard

The API secret used for authentication.

Link copied to clipboard
val socketTimeout: Long? = null

The socket timeout duration in milliseconds (optional).