TypeScript SDK

1
import { UsgmClient } from "@usgm/sdk";
2
3
const usgm = new UsgmClient({
4
  token: process.env.USGM_API_KEY!, // never hard-code the key
5
});

1
// Your account profile
2
const account = await usgm.account.get();
3
console.log(account.email, account.status);
4
5
// List mail, one page at a time (cursor pagination)
6
let cursor: string | undefined;
7
do {
8
  const page = await usgm.mails.list({ cursor });
9
  for (const mail of page.data) {
10
    console.log(mail.id, mail.sender_name);
11
  }
12
  cursor = page.next_cursor ?? undefined;
13
} while (cursor);
14
15
// Fetch one item
16
const mail = await usgm.mails.get({ id: "80421" });
17
18
// Create a folder
19
const folder = await usgm.folders.create({ name: "Taxes" });

1
import { UsgmError } from "@usgm/sdk";
2
3
try {
4
  await usgm.mails.get({ id: "does-not-exist" });
5
} catch (err) {
6
  if (err instanceof UsgmError) {
7
    // `body` is the RFC 9457 problem+json payload (code, request_id, detail, …)
8
    console.error(err.statusCode, err.body);
9
  }
10
  throw err;
11
}