@vincentt-sdks/campaign-sdk
v0.14.0
Published
Campaign SDK by Vincentt
Readme
rtx-campaign-sdk
Existing user login
For campaigns with unique-field login enabled, returning users can authenticate
with the configured unique value. The SDK stores the returned tokens and reuses
the existing /users/me and refresh-token behavior.
const user = await sdk.loginUser({ uniqueFieldValue: '09xxxxxxxxx' });Print jobs
import { CampaignSDK } from '@vincentt-sdks/campaign-sdk';
const sdk = CampaignSDK.initialize({
apiKey: '<campaign-client-api-key>',
campaignId: '<campaign-id>',
apiBaseUrl: '<public-campaign-api-base-url>',
});
await sdk.createPrintJob({
photoUrl: 'https://cdn.example.com/printable-image.jpg',
sessionId: '<optional-session-id>',
userId: '<optional-user-id>',
});Queue entries
import { CampaignSDK } from '@vincentt-sdks/campaign-sdk';
const sdk = CampaignSDK.getInstance();
// Enqueue a free-form task payload
const entry = await sdk.enqueueQueueEntry({
payload: { imageUrl: 'https://cdn.example.com/photos/img_123.jpg' },
});
// Poll the campaign queue FIFO (oldest first), optionally filtered by status
const queued = await sdk.fetchQueueEntries({ status: 'queued' });
// Fetch a single entry
const fetched = await sdk.getQueueEntry(entry.id);
// Claim (queued → in_progress) then complete (in_progress → done)
await sdk.updateQueueEntryStatus(entry.id, { status: 'in_progress' });
await sdk.updateQueueEntryStatus(entry.id, { status: 'done' });
await sdk.updateQueueEntryStatus(entry.id, { status: 'done', error: 'job failed' });Prize pools
Legacy campaigns may continue using the existing calls; they access only unassigned legacy prize items:
await sdk.drawCoupon();
await sdk.fetchPrizeItems();For pool-assigned prize items, select the pool explicitly:
await sdk.drawCoupon({ prizePoolId: '<prize-pool-id>' });
await sdk.fetchPrizeItems({ prizePoolId: '<prize-pool-id>' });Passcodes
Validate a passcode before granting access to the campaign microsite. Passcodes
assigned to a prize pool must be validated with that same pool; campaign-wide
passcodes omit prizePoolId.
const eligibility = await sdk.validatePasscode({
code: '<passcode>',
prizePoolId: '<optional-prize-pool-id>',
});
if (eligibility.eligible) {
await sdk.usePasscode({
code: '<passcode>',
sessionId: '<optional-session-id>',
prizePoolId: '<optional-prize-pool-id>',
});
}usePasscode records the authenticated campaign user and session, and makes
the code unavailable for subsequent use. The existing drawCoupon flow is
independent from passcode validation and consumption.
Lucky draw state
Public campaign microsites can read the current lucky-draw reward and winner
state using the campaign API key. Poll this method at the interval appropriate
for the microsite; the API exposes idle, ready, drawing, and completed
states without requiring a WebSocket connection.
const state = await sdk.getLuckyDrawState();