acme-ticketing-client
v1.0.733
Published
NodeJS client for the functionality provided by the ACME Ticketing platform.
Downloads
72
Readme
ACME Ticketing Client
This is a Node JS client for the ACME Ticketing API, built for open-source by the Barnes Foundation.
General usage is the following. Once you've initialized the client, you can use your desired modules as needed.
import { ACMETicketingClient, TicketingFunctions, EventFunctions } from '../src/index';
// Get credentials from .env
const b2cTenantId = '<Your tenant id>';
const apiKey = '<Your API key>';
const apiRootUrl = '<Your Sandbox URL. Otherwise, defaults to the production API URL>';
// Setup client - initializes the client for usage across your app
new ACMETicketingClient({ b2cTenantId, apiKey, apiRootUrl });
// Get all events, since we supplied no filter criteria
const allMyEvents = await EventFunctions.listEvents();
As you can tell from the above, you're able to import only the modules you need, which makes accessing functions via these modules much easier, straightforward, and simple for encapsulating logic in your applications.
100% of modules have included TSDoc so you can easily see method signatures, giving you helpful information like what parameters a method accepts, it's purpose, what it returns, etc.
You can see example usage of several of the modules over in the testing file test.ts.