SDK Reference

npm install @oumla/sdk

yarn add @oumla/sdk

pnpm add @oumla/sdk

import { OumlaSdkApiClient, OumlaSdkApiEnvironment } from '@oumla/sdk';

const client = new OumlaSdkApiClient({
  environment: OumlaSdkApiEnvironment.Sandbox,
  apiKey: 'your-api-key-here'
});

import type { CreateProfileRequest, CreateProfileResponse } from '@oumla/sdk';

const request: CreateProfileRequest = {
  reference: 'user-123',
  type: 'User'
};

const response: CreateProfileResponse = await client.profiles.createProfile(request);

import { OumlaSdkApiError } from '@oumla/sdk';

try {
  const profile = await client.profiles.createProfile({ reference: 'user-123', type: 'User' });
} catch (error) {
  if (error instanceof OumlaSdkApiError) {
    console.error('API Error:', error.statusCode, error.message);
    // Handle specific error codes
    if (error.statusCode === 401) {
      // Authentication error
    }
  }
}

import { OumlaSdkApiEnvironment } from '@oumla/sdk';

// Sandbox environment (for testing)
const sandboxClient = new OumlaSdkApiClient({
  environment: OumlaSdkApiEnvironment.Sandbox,
  apiKey: 'your-sandbox-api-key'
});

// Production environment
const productionClient = new OumlaSdkApiClient({
  environment: OumlaSdkApiEnvironment.Production,
  apiKey: 'your-production-api-key'
});

// Custom base URL
const customClient = new OumlaSdkApiClient({
  baseUrl: 'https://custom-api.example.com',
  apiKey: 'your-api-key'
});

const profile = await client.profiles.createProfile(
  { reference: 'user-123', type: 'User' },
  {
    timeoutInSeconds: 30,
    maxRetries: 3,
    apiKey: 'override-api-key', // Override default API key
    headers: { 'Custom-Header': 'value' }
  }
);