This is autogenerated Typescript client library to consume the Faraday API.
npm install @fdy/faraday-js --save
To create a simple script, initialize a new project, install the libraries, and run using tsx or your preffered Typescript compiler.
npm tsc --init
npm install @fdy/faraday-js
-- if using outside of the browser
npm install isomorphic-fetch
touch index.ts
-- populate file, and then run using
npx tsx ./index.ts
Example usage:
import { Configuration, FaradayClient } from "@fdy/faraday-js";
import "isomorphic-fetch";
const configuration = new Configuration({
headers: {
authorization: "Bearer YOUR_API_KEY",
},
});
const faraday = new FaradayClient(configuration);
const testClient = async () => {
// Create a dataset if you do not already have one.
// Create a cohort
const cohort = await faraday.cohorts.createCohort({
name: "Customers",
stream_name: "orders",
});
// Create a persona set
const personaSet = await faraday.personaSets.createPersonaSet({
name: "Customers",
cohort_id: cohort.id,
});
// Create an outcome
const outcome = await faraday.outcomes.createOutcome({
attainment_cohort_id: cohort.id,
name: "Likely Customers",
});
// Create a scope
const scope = await faraday.scopes.createScope({
name: "Customers Scores",
preview: true,
population: {
cohort_ids: [cohort.id],
},
payload: {
persona_set_ids: [personaSet.id],
},
});
};
testClient().catch((err) => console.log(err));