@vincentt-sdks/campaign-sdk
v0.10.2
Published
Campaign SDK by Vincentt
Readme
rtx-campaign-sdk
Print jobs
import { CampaignSDK } from '@vincentt-sdks/campaign-sdk';
const sdk = CampaignSDK.initialize({
apiKey: '<campaign-client-api-key>',
campaignId: '<campaign-id>',
});
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' });