c4r-aggregator-client 1.0.0

package/docs/AdminSource.md

@@ -0,0 +1,77 @@
+
+# AdminSource
+
+Full admin view of a source, including failure state, backoff, and all entity metadata.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`program` | string
+`name` | string
+`feedUrl` | string
+`feedKind` | string
+`state` | string
+`fetchIntervalMinutes` | number
+`lastFetchedAt` | Date
+`lastSuccessAt` | Date
+`lastError` | string
+`lastErrorType` | string
+`consecutiveFailures` | number
+`nextFetchAt` | Date
+`lastSuccessfulMeetingCount` | number
+`daysSinceLastSuccess` | number
+`pausedAt` | Date
+`dormantAt` | Date
+`deletedAt` | Date
+`entity` | string
+`entityEmail` | string
+`entityUrl` | string
+`notificationWebhookUrl` | string
+
+## Example
+
+```typescript
+import type { AdminSource } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "program": null,
+  "name": null,
+  "feedUrl": null,
+  "feedKind": null,
+  "state": null,
+  "fetchIntervalMinutes": null,
+  "lastFetchedAt": null,
+  "lastSuccessAt": null,
+  "lastError": null,
+  "lastErrorType": null,
+  "consecutiveFailures": null,
+  "nextFetchAt": null,
+  "lastSuccessfulMeetingCount": null,
+  "daysSinceLastSuccess": null,
+  "pausedAt": null,
+  "dormantAt": null,
+  "deletedAt": null,
+  "entity": null,
+  "entityEmail": null,
+  "entityUrl": null,
+  "notificationWebhookUrl": null,
+} satisfies AdminSource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AdminSource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AuthError.md

@@ -0,0 +1,34 @@
+
+# AuthError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+
+## Example
+
+```typescript
+import type { AuthError } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": Unauthenticated.,
+} satisfies AuthError
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AuthError
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CatalogApi.md

