Type reference

CslClientOptions

Constructor options for CslClient, including baseUrl, server getApiKey, browser getPublishableKey, delivery mode, timing, onError, and wrapper_version.

DecisionDeliveryMode

The four supported delivery modes: auto, websocket, polling, and callback.

auto prefers WebSocket when a global WebSocket exists, falls back to polling when it does not, and switches to callback when callback_url is supplied.

CslSdkError

Structured SDK error object emitted through options.onError when transport, parsing, timeout, or internal failures are observed.

CslSdkErrorCode

Machine-readable error-code enum for HTTP, network, timeout, WebSocket, parse, and internal failures.

ConsentFlags

Optional privacy and consent flags used by createJob().

In the current integration flow, these flags align with the Semantic Source and Semantic Persistence dimensions of the Compute Sponsoring standard. Setting semantic_targeting: true with both persistence flags false corresponds to the CS-S (S1/P0) profile described in the Compute Sponsoring glossary.

JobRequest

Create-job request shape. Start with job_type, then add optional consent, context, slot configuration, brand safety, routing, or callback settings as needed.

JobResponse

Union of accepted job metadata and the typed rate_limit_exceeded result returned by createJob().

DecisionResponse

Normalized decision union for pending, ready no-fill, and ready fill. Fill preserves creative, asset_token, constraints, and cs_declaration.

GenerationEvent

"started" | "finished" | "failed". This type sits behind reportGeneration().

GenerationRequest

Payload for generation lifecycle reporting. The documented fields are generation_id, model_id, usage_json, and error.

BeaconRequest

Payload for wrapper beacon events. The documented fields are beacon id, asset token, beacon type, client timestamp, and optional measurements.

BeaconResponse

Acknowledgement response for sendBeacon(). It returns { accepted, reason_code }.