c4r-aggregator-client 1.0.0

package/docs/AdminApi.md

@@ -0,0 +1,734 @@
+# AdminApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**adminCreateSource**](AdminApi.md#admincreatesource) | **POST** /api/v1/admin/sources | Register a new feed |
+| [**adminDeleteSource**](AdminApi.md#admindeletesource) | **DELETE** /api/v1/admin/sources/{source} | Soft-delete a source |
+| [**adminGetSourceDedupStats**](AdminApi.md#admingetsourcededupstats) | **GET** /api/v1/admin/sources/{source}/dedup-stats | Deduplication counters for a source |
+| [**adminListSourceRuns**](AdminApi.md#adminlistsourceruns) | **GET** /api/v1/admin/sources/{source}/runs | Recent ingest runs for a source |
+| [**adminListSources**](AdminApi.md#adminlistsources) | **GET** /api/v1/admin/sources | Admin source list with operational metadata |
+| [**adminPauseSource**](AdminApi.md#adminpausesource) | **POST** /api/v1/admin/sources/{source}/pause | Pause ingestion (manual operator action) |
+| [**adminRefreshSource**](AdminApi.md#adminrefreshsource) | **POST** /api/v1/admin/sources/{source}/refresh | Force-dispatch an immediate ingest job |
+| [**adminRestoreSource**](AdminApi.md#adminrestoresource) | **POST** /api/v1/admin/sources/{source}/restore | Restore a soft-deleted source within the 30-day window |
+| [**adminResumeSource**](AdminApi.md#adminresumesource) | **POST** /api/v1/admin/sources/{source}/resume | Resume ingestion from paused or dormant |
+| [**adminUpdateSource**](AdminApi.md#adminupdatesource) | **PATCH** /api/v1/admin/sources/{source} | Update source metadata |
+
+
+
+## adminCreateSource
+
+> CreateSourceResponse adminCreateSource(createSourceRequest)
+
+Register a new feed
+
+Synchronously fetches the upstream feed and validates it has at least one meeting with `slug`, `day`, and `time`. If valid, persists the source in `pending` state and returns a 10-row preview. If invalid, returns 422 with the error type.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminCreateSourceRequest } 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 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);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createSourceRequest** | [CreateSourceRequest](CreateSourceRequest.md) |  | |
+
+### Return type
+
+[**CreateSourceResponse**](CreateSourceResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created + preview |  -  |
+| **401** | Unauthenticated |  -  |
+| **422** | Feed validation failed or payload invalid |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## adminDeleteSource
+
+> SourceEnvelope adminDeleteSource(source)
+
+Soft-delete a source
+
+Stops future fetches and marks meetings for stale-sweep. Reversible via `/restore` within 30 days.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminDeleteSourceRequest } 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 AdminApi(config);
+
+  const body = {
+    // number
+    source: 56,
+  } satisfies AdminDeleteSourceRequest;
+
+  try {
+    const data = await api.adminDeleteSource(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
+
+[**SourceEnvelope**](SourceEnvelope.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Soft-deleted |  -  |
+| **401** | Unauthenticated |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## adminGetSourceDedupStats
+
+> DedupStats adminGetSourceDedupStats(source)
+
+Deduplication counters for a source
+
+Per-layer dedup counters (locations / groups / meetings / types). Returns aggregate totals across every ingest run for this source, plus the counters from the most recent run and the last 10 runs.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminGetSourceDedupStatsRequest } 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 AdminApi(config);
+
+  const body = {
+    // number
+    source: 56,
+  } satisfies AdminGetSourceDedupStatsRequest;
+
+  try {
+    const data = await api.adminGetSourceDedupStats(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
+
+[**DedupStats**](DedupStats.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Counters |  -  |
+| **401** | Unauthenticated |  -  |
+| **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)
+
+
+## adminListSourceRuns
+
+> Array<IngestRun> adminListSourceRuns(source, limit)
+
+Recent ingest runs for a source
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminListSourceRunsRequest } 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 AdminApi(config);
+
+  const body = {
+    // number
+    source: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies AdminListSourceRunsRequest;
+
+  try {
+    const data = await api.adminListSourceRuns(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`] |
+| **limit** | `number` |  | [Optional] [Defaults to `25`] |
+
+### Return type
+
+[**Array<IngestRun>**](IngestRun.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Runs (newest first) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## adminListSources
+
+> Array<AdminSource> adminListSources(program)
+
+Admin source list with operational metadata
+
+Returns every source (including soft-deleted). Filter by `program` to scope to one program; unknown codes return an empty array.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminListSourcesRequest } 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 AdminApi(config);
+
+  const body = {
+    // string | Program code (`AA`, `NA`, ...) (optional)
+    program: AA,
+  } satisfies AdminListSourcesRequest;
+
+  try {
+    const data = await api.adminListSources(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<AdminSource>**](AdminSource.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | All sources (including soft-deleted) |  -  |
+| **401** | Unauthenticated |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## adminPauseSource
+
+> SourceEnvelope adminPauseSource(source)
+
+Pause ingestion (manual operator action)
+
+Meetings remain visible; fetches stop. Use for known temporary upstream outages.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminPauseSourceRequest } 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 AdminApi(config);
+
+  const body = {
+    // number
+    source: 56,
+  } satisfies AdminPauseSourceRequest;
+
+  try {
+    const data = await api.adminPauseSource(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
+
+[**SourceEnvelope**](SourceEnvelope.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paused |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## adminRefreshSource
+
+> SourceRefreshResponse adminRefreshSource(source)
+
+Force-dispatch an immediate ingest job
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminRefreshSourceRequest } 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 AdminApi(config);
+
+  const body = {
+    // number
+    source: 56,
+  } satisfies AdminRefreshSourceRequest;
+
+  try {
+    const data = await api.adminRefreshSource(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
+
+[**SourceRefreshResponse**](SourceRefreshResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Queued |  -  |
+| **422** | Source is paused or deleted |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## adminRestoreSource
+
+> SourceEnvelope adminRestoreSource(source)
+
+Restore a soft-deleted source within the 30-day window
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminRestoreSourceRequest } 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 AdminApi(config);
+
+  const body = {
+    // number
+    source: 56,
+  } satisfies AdminRestoreSourceRequest;
+
+  try {
+    const data = await api.adminRestoreSource(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
+
+[**SourceEnvelope**](SourceEnvelope.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Restored |  -  |
+| **422** | Restore window expired |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## adminResumeSource
+
+> SourceEnvelope adminResumeSource(source)
+
+Resume ingestion from paused or dormant
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminResumeSourceRequest } 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 AdminApi(config);
+
+  const body = {
+    // number
+    source: 56,
+  } satisfies AdminResumeSourceRequest;
+
+  try {
+    const data = await api.adminResumeSource(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
+
+[**SourceEnvelope**](SourceEnvelope.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Resumed |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## adminUpdateSource
+
+> SourceEnvelope adminUpdateSource(source, updateSourceRequest)
+
+Update source metadata
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AdminApi,
+} from 'c4r-aggregator-client';
+import type { AdminUpdateSourceRequest } 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 AdminApi(config);
+
+  const body = {
+    // number
+    source: 56,
+    // UpdateSourceRequest (optional)
+    updateSourceRequest: ...,
+  } satisfies AdminUpdateSourceRequest;
+
+  try {
+    const data = await api.adminUpdateSource(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`] |
+| **updateSourceRequest** | [UpdateSourceRequest](UpdateSourceRequest.md) |  | [Optional] |
+
+### Return type
+
+[**SourceEnvelope**](SourceEnvelope.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated |  -  |
+| **401** | Unauthenticated |  -  |
+| **404** | 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)
+