Class: FirmhouseClient

Client for accessing Firmhouse GraphQL api

Example

import { FirmhouseClient, Access } from '@firmhouse/sdk';
const client = new FirmhouseClient({
 apiToken,
 accessType: Access.write
});

const cart = await client.carts.getOrCreate();
const products = await client.products.fetchAll();
const invoices = await client.invoices.fetchAll();

Type Parameters

TAccess

TAccess extends Access = storefront

Access type. (Will be inferred from the config)

Properties

Property	Modifier	Type
config	readonly	FirmhouseConfig<TAccess>

Methods

rawRequest()

rawRequest(graphQLQuery, variables?): Promise<unknown>;

Sends an authenticated raw request to API. This can be used for custom field selections or bulk queries/mutations.

Parameters

graphQLQuery

string

The GraphQL query

variables?

Record<string, unknown>

Variables to use in query

Returns

Promise<unknown>

The response from the API

Throws

• NotFoundError - When there is an entity not found error in the response

• ValidationError - When there are invalid fields

• ServerError - When the request fails

Resources

Resources for accessing Firmhouse API

Available with Storefront Access

carts

Get Signature

get carts(): Carts;

Cart methods

Returns

Carts

---

plans

Get Signature

get plans(): Plans;

Plan methods

Example

const plans = await client.plans.fetchAll();

Returns

Plans

---

products

Get Signature

get products(): Products;

Product methods

Example

const products = await client.products.fetchAll();

Returns

Products

---

selfServiceCenterToken

Get Signature

get selfServiceCenterToken(): SelfServiceCenterToken;

SelfServiceCenterToken methods

Returns

SelfServiceCenterToken

Only Available with Storefront Access

payments

Get Signature

get payments(): TAccess extends storefront ? Payments : never;

Checkout payment methods

Example

const session = await client.payments.createAdyenSession(subscriptionToken, paymentToken);

Returns

TAccess extends storefront ? Payments : never

Only Available with Write Access

invoices

Get Signature

get invoices(): TAccess extends write ? Invoices : never;

Invoice methods

Returns

TAccess extends write ? Invoices : never

---

projects

Get Signature

get projects(): TAccess extends write ? Projects : never;

Project methods

Returns

TAccess extends write ? Projects : never

---

subscriptions

Get Signature

get subscriptions(): TAccess extends write ? Subscriptions : never;

Subscription methods.

Returns

TAccess extends write ? Subscriptions : never