sdk/au.com.woolworths.village.sdk

Package au.com.woolworths.village.sdk

Types

ApiException

Base exception type. Used when no other error type is appropriate.

open class ApiException(message: String, cause: Throwable?) : Exception

ApiKeyRequestHeader

Adds the API key to the request

class ApiKeyRequestHeader(options: VillageOptions) : RequestHeaderFactory

ApiResult

A result from an API operation

sealed class ApiResult<T : Any>

ApiTokenType

sealed class ApiTokenType

BearerTokenRequestHeader

Adds a 'Bearer' token to the request.

class BearerTokenRequestHeader<T : HasAccessToken>(token: String?) : RequestHeaderFactory, CredentialsStore<T>

CustomerApiRepositoryFactory

Factory function type to give to SDK factory functions to instantiate a new API repository instance.

typealias CustomerApiRepositoryFactory = (VillageCustomerOptions, RequestHeadersFactory, ApiAuthenticator<HasAccessToken>) -> VillageCustomerApiRepository

EverydayPayWalletHeader

class EverydayPayWalletHeader(options: VillageOptions) : RequestHeaderFactory

HttpErrorException

Thrown when the server returns an HTTP error

class HttpErrorException(statusCode: Int, responseHeaders: Map<String, List<String>>, responseBody: String) : ApiException

JsonParsingException

Throw when there is an error parsing JSON data

class JsonParsingException(message: String, cause: Throwable?, details: Map<String, Any>?) : ApiException

MerchantApiRepositoryFactory

Factory function type to give to SDK factory functions to instantiate a new API repository instance.

typealias MerchantApiRepositoryFactory = (VillageMerchantOptions, RequestHeadersFactory, ApiAuthenticator<HasAccessToken>) -> VillageMerchantApiRepository

MerchantIdRequestHeader

class MerchantIdRequestHeader(merchantId: String) : RequestHeaderFactory

RequestHeaderChain

A RequestHeadersFactory that populates the HTTP request headers Map using a list of RequestHeaderFactorys

class RequestHeaderChain(factories: List<RequestHeaderFactory>) : RequestHeadersFactory

RequestHeaderFactory

Abstracts how HTTP headers are added to a Map.

interface RequestHeaderFactory

RequestHeadersFactory

Creates a Map of headers to be added to HTTP requests

interface RequestHeadersFactory

VillageCustomerApiRepository

Defines the API operations that the SDK can use to call the Customer Village API

The SDK is technology agnostic with applications being able to choose an implementation that meets the needs and preexisting technology choices of the application.

Implementations of the protocol may provide additional constraints on the user.

interface VillageCustomerApiRepository

VillageCustomerOptions

Options unique to using the Customer API operations.

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

VillageMerchantApiRepository

Defines the API operations that the SDK can use to call the Merchant Village API

The SDK is technology agnostic with applications being able to choose an implementation that meets the needs and preexisting technology choices of the application.

Implementations of the protocol may provide additional constraints on the user.

interface VillageMerchantApiRepository

VillageMerchantOptions

Options unique to using the Merchant API operations.

class VillageMerchantOptions(apiKey: String, baseUrl: String, wallet: Wallet?, merchantId: String?) : VillageOptions

VillageOptions

Options to configure the SDK

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

Wallet

The different wallets the SDK can interact with via the API

enum Wallet : Enum<Wallet>

WalletIdRequestHeader

Adds the Wallet ID to the request

class WalletIdRequestHeader(walletId: String) : RequestHeaderFactory

Functions

createAuthentication

fun createAuthentication(token: ApiTokenType): Pair<ApiAuthenticator<HasAccessToken>, BearerTokenRequestHeader<HasAccessToken>?>

createCustomerSDK

Entry point into the SDK for customers.

fun createCustomerSDK(options: VillageCustomerOptions, token: ApiTokenType, repository: (VillageCustomerOptions, RequestHeadersFactory, ApiAuthenticator<HasAccessToken>) -> VillageCustomerApiRepository): VillageCustomerApiRepository

createMerchantSDK

Entry point into the SDK for merchants.

fun createMerchantSDK(options: VillageMerchantOptions, token: ApiTokenType, repository: (VillageMerchantOptions, RequestHeadersFactory, ApiAuthenticator<HasAccessToken>) -> VillageMerchantApiRepository): VillageMerchantApiRepository

createSDKComponents

Base factory function that can be used to create components needed for an SDK instance.

fun createSDKComponents(options: VillageOptions, token: ApiTokenType): Pair<MutableList<RequestHeaderFactory>, ApiAuthenticator<HasAccessToken>>

Properties

AUTHORISATION

const val AUTHORISATION: String

X_API_KEY

Header name to specify API key

const val X_API_KEY: String

X_EVERYDAY_PAY_WALLET

Header name to specify the use of the Everyday Pay Wallet

const val X_EVERYDAY_PAY_WALLET: String

X_MERCHANT_ID

Header name to specify merchant ID

const val X_MERCHANT_ID: String

X_WALLET_ID

Header name to specify wallet ID

const val X_WALLET_ID: String