API Modules

const result = await api.executeNql({
  nql: 'SELECT * FROM company_data."my_dataset" LIMIT 10',
  data_plane_id: null,
  execution_cluster: { type: 'shared' },  // optional
  create_as_view: false,                   // optional
});

const compiled = await api.compileNql({
  nql: 'SELECT * FROM company_data."my_dataset" LIMIT 10',
  data_plane_id: null,
});

console.log(compiled.sql);

const ast = await api.validateNql({
  nql: 'SELECT * FROM company_data."my_dataset" LIMIT 10',
  data_plane_id: null,
});

const ast = await api.parseNql({
  nql: 'SELECT * FROM company_data."my_dataset" LIMIT 10',
  data_plane_id: null,
});

const result = await api.getNqlByJobId('job-id-here');

const response = await api.getDatasets();
console.log(response.records);

const dataset = await api.getDataset(12345);

const dataset = await api.createDataset({
  name: 'my_dataset',
  display_name: 'My Dataset',
  description: 'Description here',
  schema: { properties: { ... } },
  tags: ['tag1', 'tag2'],
});

const dataset = await api.updateDataset({
  dataset_id: 12345,
  display_name: 'Updated Name',
  description: 'Updated description',
});

await api.deleteDataset(12345);

const dataset = await api.addTags(12345, ['production', 'verified']);

const dataset = await api.removeTags(12345, ['deprecated']);

const stats = await api.getStatistics(12345, 0, 1000);

const columnStats = await api.getColumnStats(12345);

const sample = await api.getDatasetSample(12345, 1000);

const { job_id } = await api.requestDatasetSample(12345);

const files = await api.getDatasetFiles(
  12345,           // datasetId
  100,             // size
  0,               // offset
  '2024-01-01',    // afterTimestamp (optional)
  67890            // fromSnapshotId (optional)
);

const { download_url } = await api.getDatasetFileDownloadUrl(
  12345,           // datasetId
  67890,           // snapshotId
  'file-id-here'   // fileId
);

const job = await api.refreshMaterializedView(12345);
console.log('Job ID:', job.id);

const dataset = await api.updateRetentionPolicy(12345, {
  type: 'time_based',
  retention_days: 365,
});

await api.activateDataset(12345);

const response = await api.getJobs({
  page: 1,
  per_page: 50,
});

const job = await api.getJob('job-id-here');

const rules = await api.getAccessRules();

const rule = await api.createAccessRule({
  // rule configuration
});

const rule = await api.updateAccessRule({
  // updated configuration
});

await api.deleteAccessRule(ruleId);

const tokens = await api.getAccessTokens();

const token = await api.getAccessToken(tokenId);

const token = await api.createAccessToken({
  name: 'My Token',
  permissions: ['datasets:read'],
  expires_at: '2025-12-31T23:59:59Z',
});

const token = await api.updateAccessToken({
  id: tokenId,
  name: 'Updated Name',
});

await api.deleteAccessToken(tokenId);

const mappings = await api.getMappings(companyId);

const mapping = await api.createPrivateMapping(companyId, {
  // mapping configuration
});

const result = await api.testMapping({
  // test configuration
});

const preview = await api.previewMapping({
  // preview configuration
});

const subscriptions = await api.getSubscriptions();

const health = await api.getHealthCheck();
console.log('Status:', health.status);

import type {
  // Core types
  NarrativeApi,
  Config,
  Environment,

  // Dataset types
  Dataset,
  DatasetStatus,
  DatasetWriteMode,
  Schema,
  SchemaProperty,

  // NQL types
  NqlQueryInput,
  NqlResult,
  NqlCompileResult,

  // Job types
  Job,

  // Access types
  AccessRule,
  AccessToken,

  // Pagination
  ApiRecords,
  ApiRecordsV2,
  PaginationOptions,
} from '@narrative.io/data-collaboration-sdk-ts';