@zig-kids/sdk

Official JavaScript/TypeScript SDK for the Zig API.

Installation

npm install @zig-kids/sdk

Usage

Basic Setup

import { ZigSDK } from '@zig-kids/sdk';

const zig = new ZigSDK({
  baseUrl: 'https://api.zig.com',
});

With Authentication

import { ZigSDK } from '@zig/sdk';

const zig = new ZigSDK({
  baseUrl: 'https://api.zig.com',
  apiKey: 'your-api-key',
});

Custom Headers

import { ZigSDK } from '@zig/sdk';

const zig = new ZigSDK({
  baseUrl: 'https://api.zig.com',
  headers: {
    'X-Custom-Header': 'value',
  },
});

API Methods

getActivitiesByCompany(companyId, params?)

Get a paginated list of activities for a specific company.

Parameters:

• companyId (string): The ID of the company
• params (optional): Query parameters
  • page (number): Page number for pagination
  • size (number): Number of items per page
  • category (CompanyCategory): Filter by category
  • includeOccurrenceRegistrationCount (boolean): Include registration counts
  • name (string): Filter by activity name

Returns: Promise<IPageDataResponse<ICompanyActivity>>

Example:

const activities = await zig.getActivitiesByCompany('company-123', {
  page: 1,
  size: 10,
  category: 'SPORTS',
});

console.log(activities.data); // Array of activities
console.log(activities.total); // Total count
console.log(activities.page); // Current page

TypeScript Support

This SDK is written in TypeScript and provides full type definitions. All types are re-exported for convenience:

import type {
  ICompanyActivity,
  ICompanyActivityQueryParamsDto,
  IPageDataResponse,
  ZigSDKConfig,
} from '@zig/sdk';

Error Handling

The SDK throws errors for failed requests:

try {
  const activities = await zig.getActivitiesByCompany('company-123');
} catch (error) {
  console.error('API request failed:', error.message);
}

License

MIT