@@ -0,0 +1,270 @@
+# CatalogApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getMap**](CatalogApi.md#getmap) | **GET** /api/v1/map | All geocoded locations with active meetings, as GeoJSON |
+| [**getStats**](CatalogApi.md#getstats) | **GET** /api/v1/stats | Aggregator-wide counts and health snapshot |
+| [**listMeetingTypes**](CatalogApi.md#listmeetingtypes) | **GET** /api/v1/types | Meeting-type dictionary |
+| [**listPrograms**](CatalogApi.md#listprograms) | **GET** /api/v1/programs | List supported programs |
+
+
+
+## getMap
+
+> MapFeatureCollection getMap(program)
+
+All geocoded locations with active meetings, as GeoJSON
+
+One Feature per Location (not per meeting), with the list of meetings-at-that-location in the properties. Intended for a coverage-map view — show pins, click to see meeting names. Cached for 5 minutes (per program filter).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CatalogApi,
+} from 'c4r-aggregator-client';
+import type { GetMapRequest } from 'c4r-aggregator-client';
+
+async function example() {
+  console.log("🚀 Testing c4r-aggregator-client SDK...");
+  const api = new CatalogApi();
+
+  const body = {
+    // string | Program code (`AA`, `NA`, ...) (optional)
+    program: AA,
+  } satisfies GetMapRequest;
+
+  try {
+    const data = await api.getMap(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **program** | `string` | Program code (`AA`, `NA`, ...) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**MapFeatureCollection**](MapFeatureCollection.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | GeoJSON FeatureCollection |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getStats
+
+> Stats getStats(program)
+
+Aggregator-wide counts and health snapshot
+
+Cached for 60s in Redis (per program filter). Useful for dashboards, transparency pages, and monitoring. Pass `?program=AA` to scope every count to a single program; `programs_breakdown` is always included so you can see per-program slices alongside the totals.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CatalogApi,
+} from 'c4r-aggregator-client';
+import type { GetStatsRequest } from 'c4r-aggregator-client';
+
+async function example() {
+  console.log("🚀 Testing c4r-aggregator-client SDK...");
+  const api = new CatalogApi();
+
+  const body = {
+    // string | Program code (`AA`, `NA`, ...) (optional)
+    program: AA,
+  } satisfies GetStatsRequest;
+
+  try {
+    const data = await api.getStats(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **program** | `string` | Program code (`AA`, `NA`, ...) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Stats**](Stats.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Stats snapshot |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listMeetingTypes
+
+> Array<MeetingType> listMeetingTypes(program)
+
+Meeting-type dictionary
+
+Returns all known meeting-type codes. Filter by `program` to scope to one program (e.g. AA).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CatalogApi,
+} from 'c4r-aggregator-client';
+import type { ListMeetingTypesRequest } from 'c4r-aggregator-client';
+
+async function example() {
+  console.log("🚀 Testing c4r-aggregator-client SDK...");
+  const api = new CatalogApi();
+
+  const body = {
+    // string | Program code (`AA`, `NA`, ...) (optional)
+    program: AA,
+  } satisfies ListMeetingTypesRequest;
+
+  try {
+    const data = await api.listMeetingTypes(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **program** | `string` | Program code (`AA`, `NA`, ...) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<MeetingType>**](MeetingType.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Meeting types |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listPrograms
+
+> Array<Program> listPrograms()
+
+List supported programs
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CatalogApi,
+} from 'c4r-aggregator-client';
+import type { ListProgramsRequest } from 'c4r-aggregator-client';
+
+async function example() {
+  console.log("🚀 Testing c4r-aggregator-client SDK...");
+  const api = new CatalogApi();
+
+  try {
+    const data = await api.listPrograms();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Program>**](Program.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Programs |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/CreateSourceRequest.md

@@ -0,0 +1,46 @@
+
+# CreateSourceRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`feedUrl` | string
+`program` | string
+`feedKind` | string
+`name` | string
+`sharingKey` | string
+`fetchIntervalMinutes` | number
+`notificationWebhookUrl` | string
+
+## Example
+
+```typescript
+import type { CreateSourceRequest } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "feedUrl": null,
+  "program": AA,
+  "feedKind": null,
+  "name": null,
+  "sharingKey": null,
+  "fetchIntervalMinutes": null,
+  "notificationWebhookUrl": null,
+} satisfies CreateSourceRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateSourceRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateSourceResponse.md

@@ -0,0 +1,38 @@
+
+# CreateSourceResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`source` | [AdminSource](AdminSource.md)
+`totalMeetingsFound` | number
+`sampleMeetings` | Array<object>
+
+## Example
+
+```typescript
+import type { CreateSourceResponse } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "source": null,
+  "totalMeetingsFound": null,
+  "sampleMeetings": null,
+} satisfies CreateSourceResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateSourceResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DedupCounters.md

@@ -0,0 +1,53 @@
+
+# DedupCounters
+
+Per-layer dedup counters from a single ingest run or summed across multiple runs.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`locationsCreated` | number
+`locationsMatchedByUpstreamId` | number
+`locationsMatchedByAddress` | number
+`locationsMatchedByProximity` | number
+`groupsCreated` | number
+`groupsMatchedByUpstreamId` | number
+`groupsMatchedByName` | number
+`meetingsCreated` | number
+`meetingsMatched` | number
+`typesAutoDiscovered` | number
+
+## Example
+
+```typescript
+import type { DedupCounters } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "locationsCreated": null,
+  "locationsMatchedByUpstreamId": null,
+  "locationsMatchedByAddress": null,
+  "locationsMatchedByProximity": null,
+  "groupsCreated": null,
+  "groupsMatchedByUpstreamId": null,
+  "groupsMatchedByName": null,
+  "meetingsCreated": null,
+  "meetingsMatched": null,
+  "typesAutoDiscovered": null,
+} satisfies DedupCounters
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DedupCounters
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DedupStats.md

@@ -0,0 +1,45 @@
+
+# DedupStats
+
+Dedup activity for a source — aggregate totals, latest run, and recent-run history.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sourceId` | number
+`sourceName` | string
+`runCount` | number
+`totals` | [DedupCounters](DedupCounters.md)
+`latestRun` | [DedupStatsLatestRun](DedupStatsLatestRun.md)
+`recentRuns` | [Array<DedupStatsRecentRunsInner>](DedupStatsRecentRunsInner.md)
+
+## Example
+
+```typescript
+import type { DedupStats } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sourceId": null,
+  "sourceName": null,
+  "runCount": null,
+  "totals": null,
+  "latestRun": null,
+  "recentRuns": null,
+} satisfies DedupStats
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DedupStats
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DedupStatsLatestRun.md

@@ -0,0 +1,41 @@
+
+# DedupStatsLatestRun
+
+Most recent ingest run for a source, with its per-run dedup counters.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`startedAt` | Date
+`finishedAt` | Date
+`status` | string
+`counters` | [DedupCounters](DedupCounters.md)
+
+## Example
+
+```typescript
+import type { DedupStatsLatestRun } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "startedAt": null,
+  "finishedAt": null,
+  "status": null,
+  "counters": null,
+} satisfies DedupStatsLatestRun
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DedupStatsLatestRun
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DedupStatsRecentRunsInner.md

@@ -0,0 +1,39 @@
+
+# DedupStatsRecentRunsInner
+
+Condensed entry in DedupStats.recent_runs[].
+
+## Properties
+
+Name | Type
+------------ | -------------
+`startedAt` | Date
+`status` | string
+`counters` | [DedupCounters](DedupCounters.md)
+
+## Example
+
+```typescript
+import type { DedupStatsRecentRunsInner } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "startedAt": null,
+  "status": null,
+  "counters": null,
+} satisfies DedupStatsRecentRunsInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DedupStatsRecentRunsInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FeedValidationError.md

@@ -0,0 +1,39 @@
+
+# FeedValidationError
+
+Returned by `POST /admin/sources` when the upstream feed cannot be validated
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`errorType` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { FeedValidationError } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": invalid_feed,
+  "errorType": null,
+  "message": null,
+} satisfies FeedValidationError
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FeedValidationError
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+