c4r-aggregator-client 1.0.0

package/docs/MeetingsApi.md

@@ -0,0 +1,323 @@
+# MeetingsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**exportMeetings**](MeetingsApi.md#exportmeetings) | **GET** /api/v1/meetings/export | Streamed NDJSON export of all meetings |
+| [**getRegionFeed**](MeetingsApi.md#getregionfeed) | **GET** /api/v1/regions/{region}/feed | Full Meeting Guide feed for a region and its descendants |
+| [**getSourceFeed**](MeetingsApi.md#getsourcefeed) | **GET** /api/v1/sources/{source}/feed | Full Meeting Guide feed for a single source |
+| [**listMeetings**](MeetingsApi.md#listmeetings) | **GET** /api/v1/meetings | Filtered meeting search |
+
+
+
+## exportMeetings
+
+> exportMeetings(includeInactive, program)
+
+Streamed NDJSON export of all meetings
+
+Returns every meeting as newline-delimited JSON. Intended for researchers and downstream aggregators. Heavily rate-limited (5/minute) and requires a Sanctum bearer token. Filter by `program` to scope to one program (unknown codes stream an empty body).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MeetingsApi,
+} from 'c4r-aggregator-client';
+import type { ExportMeetingsRequest } from 'c4r-aggregator-client';
+
+async function example() {
+  console.log("🚀 Testing c4r-aggregator-client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new MeetingsApi(config);
+
+  const body = {
+    // boolean | Include meetings marked inactive by stale-sweep. Default false. (optional)
+    includeInactive: true,
+    // string | Program code (`AA`, `NA`, ...) (optional)
+    program: AA,
+  } satisfies ExportMeetingsRequest;
+
+  try {
+    const data = await api.exportMeetings(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **includeInactive** | `boolean` | Include meetings marked inactive by stale-sweep. Default false. | [Optional] [Defaults to `false`] |
+| **program** | `string` | Program code (`AA`, `NA`, ...) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Streamed response with `Content-Type: application/x-ndjson`. Body is one serialized `Meeting` JSON object per line separated by `\\n`. No content-schema is emitted because the payload is not a JSON document — consume as a byte stream and split on newlines. |  -  |
+| **401** | Missing or invalid token |  -  |
+| **429** | Rate limit exceeded |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getRegionFeed
+
+> Array<Meeting> getRegionFeed(region)
+
+Full Meeting Guide feed for a region and its descendants
+
+Returns a bare JSON array of meetings located within the specified region or any sub-region.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MeetingsApi,
+} from 'c4r-aggregator-client';
+import type { GetRegionFeedRequest } from 'c4r-aggregator-client';
+
+async function example() {
+  console.log("🚀 Testing c4r-aggregator-client SDK...");
+  const api = new MeetingsApi();
+
+  const body = {
+    // number
+    region: 56,
+  } satisfies GetRegionFeedRequest;
+
+  try {
+    const data = await api.getRegionFeed(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **region** | `number` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<Meeting>**](Meeting.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Meetings in the region subtree |  -  |
+| **404** | Region not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSourceFeed
+
+> Array<Meeting> getSourceFeed(source)
+
+Full Meeting Guide feed for a single source
+
+Drop-in replacement for the upstream `/wp-json/tsml/meetings` endpoint. Returns a bare JSON array of meetings — no pagination envelope.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MeetingsApi,
+} from 'c4r-aggregator-client';
+import type { GetSourceFeedRequest } from 'c4r-aggregator-client';
+
+async function example() {
+  console.log("🚀 Testing c4r-aggregator-client SDK...");
+  const api = new MeetingsApi();
+
+  const body = {
+    // number
+    source: 56,
+  } satisfies GetSourceFeedRequest;
+
+  try {
+    const data = await api.getSourceFeed(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **source** | `number` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<Meeting>**](Meeting.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | All meetings for this source |  -  |
+| **404** | Source not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listMeetings
+
+> MeetingPage listMeetings(bbox, near, radius, regionId, sourceId, program, day, type, includeInactive, cursor, limit)
+
+Filtered meeting search
+
+Returns meetings matching the provided filter(s). At least one of `bbox`, `near`, `region_id`, `source_id`, `program`, `day`, or `type` is required. Results are cursor-paginated (default 500/page, max 2000).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MeetingsApi,
+} from 'c4r-aggregator-client';
+import type { ListMeetingsRequest } from 'c4r-aggregator-client';
+
+async function example() {
+  console.log("🚀 Testing c4r-aggregator-client SDK...");
+  const api = new MeetingsApi();
+
+  const body = {
+    // string | Bounding box filter: `minLat,minLng,maxLat,maxLng` (optional)
+    bbox: 32.5,-80.5,33.5,-79.5,
+    // string | Center-point for radius search: `lat,lng` (optional)
+    near: 33.015,-80.236,
+    // number | Radius in miles when `near` is present. Default 25, max 50. (optional)
+    radius: 3.4,
+    // number | Limit to meetings in this region (or any descendant) (optional)
+    regionId: 56,
+    // number | Limit to meetings from this source (optional)
+    sourceId: 56,
+    // string | Program code (`AA`, `NA`, ...) (optional)
+    program: AA,
+    // number | Day of week: 0=Sunday ... 6=Saturday (optional)
+    day: 56,
+    // string | Comma-separated meeting-type codes. Meetings must match every code listed. (optional)
+    type: O,D,
+    // boolean | Include meetings marked inactive by stale-sweep. Default false. (optional)
+    includeInactive: true,
+    // string | Opaque cursor for pagination, returned in `next_cursor` / `prev_cursor` (optional)
+    cursor: cursor_example,
+    // number | Rows per page (default 500, max 2000) (optional)
+    limit: 56,
+  } satisfies ListMeetingsRequest;
+
+  try {
+    const data = await api.listMeetings(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **bbox** | `string` | Bounding box filter: `minLat,minLng,maxLat,maxLng` | [Optional] [Defaults to `undefined`] |
+| **near** | `string` | Center-point for radius search: `lat,lng` | [Optional] [Defaults to `undefined`] |
+| **radius** | `number` | Radius in miles when `near` is present. Default 25, max 50. | [Optional] [Defaults to `25`] |
+| **regionId** | `number` | Limit to meetings in this region (or any descendant) | [Optional] [Defaults to `undefined`] |
+| **sourceId** | `number` | Limit to meetings from this source | [Optional] [Defaults to `undefined`] |
+| **program** | `string` | Program code (`AA`, `NA`, ...) | [Optional] [Defaults to `undefined`] |
+| **day** | `number` | Day of week: 0=Sunday ... 6=Saturday | [Optional] [Defaults to `undefined`] |
+| **type** | `string` | Comma-separated meeting-type codes. Meetings must match every code listed. | [Optional] [Defaults to `undefined`] |
+| **includeInactive** | `boolean` | Include meetings marked inactive by stale-sweep. Default false. | [Optional] [Defaults to `false`] |
+| **cursor** | `string` | Opaque cursor for pagination, returned in `next_cursor` / `prev_cursor` | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Rows per page (default 500, max 2000) | [Optional] [Defaults to `500`] |
+
+### Return type
+
+[**MeetingPage**](MeetingPage.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Matching meetings (cursor-paginated) |  -  |
+| **400** | No filter supplied |  -  |
+| **422** | Validation error |  -  |
+
+[[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/MeetingsFilterError.md

@@ -0,0 +1,39 @@
+
+# MeetingsFilterError
+
+Returned by `GET /meetings` when no filter is supplied
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`message` | string
+`availableFilters` | Array<string>
+
+## Example
+
+```typescript
+import type { MeetingsFilterError } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": invalid_filters,
+  "message": null,
+  "availableFilters": null,
+} satisfies MeetingsFilterError
+
+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 MeetingsFilterError
+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/Program.md

@@ -0,0 +1,38 @@
+
+# Program
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`code` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { Program } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "code": AA,
+  "name": Alcoholics Anonymous,
+} satisfies Program
+
+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 Program
+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/PublicSource.md

@@ -0,0 +1,55 @@
+
+# PublicSource
+
+Public view of a registered feed. Sharing keys and admin internals are hidden.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`program` | string
+`feedUrl` | string
+`feedKind` | string
+`entity` | string
+`entityUrl` | string
+`entityLocation` | string
+`state` | string
+`lastSuccessAt` | Date
+`meetingCount` | number
+
+## Example
+
+```typescript
+import type { PublicSource } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "program": AA,
+  "feedUrl": null,
+  "feedKind": null,
+  "entity": null,
+  "entityUrl": null,
+  "entityLocation": null,
+  "state": null,
+  "lastSuccessAt": null,
+  "meetingCount": null,
+} satisfies PublicSource
+
+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 PublicSource
+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/SourceEnvelope.md

@@ -0,0 +1,35 @@
+
+# SourceEnvelope
+
+{source: AdminSource} wrapper returned by patch/delete/restore/pause/resume.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`source` | [AdminSource](AdminSource.md)
+
+## Example
+
+```typescript
+import type { SourceEnvelope } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "source": null,
+} satisfies SourceEnvelope
+
+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 SourceEnvelope
+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/SourceRefreshResponse.md

@@ -0,0 +1,37 @@
+
+# SourceRefreshResponse
+
+Result of queueing an immediate re-fetch for a source.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`source` | [AdminSource](AdminSource.md)
+`dispatched` | boolean
+
+## Example
+
+```typescript
+import type { SourceRefreshResponse } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "source": null,
+  "dispatched": null,
+} satisfies SourceRefreshResponse
+
+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 SourceRefreshResponse
+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/SourcesApi.md

@@ -0,0 +1,76 @@
+# SourcesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listSources**](SourcesApi.md#listsources) | **GET** /api/v1/sources | Public list of registered sources |
+
+
+
+## listSources
+
+> Array<PublicSource> listSources(program)
+
+Public list of registered sources
+
+Returns every registered source minus admin-only fields (sharing keys, next_fetch_at, failures, etc.). Filter by `program` to scope to one program (e.g. `AA`, `NA`); unknown codes return an empty array.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SourcesApi,
+} from 'c4r-aggregator-client';
+import type { ListSourcesRequest } from 'c4r-aggregator-client';
+
+async function example() {
+  console.log("🚀 Testing c4r-aggregator-client SDK...");
+  const api = new SourcesApi();
+
+  const body = {
+    // string | Program code (`AA`, `NA`, ...) (optional)
+    program: AA,
+  } satisfies ListSourcesRequest;
+
+  try {
+    const data = await api.listSources(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<PublicSource>**](PublicSource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Registered sources |  -  |
+
+[[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/Stats.md

@@ -0,0 +1,51 @@
+
+# Stats
+
+Aggregator-wide counts snapshot. Cached 60 seconds (per program filter).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`generatedAt` | Date
+`program` | string
+`meetings` | [StatsMeetings](StatsMeetings.md)
+`locations` | [StatsLocations](StatsLocations.md)
+`groups` | [StatsGroups](StatsGroups.md)
+`sources` | [StatsSources](StatsSources.md)
+`meetingTypes` | [StatsMeetingTypes](StatsMeetingTypes.md)
+`programsBreakdown` | [Array<StatsProgramsBreakdownInner>](StatsProgramsBreakdownInner.md)
+`lastSuccessfulIngestAt` | Date
+
+## Example
+
+```typescript
+import type { Stats } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "generatedAt": null,
+  "program": AA,
+  "meetings": null,
+  "locations": null,
+  "groups": null,
+  "sources": null,
+  "meetingTypes": null,
+  "programsBreakdown": null,
+  "lastSuccessfulIngestAt": null,
+} satisfies Stats
+
+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 Stats
+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/StatsGroups.md

@@ -0,0 +1,35 @@
+
+# StatsGroups
+
+Group-count breakdowns in Stats.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+
+## Example
+
+```typescript
+import type { StatsGroups } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+} satisfies StatsGroups
+
+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 StatsGroups
+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)
+
+