https://github.com/faradayio/faraday-js
Typescript library to access Faraday's API infrastructure for B2C predictions
https://github.com/faradayio/faraday-js
acquisition-and-engagement b2c churn churn-prediction consumer-intelligence lead-scoring predictive-modeling scoring
Last synced: 3 months ago
JSON representation
Typescript library to access Faraday's API infrastructure for B2C predictions
- Host: GitHub
- URL: https://github.com/faradayio/faraday-js
- Owner: faradayio
- License: mit
- Created: 2022-03-25T19:52:48.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-10-07T15:05:32.000Z (3 months ago)
- Last Synced: 2025-10-07T17:25:45.067Z (3 months ago)
- Topics: acquisition-and-engagement, b2c, churn, churn-prediction, consumer-intelligence, lead-scoring, predictive-modeling, scoring
- Language: TypeScript
- Homepage: https://faraday.ai/developers/reference
- Size: 1.86 MB
- Stars: 24
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## @fdy/faraday-js
This is autogenerated Typescript client library to consume the [Faraday API](https://faraday.ai/developers/reference).
### Installation
```
npm install @fdy/faraday-js --save
```
### Usage
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));
```