Skip to main content

FreeqSdk

Defined in: FreeqSDK.ts:49

The main entry point for interacting with the Freeq API.

Remarks​

Provides methods for authentication, accessing organisations, and retrieving API version information.

Example​

const sdk = new FreeqSdk({ baseUrl: "https://api.freeq.io", apiKey: "your-api-key" });
const wallet = await sdk.signIn("user-token");
const organisations = await sdk.getOrganisations();
console.log(sdk.versions);

Constructors​

Constructor​

new FreeqSdk(options): FreeqSdk;

Defined in: FreeqSDK.ts:59

Creates a new FreeqSdk instance.

Parameters​

options​

FreeqSDKOptions

SDK options including baseUrl and apiKey.

Returns​

FreeqSdk

Accessors​

versions​

Get Signature​

get versions(): undefined | FreeqApiVersion[];

Defined in: FreeqSDK.ts:99

Available API versions after sign-in.

Returns​

undefined | FreeqApiVersion[]

Methods​

getOrganisations()​

getOrganisations(): Promise<Organisations>;

Defined in: FreeqSDK.ts:116

Retrieves (and caches) the organisations collection.

Returns​

Promise<Organisations>

getProject()​

getProject(): Promise<Project>;

Defined in: FreeqSDK.ts:106

Retrieves (and caches) the current project instance.

Returns​

Promise<Project>

signIn()​

signIn(token?): Promise<Wallet>;

Defined in: FreeqSDK.ts:73

Signs in to the Freeq API and returns the authenticated wallet.

Parameters​

token?​

string

The user authentication token (e.g. from your app's auth flow).

Returns​

Promise<Wallet>

The authenticated Wallet instance.