TypeScript SDK

import { Factify } from "@factify/sdk";

const factify = new Factify({
  bearerAuth: process.env.FACTIFY_KEY,
});

const factify = new Factify({
  bearerAuth: process.env.FACTIFY_KEY,
  serverURL: "https://api.factify.com",
  timeoutMs: 30000,
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
  },
});

factify.documents.list({ pageSize, query, createdById, accessLevel, processingStatus, sort, ownership, trashState })
factify.documents.create({ title, payload: { fileName, content } })
factify.documents.get({ documentId })
factify.documents.update({ documentId, title, description })
factify.documents.export({ documentId })
factify.documents.process({ documentId })
factify.documents.trash({ documentId })
factify.documents.untrash({ documentId })
factify.documents.transferOwnership({ documentId, newOwnerUserId })
factify.documents.listDuplicates({ documentId })
factify.documents.getQuota()

factify.versions.list({ documentId })
factify.versions.create({ documentId, payload: { fileName, content } })
factify.versions.get({ versionId })
factify.versions.update({ versionId, description })

factify.organizations.list()
factify.organizations.get({ organizationId })
factify.organizations.update({ organizationId, name })
factify.organizations.getPublicProfile({ organizationId })

factify.organizations.members.list({ organizationId })
factify.organizations.members.add({ organizationId, userId, role })
factify.organizations.members.update({ organizationId, userId, role })
factify.organizations.members.remove({ organizationId, userId })

factify.organizations.invites.list({ organizationId })
factify.organizations.invites.create({ organizationId, email, role })
factify.organizations.invites.accept({ organizationId })
factify.organizations.invites.resend({ organizationId, inviteId })
factify.organizations.invites.revoke({ organizationId, inviteId })

factify.apiKeys.list({ organizationId })
factify.apiKeys.create({ organizationId, name })
factify.apiKeys.revoke({ apiKeyId })

factify.sharing.list({ documentId })
factify.sharing.grant({ documentId, recipientId, role })
factify.sharing.update({ documentId, recipientId, role })
factify.sharing.revoke({ documentId, recipientId })
factify.sharing.getGeneralAccess({ documentId })
factify.sharing.setGeneralAccess({ documentId, accessLevel })
factify.sharing.createShareLink({ documentId })

factify.policies.list({ documentId })
factify.policies.attach({ documentId, kind })
factify.policies.detach({ documentId, policyId })

factify.accessRequests.list({ documentId })
factify.accessRequests.create({ documentId })
factify.accessRequests.checkStatus({ documentId })
factify.accessRequests.approve({ documentId, accessRequestId })
factify.accessRequests.deny({ documentId, accessRequestId })
factify.accessRequests.inspect({ documentId })

factify.usage.get()
factify.usage.getHistory()
factify.usage.listKeyQuotas()
factify.usage.setKeyQuota({ apiKeyId, monthlyLimit })
factify.usage.deleteKeyQuota({ apiKeyId })

factify.timelines.get({ documentId })

factify.users.getMe()
factify.users.preferences.get()

const result = await factify.documents.list({ pageSize: 10 });

for await (const page of result) {
  // Each page contains an array of documents
  console.log(page.documents);
}

const result = await factify.documents.list({ pageSize: 10 });

// First page
const firstPage = await result.next();
console.log(firstPage.value.documents);

// Check if more pages exist
if (!firstPage.done) {
  const secondPage = await result.next();
}

import { openAsBlob } from "node:fs";

const result = await factify.documents.create({
  title: "Q4 Financial Report",
  payload: {
    fileName: "report.pdf",
    content: await openAsBlob("./report.pdf"),
  },
});

import { Factify } from "@factify/sdk";
import * as errors from "@factify/sdk/models/errors";

try {
  const doc = await factify.documents.get({ documentId: "doc_abc123" });
} catch (error) {
  if (error instanceof errors.FactifyError) {
    console.log(error.message);
    console.log(error.httpMeta.response.status);

    if (error instanceof errors.ErrorT) {
      console.log(error.data$.error);
    }
  }
}

import { Factify } from "@factify/sdk";

const result = await factify.documents.list(
  { pageSize: 10 },
  {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
    },
  }
);

import { FactifyCore } from "@factify/sdk/core.js";
import { documentsList } from "@factify/sdk/funcs/documentsList.js";

const client = new FactifyCore({
  bearerAuth: process.env.FACTIFY_KEY,
});

const result = await documentsList(client, { pageSize: 10 });