@ddclarivate/fingertip-veeva-api-v2
v0.0.5
Published
DRG Fingertip Formulary API (v2) for TypeScript allows software programmers to write scripts and programs to interact and integrate with the DRG Fingertip Formulary API, in JavaScript and TypeScript
Downloads
5
Readme
Getting Started
Installation
This is a JavaScript module available through the npm registry.
$ yarn add ddclarivate/fingertip-veeva-api-v2
NOTE: As this is currently an internal package, you need to be logged in to npm + added to the npm entreprise account. Feel free to ask in #developers or #javascript.
Usage
Get Formulary Statuses
import { DRGv2 } from "ddclarivate/fingertip-veeva-api-v2";
const { VAULT_DNS, USERNAME, PASSWORD } = process.env;
const client = new DRGv2({
apiKey: "some-api-key",
});
(async () => {
const response = await client.get("/states/", {});
console.log(`Found ${response.data.length} US states.`);
// output: Found 53 formulary status(es).
})();
Development
For development on the api side of the Formulary Wizard, you start off by making your changes within this project. For example, within drg.ts you add a new function call.
Then, save all your work as we need to build using the scripts provided in package.json
Scripts
$ yarn test ## Runs tests for some files
$ yarn build ## Creates the javascript from the typescript code that will be imported into the veeva_frontend repo through the packages.
So when you have made the required changes, before you make a build, you MUST update the versioning within package.json. This versioning will be grabbed by NPM.
Then run the build script.
Once done, create a PR to merge your changes.
Then we must update the NPM entry. You need an NPM account to do so.
Roadmap
This library is being initially developed for an internal project, so API methods will likely be implemented in the order that they are needed. Eventually, I would like to cover the entire API, so contributions are of course always welcome. The calling pattern is pretty well established, so adding new methods is relatively straightforward.