@onparlay/api-client

Type-safe API client for OnParlay backend, automatically generated from OpenAPI/Swagger specification.

Installation

npm install @onparlay/api-client

No authentication needed - the package is published to npm public registry.

Usage

import { bulkCreateMatchEntries, MatchEntryData } from "@onparlay/api-client";

// Configure base URL (optional, defaults to http://localhost:3333)
process.env.API_BASE_URL = "https://api.onparlay.com";

const matchEntries: MatchEntryData[] = [
  {
    startDate: "2024-12-25T15:00:00Z",
    homeTeam: "Manchester United",
    awayTeam: "Liverpool",
    competition: "Premier League",
    country: "England",
  },
];

const result = await bulkCreateMatchEntries({
  sportName: "Football",
  sportsbookName: "Bwin",
  matchEntries,
});

console.log(`Created ${result.count} match entries`);

Development

Generate API Client

Simple way (copies from backend repo and generates):

npm run generate:from-backend

This will:

1. Copy openapi.json from ../onparlay-backend/openapi.json
2. Generate the TypeScript client from it

Manual steps:

1. First, export the OpenAPI spec from the backend:

   cd ../onparlay-backend
   npm run export:openapi

2. Copy it to this repo (or use the script):

   npm run copy-openapi

3. Generate the client:

   npm run generate

From running backend (alternative):

# Make sure backend is running on http://localhost:3333
OPENAPI_SPEC_URL=http://localhost:3333/api-json npm run generate

Watch mode (regenerates on changes):

npm run generate:watch

Build

npm run build

Publish New Version

Patch version (bug fixes):

npm run publish:patch

Minor version (new features):

npm run publish:minor

Major version (breaking changes):

npm run publish:major

Or manually:

npm version patch  # or minor/major
npm publish

Note: You need to be logged in to npm and have 2FA enabled (required for scoped packages):

1. Enable 2FA on npm:

   • Go to: https://www.npmjs.com/settings/[your-username]/security
   • Enable "Two-factor authentication"
   • Follow the setup instructions

2. Login to npm:

   npm login

3. Publish:

   npm publish

Alternative: If you don't want to use 2FA, create a granular access token:

• Go to: https://www.npmjs.com/settings/[your-username]/tokens
• Create token with "Automation" type and "Bypass 2FA" enabled
• Use it with: npm publish --access public

Configuration

The API client uses axios and can be configured via environment variables:

• API_BASE_URL: Base URL for API requests (default: http://localhost:3333)

Versioning

This package follows Semantic Versioning:

• Major: Breaking API changes
• Minor: New features, backward compatible
• Patch: Bug fixes, documentation

License

UNLICENSED