Big Crime Watch API Client

A TypeScript client library for interacting with the Big Crime Watch API.

Installation

npm install bc-client

Usage

import { BigCrimeWatchClient, SubscriptionTier } from 'bc-client';

// Initialize the client with your API URL and token
const client = new BigCrimeWatchClient('https://api.bigcrimewatch.com', 'your-auth-token');

// Or initialize without a token and set it later
const client = new BigCrimeWatchClient('https://api.bigcrimewatch.com');
client.setToken('new-auth-token');

// Example: Get subscription details
async function getSubscriptionInfo() {
  try {
    const subscription = await client.subscription.getSubscriptionDetails();
    console.log('Current subscription:', subscription);
  } catch (error) {
    console.error('Error fetching subscription:', error);
  }
}

// Example: Upgrade subscription
async function upgradeSubscription() {
  try {
    const result = await client.subscription.upgradeSubscription(SubscriptionTier.PRO);
    console.log('Upgrade successful:', result);
  } catch (error) {
    console.error('Upgrade failed:', error);
  }
}

Available Methods

Subscription API

• client.subscription.getUsage() - Get current user's usage statistics
• client.subscription.getSubscriptionDetails() - Get current user's subscription details
• client.subscription.upgradeSubscription(tier) - Upgrade user's subscription
• client.subscription.getAllTiers() - Get all available subscription tiers

Types

The library exports TypeScript interfaces for all API responses to provide proper type checking.