@specnote/sdk

TypeScript SDK for SpecNote API - Generated from OpenAPI specification.

Installation

npm install @specnote/sdk
# or
yarn add @specnote/sdk
# or
pnpm add @specnote/sdk

Usage

import { SpecNoteAPI } from '@specnote/sdk';

// Initialize the SDK
const api = new SpecNoteAPI({
  BASE: 'https://api.specnote.com', // Your API URL
  TOKEN: 'your-jwt-token', // Optional: set authentication token
});

// Login
const { data } = await api.auth.login({
  email: '[email protected]',
  password: 'password123'
});

// Use the token for authenticated requests
api.request.config.TOKEN = data.token;

// Get current user
const userResponse = await api.auth.getCurrentUser();
console.log(userResponse.data);

// List tasks
const tasksResponse = await api.tasks.listTasks({
  page: 1,
  size: 10,
  projectId: 'project-id'
});
console.log(tasksResponse.data);

Available Services

• auth - Authentication endpoints
• users - User management
• organizations - Organization management
• projects - Project management
• requirements - Requirements management
• tasks - Task management
• scopes - Scope management
• applications - Application management

Configuration

const api = new SpecNoteAPI({
  BASE: 'https://api.specnote.com',     // API base URL
  VERSION: '1.0.0',                     // API version
  WITH_CREDENTIALS: false,              // Include credentials
  CREDENTIALS: 'include',               // Credentials mode
  TOKEN: 'your-jwt-token',              // Bearer token
  USERNAME: undefined,                  // Basic auth username
  PASSWORD: undefined,                  // Basic auth password
  HEADERS: {                           // Additional headers
    'X-Custom-Header': 'value'
  },
  ENCODE_PATH: undefined,              // Custom path encoder
});

Error Handling

try {
  const response = await api.users.getUser('user-id');
  console.log(response.data);
} catch (error) {
  if (error.status === 404) {
    console.error('User not found');
  } else if (error.status === 401) {
    console.error('Unauthorized - please login');
  } else {
    console.error('An error occurred:', error.message);
  }
}

TypeScript Support

This SDK is fully typed with TypeScript. All request and response types are automatically generated from the OpenAPI specification.

License

MIT

Development

This SDK is automatically generated from the OpenAPI specification. Do not edit the generated files directly.

To regenerate the SDK:

pnpm generate