sdk/au.com.woolworths.village.sdk/VillageCustomerOptions

VillageCustomerOptions

Options unique to using the Customer API operations.

class VillageCustomerOptions(apiKey: String, baseUrl: String, wallet: Wallet?, walletId: String?) : VillageOptions

Constructors

fun VillageCustomerOptions(apiKey: String, baseUrl: String, wallet: Wallet?, walletId: String?)

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

apiKey

The API key to identify the SDK to the API.

override val apiKey: String

baseUrl

An initial base URL for the API host to use. Is comprised of the the scheme, host, and any context root for the API paths to use eg: https://myawesomeapp.com/api

override val baseUrl: String

wallet

Which wallet to interact with for everything related to payment instruments, preferences, etc. Applies across the SDK. If a different Wallet is needed, instantiate the SDK again.

If not specified, will default to Wallet.MERCHANT.

override val wallet: Wallet?

walletId

If given, the wallet ID will be added to the headers.

Since the wallet ID identifies the customer it can be overridden with another value by the API gateway which uses the authentication token to identify the customer.

val walletId: String?