AddToWallet Typescript Client

Client library that communicates with the addtowallet API.

• Installing
• Developing
• Building
• Examples
  • Creating a new client with keys
  • Creating a new client with oauth
  • Fetching a template by ID
  • Fetching templates by tag
  • Fetching a pass
  • Creating a pass bundle
  • Fetching the authenticated organization
  • Fetching all campaigns
  • Fetching all templates
  • Updating a pass
  • Updating pass logs
  • Redeem a pass
  • Get the redeemed status of a pass
  • Get image by ID
  • Get images by IDs
  • Fetching all scanner apps
  • Fetching a scanner app by ID
  • Creating a scanner app
  • Updating a scanner app
  • Deleting a scanner app

Installing

npm i @basetime/a2w-api-ts
# or
yarn add @basetime/a2w-api-ts
# or
pnpm add @basetime/a2w-api-ts

Deveoping

Run the watch command while writing code.

pnpm watch

Building

Run the build command to build the code.

pnpm build

Examples

Creating a new client with keys

import { Client, KeysProvider } from '@basetime/a2w-api-ts';

const auth = new KeysProvider('api_key', 'api_secret');
const client = new Client(auth);

Creating a new client with oauth

import { Client, OAuthProvider } from '@basetime/a2w-api-ts';

const appId = 'a2w-inspector';
const oauth = new OAuthProvider('a2w-inspector');
const client = new Client(oauth);

Fetching a template by ID

const template = await client.templates.getById('id');
console.log(template);

Fetching templates by tag

const templates = await client.templates.getByTag('tag');
console.log(templates);

Fetching a pass

const campaignId = 'h8X2JxgrnEsu2U0dI8KN';
const passId = '7gXYr76u3Maaf9ugAdWk';
const pass = await client.campaigns.getPass(campaignId, passId);
console.log(pass);

Creating a pass bundle

const campaignId = 'h8X2JxgrnEsu2U0dI8KN';

// See the meta value docs for more info.
// @see https://avagate.atlassian.net/wiki/spaces/Addto/pages/102891521/Campaigns#Meta-values
const meta = {
  bundle: '9YpI7B8G0dnvRBC1R1a2,9YpI7B8G0dnvRBC1R1a2',
  banner: 'https://example.com/banner.png',
  backgroundColor: '#ae00ff',
};

// Form values to assign to the pass bundle. Typically, a primary key is set.
const form = {
  primaryKey: '1234567890',
};

const url = await client.campaigns.createBundle(campaignId, meta, form);
console.log(url);

Creating an enrollment

Creates an enrollment for a campaign, and returns the bundle ID and any errors.

// Meta values to assign to the pass bundle.
const meta = {
  banner: 'https://example.com/banner.png',
  backgroundColor: '#ae00ff',
};

// Form values to assign to the pass bundle. Typically, a primary key is set.
const form = {
  primaryKey: '1234567890',
  firstName: 'John',
  lastName: 'Doe',
};

// Returns the bundle ID and any errors.
const enrollment = await client.campaigns.createEnrollment(campaignId, meta, form);
console.log(enrollment.pass, enrollment.errors);

Fetching the authenticated organization

const organization = await client.organizations.getMine();
console.log(organization);

Fetching all campaigns

Fetches the campaigns for the authenticated organization.

const campaigns = await client.campaigns.getAll();
console.log(campaigns);

Fetching all templates

Fetches the templates for the authenticated organization.

const templates = await client.templates.getAll();
console.log(templates);

Updating a pass

Updates the object store. This will also have a2w send the updated pass to the wallets that contain it. Only the following values can be updated:

• templateId
• templateVersion
• objectStore
• passTypeIdentifier

const campaignId = 'h8X2JxgrnEsu2U0dI8KN';
const passId = '7gXYr76u3Maaf9ugAdWk';

// Each value is optional.
const updatedPass = await client.campaigns.updatePass(campaignId, passId, {
  templateId: '123123123',
  templateVersion: 2,
  objectStore: {
    points: '42',
  },
});
console.log(updatedPass);

Updating pass logs

Appends a new log to a pass.

const campaignId = 'h8X2JxgrnEsu2U0dI8KN';
const passId = '7gXYr76u3Maaf9ugAdWk';

const ok = await client.campaigns.appendLog(campaignId, passId, 'This is a log message');
console.log(ok);

Redeem a pass

const campaignId = 'h8X2JxgrnEsu2U0dI8KN';
const passId = '7gXYr76u3Maaf9ugAdWk';
const redeemed = await client.campaigns.redeemPass(campaignId, passId);
console.log(redeemed);

Get the redeemed status of a pass

const campaignId = 'h8X2JxgrnEsu2U0dI8KN';
const passId = '7gXYr76u3Maaf9ugAdWk';
const redeemed = await client.campaigns.getRedeemedStatus(campaignId, passId);
console.log(redeemed);

Get image by ID

const image = await client.images.getById('bWVkrfizHBXyETJEIMk9');
console.log(image);

Get images by IDs

const images = await client.images.getByIds(['bWVkrfizHBXyETJEIMk9', 'pb6flbrYzrrz4rRSPA7l']);
console.log(images);

Fetching all scanner apps

const apps = await client.scanners.getAll();
console.log(apps);

Fetching a scanner app by ID

const app = await client.scanners.getById('XVK0xIy2vQinDJWUbKnO');
console.log(app);

Creating a scanner app

const app = await client.scanners.createApp({
  name: 'My Scanner',
  description: 'My Scanner',
  tags: ['tag1', 'tag2'],
  webviewScanUrl: 'https://example.com/scan',
  webviewStandbyUrl: 'https://example.com/standby',
  webviewPassword: 'password',
  passCode: '1234',
  brandColor: '#ae00ff',
  brandLogoUrl: 'https://example.com/logo.png',
  isKioskMode: true,
});
console.log(app);

Updating a scanner app

await client.scanners.updateApp('XVK0xIy2vQinDJWUbKnO', {
  name: 'My Scanner',
  description: 'My Scanner',
  tags: ['tag1', 'tag2'],
  webviewScanUrl: 'https://example.com/scan',
  webviewStandbyUrl: 'https://example.com/standby',
  webviewPassword: 'password',
  passCode: '1234',
  brandColor: '#ae00ff',
  brandLogoUrl: 'https://example.com/logo.png',
  isKioskMode: true,
});

Deleting a scanner app

await client.scanners.deleteApp('XVK0xIy2vQinDJWUbKnO');