SpySERP TypeScript Client

This project is a TypeScript client for the SpySERP API. It provides an easy to use interface to interact with the different SpySERP API services.

Requirements

• Node.js
• npm

Installation

npm install @centriadevelopment/spyserp-ts-client

Usage

import { ApiService } from '@centriadevelopment/spyserp-ts-client';

const config = {
baseUrl: 'https://spyserp.com/panel/api',
apiToken: 'YOUR_API_TOKEN'
};

const api = new ApiService(config);

// Get all projects
const projects = await api.projects.getProjects();

// Get specific project
const project = await api.projects.getProject({ project_id: 123 });
};

Contributing

This project uses semantic versioning and semantic-release for version management.

Commit messages must follow the Conventional Commits specification:

• major(scope): message - Breaking changes
• feat(scope): message - New features (minor version)
• fix(scope): message - Bug fixes (patch version)
• docs(scope): message - Documentation changes
• style(scope): message - Code style changes
• refactor(scope): message - Code refactoring
• perf(scope): message - Performance improvements
• test(scope): message - Test changes

Examples:

feat(projects): add new project creation endpoint
fix(http): handle timeout errors correctly
major(api): change response structure

The version will be automatically updated based on your commit messages when merging to main.