[email protected]

A TypeScript SDK client for the aggregator.patrickj.org API.

Usage

First, install the SDK from npm.

npm install tsml-aggregator-client --save

Next, try it out.

import {
  Configuration,
  AdminApi,
} from 'tsml-aggregator-client';
import type { AdminCreateSourceRequest } from 'tsml-aggregator-client';

async function example() {
  console.log("🚀 Testing tsml-aggregator-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearerAuth
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new AdminApi(config);

  const body = {
    // CreateSourceRequest
    createSourceRequest: ...,
  } satisfies AdminCreateSourceRequest;

  try {
    const data = await api.adminCreateSource(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://aggregator.patrickj.org

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AdminApi | adminCreateSource | POST /api/v1/admin/sources | Register a new feed AdminApi | adminDeleteSource | DELETE /api/v1/admin/sources/{source} | Soft-delete a source AdminApi | adminGetSourceDedupStats | GET /api/v1/admin/sources/{source}/dedup-stats | Deduplication counters for a source AdminApi | adminListSourceRuns | GET /api/v1/admin/sources/{source}/runs | Recent ingest runs for a source AdminApi | adminListSources | GET /api/v1/admin/sources | Admin source list with operational metadata AdminApi | adminPauseSource | POST /api/v1/admin/sources/{source}/pause | Pause ingestion (manual operator action) AdminApi | adminRefreshSource | POST /api/v1/admin/sources/{source}/refresh | Force-dispatch an immediate ingest job AdminApi | adminRestoreSource | POST /api/v1/admin/sources/{source}/restore | Restore a soft-deleted source within the 30-day window AdminApi | adminResumeSource | POST /api/v1/admin/sources/{source}/resume | Resume ingestion from paused or dormant AdminApi | adminUpdateSource | PATCH /api/v1/admin/sources/{source} | Update source metadata CatalogApi | getMap | GET /api/v1/map | All geocoded locations with active meetings, as GeoJSON CatalogApi | getStats | GET /api/v1/stats | Aggregator-wide counts and health snapshot CatalogApi | listMeetingTypes | GET /api/v1/types | Meeting-type dictionary CatalogApi | listPrograms | GET /api/v1/programs | List supported programs MeetingsApi | exportMeetings | GET /api/v1/meetings/export | Streamed NDJSON export of all meetings MeetingsApi | getRegionFeed | GET /api/v1/regions/{region}/feed | Full Meeting Guide feed for a region and its descendants MeetingsApi | getSourceFeed | GET /api/v1/sources/{source}/feed | Full Meeting Guide feed for a single source MeetingsApi | listMeetings | GET /api/v1/meetings | Filtered meeting search SourcesApi | listSources | GET /api/v1/sources | Public list of registered sources

Models

• AdminSource
• AuthError
• CreateSourceRequest
• CreateSourceResponse
• DedupCounters
• DedupStats
• DedupStatsLatestRun
• DedupStatsRecentRunsInner
• FeedValidationError
• IngestRun
• MapFeature
• MapFeatureCollection
• MapFeatureGeometry
• MapFeatureProperties
• MapMeeting
• Meeting
• MeetingPage
• MeetingPageLinks
• MeetingPageMeta
• MeetingType
• MeetingsFilterError
• Program
• PublicSource
• SourceEnvelope
• SourceRefreshResponse
• Stats
• StatsGroups
• StatsLocations
• StatsMeetingTypes
• StatsMeetings
• StatsSources
• StatsSourcesTopByMeetingCountInner
• StoreSourceValidationError
• UpdateSourceRequest
• ValidationError

Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer Token authentication

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.21.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License