Skip to main content

Interface: TanqoryConfig

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:5

Core Types for Tanqory SDK

Properties​

accessToken?​

optional accessToken?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:15

Access token for user authentication

allowUnauthenticated?​

optional allowUnauthenticated?: boolean

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:68

Allow unauthenticated requests

Default​

false

apiKey?​

optional apiKey?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:10

API Key for authentication (public or secret)

Example​

'pk_live_abc123' or 'sk_live_xyz789'

apiVersion?​

optional apiVersion?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:38

API version prefix for URL paths

Default​

'v1'

assetsURL?​

optional assetsURL?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:32

Assets CDN URL for theme static files

Default​

'https://assets.tanqory.com' (production) or 'http://localhost:4001' (development)

baseURL?​

optional baseURL?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:26

Base URL for API

Default​

'https://api.tanqory.com'

cache?​

optional cache?: CacheConfig

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:84

Cache configuration

debug?​

optional debug?: boolean

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:62

Enable debug logging

Default​

false

defaultHeaders?​

optional defaultHeaders?: Record<string, string>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:94

Custom headers to include in all requests

environment?​

optional environment?: "local" | "production" | "staging" | "development"

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:44

Environment

Default​

'production'

maxRetries?​

optional maxRetries?: number

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:56

Maximum number of retry attempts

Default​

3

networkAdapter?​

optional networkAdapter?: NetworkAdapter | "fetch" | "axios" | "react-native"

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:79

Network adapter

Default​

'fetch'

refreshToken?​

optional refreshToken?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:20

Refresh token for token renewal

retry?​

optional retry?: RetryConfig

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:112

Retry configuration

skipTokenExpiryCheck?​

optional skipTokenExpiryCheck?: boolean

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:102

Skip token expiry check (for server-side usage where tokens are passed through) When true, the SDK will not validate token expiry before making requests This is useful for service-to-service communication where the token is already validated

Default​

false

storage?​

optional storage?: StorageAdapter

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:73

Storage adapter for tokens (for React Native)

telemetry?​

optional telemetry?: TelemetryConfig

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:107

Telemetry configuration

timeout?​

optional timeout?: number

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:50

Request timeout in milliseconds

Default​

30000

webhookSecret?​

optional webhookSecret?: string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/types.ts:89

Webhook secret for signature verification