@dimrev4/pixel-verdict-v2-sdk

TypeScript SDK for the Pixel Verdict V2 API, generated from OpenAPI specification.

Installation

npm install @dimrev4/pixel-verdict-v2-sdk

Usage

Basic Usage

import { DefaultApi, Configuration } from '@dimrev4/pixel-verdict-v2-sdk';

// Create configuration
const config = new Configuration({
  basePath: 'http://localhost:42069',
  // Add authentication if needed
  // accessToken: 'your-jwt-token'
});

// Create API instance
const api = new DefaultApi(config);

// Use the API
async function example() {
  try {
    const response = await api.someEndpoint();
    console.log(response.data);
  } catch (error) {
    console.error('API Error:', error);
  }
}

Quick Setup with Helper Function

import { createPixelVerdictApi } from '@dimrev4/pixel-verdict-v2-sdk';

// Quick setup with default configuration
const api = createPixelVerdictApi();

// Or with custom configuration
const api = createPixelVerdictApi({
  basePath: 'https://api.pixelverdict.com',
  accessToken: 'your-jwt-token',
});

ESM

import {
  DefaultApi,
  Configuration,
  AxiosError,
} from '@dimrev4/pixel-verdict-v2-sdk';
import type { AxiosResponse } from '@dimrev4/pixel-verdict-v2-sdk';

const config = new Configuration({
  basePath: 'http://localhost:42069',
  accessToken: 'your-jwt-access-token',
});

const api = new DefaultApi(config);

// Handle errors with proper typing
try {
  const response = await api.someEndpoint();
  console.log(response.data);
} catch (error) {
  if (error instanceof AxiosError) {
    console.error('HTTP Error:', error.response?.status);
    console.error('Error Data:', error.response?.data);
  }
}

Error Handling

The SDK exports Axios types for better error handling:

import {
  DefaultApi,
  Configuration,
  AxiosError,
} from '@dimrev4/pixel-verdict-v2-sdk';
import type {
  AxiosResponse,
  AxiosRequestConfig,
} from '@dimrev4/pixel-verdict-v2-sdk';

try {
  const response: AxiosResponse = await api.someEndpoint();
} catch (error) {
  if (error instanceof AxiosError) {
    // Handle HTTP errors
    if (error.response) {
      // Server responded with error status
      console.error('Status:', error.response.status);
      console.error('Data:', error.response.data);
    } else if (error.request) {
      // Request was made but no response received
      console.error('Network error:', error.message);
    } else {
      // Something else happened
      console.error('Error:', error.message);
    }
  }
}

Authentication

This SDK supports JWT authentication. You can set the access token in the configuration:

const config = new Configuration({
  basePath: 'http://localhost:42069',
  accessToken: 'your-jwt-access-token',
});

Building

The SDK supports both CommonJS and ESM builds:

npm run build

This will generate:

• ./dist/ - CommonJS build
• ./dist/esm/ - ESM build

Publishing

To publish to npm:

npm publish --access public

Auto-generated

This SDK is auto-generated from the OpenAPI specification. Do not edit the generated files directly. To regenerate the SDK, run the generation script in the backend project.