@getdal/crm-sdk

TypeScript SDK for interacting with the Dal Compliance CRM API.

Installation

npm install @getdal/crm-sdk
# or
yarn add @getdal/crm-sdk

Initialization

Initialize the SDK with your environment, tenant ID, and API key.

import { Dal, Env } from '@getdal/crm-sdk';

Dal.init(Env.Dev, 'your-tenant-id', 'your-api-key');

Usage

Client Management

List Clients

const clients = await Dal.clients.list({
  page: 1,
  size: 20,
  filters: {
    searchTerm: 'John Doe',
  }
});

Create Client

import { ClientType, IdentityType } from '@getdal/crm-sdk';

const newClient = await Dal.clients.create({
  type: ClientType.Individual,
  firstNameEn: 'John',
  lastNameEn: 'Doe',
  email: '[email protected]',
  idType: IdentityType.NationalIdentity,
  idNumber: '1234567890',
});

Watchlists

Create Watchlist Entry

import { WatchlistSource, IdentityType } from '@getdal/crm-sdk';

await Dal.watchlists.create({
  source: WatchlistSource.Nafith, // or other sources
  orderNumber: 'ORD-001',
  idType: IdentityType.NationalIdentity,
  idNumber: '1000000001',
  name: 'Target Entity'
});

Check History

const history = await Dal.watchlists.getHistory();

Webhooks

Check Status

const status = await Dal.webhooks.getStatus();
console.log(`Webhook Status: ${status.status}`);

Check Health

const health = await Dal.webhooks.checkHealth();

Health Check

const apiHealth = await Dal.health.check();