c4r-aggregator-client 1.0.0

package/docs/IngestRun.md

@@ -0,0 +1,57 @@
+
+# IngestRun
+
+A single fetch attempt against a source
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`sourceId` | number
+`startedAt` | Date
+`finishedAt` | Date
+`status` | string
+`wasSuspicious` | boolean
+`errorType` | string
+`errorMessage` | string
+`seen` | number
+`created` | number
+`updated` | number
+`removed` | number
+
+## Example
+
+```typescript
+import type { IngestRun } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "sourceId": null,
+  "startedAt": null,
+  "finishedAt": null,
+  "status": null,
+  "wasSuspicious": null,
+  "errorType": null,
+  "errorMessage": null,
+  "seen": null,
+  "created": null,
+  "updated": null,
+  "removed": null,
+} satisfies IngestRun
+
+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 IngestRun
+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/MapFeature.md

@@ -0,0 +1,39 @@
+
+# MapFeature
+
+GeoJSON Feature: one per geocoded location with the list of active meetings at that location.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`geometry` | [MapFeatureGeometry](MapFeatureGeometry.md)
+`properties` | [MapFeatureProperties](MapFeatureProperties.md)
+
+## Example
+
+```typescript
+import type { MapFeature } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": Feature,
+  "geometry": null,
+  "properties": null,
+} satisfies MapFeature
+
+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 MapFeature
+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/MapFeatureCollection.md

@@ -0,0 +1,39 @@
+
+# MapFeatureCollection
+
+GeoJSON FeatureCollection of all geocoded locations with at least one active meeting. Cached 5 minutes.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`generatedAt` | Date
+`features` | [Array<MapFeature>](MapFeature.md)
+
+## Example
+
+```typescript
+import type { MapFeatureCollection } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": FeatureCollection,
+  "generatedAt": null,
+  "features": null,
+} satisfies MapFeatureCollection
+
+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 MapFeatureCollection
+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/MapFeatureGeometry.md

@@ -0,0 +1,37 @@
+
+# MapFeatureGeometry
+
+GeoJSON point geometry for a MapFeature.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`coordinates` | Array<number>
+
+## Example
+
+```typescript
+import type { MapFeatureGeometry } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": Point,
+  "coordinates": null,
+} satisfies MapFeatureGeometry
+
+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 MapFeatureGeometry
+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/MapFeatureProperties.md

@@ -0,0 +1,47 @@
+
+# MapFeatureProperties
+
+Per-location properties on a MapFeature — name/city/state plus the list of active meetings there.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`city` | string
+`state` | string
+`meetingCount` | number
+`programs` | Array<string>
+`meetings` | [Array<MapMeeting>](MapMeeting.md)
+
+## Example
+
+```typescript
+import type { MapFeatureProperties } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "city": null,
+  "state": null,
+  "meetingCount": null,
+  "programs": ["AA","NA"],
+  "meetings": null,
+} satisfies MapFeatureProperties
+
+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 MapFeatureProperties
+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/MapMeeting.md

@@ -0,0 +1,41 @@
+
+# MapMeeting
+
+Minimal meeting shape embedded in a MapFeature.properties.meetings array.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`day` | number
+`time` | string
+`program` | string
+
+## Example
+
+```typescript
+import type { MapMeeting } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "day": null,
+  "time": 19:30,
+  "program": AA,
+} satisfies MapMeeting
+
+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 MapMeeting
+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/Meeting.md

@@ -0,0 +1,109 @@
+
+# Meeting
+
+Meeting Guide API-compliant meeting row. Location and group fields are denormalized for drop-in client compatibility. Adds non-spec `data_freshness_days`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`slug` | string
+`day` | number
+`time` | string
+`endTime` | string
+`timeFormatted` | string
+`updated` | Date
+`types` | Array<string>
+`notes` | string
+`approximate` | string
+`attendanceOption` | string
+`conferenceUrl` | string
+`conferenceUrlNotes` | string
+`conferencePhone` | string
+`conferencePhoneNotes` | string
+`location` | string
+`locationNotes` | string
+`formattedAddress` | string
+`address` | string
+`city` | string
+`state` | string
+`postalCode` | string
+`country` | string
+`latitude` | number
+`longitude` | number
+`timezone` | string
+`region` | string
+`group` | string
+`district` | string
+`subDistrict` | string
+`website` | string
+`email` | string
+`phone` | string
+`venmo` | string
+`paypal` | string
+`square` | string
+`dataFreshnessDays` | number
+
+## Example
+
+```typescript
+import type { Meeting } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": Pre-Nooners,
+  "slug": pre-nooners,
+  "day": null,
+  "time": 07:30:00,
+  "endTime": null,
+  "timeFormatted": 7:30 am,
+  "updated": null,
+  "types": ["O","ONL"],
+  "notes": null,
+  "approximate": null,
+  "attendanceOption": null,
+  "conferenceUrl": null,
+  "conferenceUrlNotes": null,
+  "conferencePhone": null,
+  "conferencePhoneNotes": null,
+  "location": null,
+  "locationNotes": null,
+  "formattedAddress": null,
+  "address": null,
+  "city": null,
+  "state": null,
+  "postalCode": null,
+  "country": null,
+  "latitude": null,
+  "longitude": null,
+  "timezone": America/New_York,
+  "region": null,
+  "group": null,
+  "district": null,
+  "subDistrict": null,
+  "website": null,
+  "email": null,
+  "phone": null,
+  "venmo": null,
+  "paypal": null,
+  "square": null,
+  "dataFreshnessDays": null,
+} satisfies Meeting
+
+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 Meeting
+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/MeetingPage.md

@@ -0,0 +1,39 @@
+
+# MeetingPage
+
+Cursor-paginated envelope returned by `GET /meetings`
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<Meeting>](Meeting.md)
+`links` | [MeetingPageLinks](MeetingPageLinks.md)
+`meta` | [MeetingPageMeta](MeetingPageMeta.md)
+
+## Example
+
+```typescript
+import type { MeetingPage } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "links": null,
+  "meta": null,
+} satisfies MeetingPage
+
+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 MeetingPage
+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/MeetingPageLinks.md

@@ -0,0 +1,41 @@
+
+# MeetingPageLinks
+
+Pagination cursor links for MeetingPage.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`first` | string
+`last` | string
+`prev` | string
+`next` | string
+
+## Example
+
+```typescript
+import type { MeetingPageLinks } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "first": null,
+  "last": null,
+  "prev": null,
+  "next": null,
+} satisfies MeetingPageLinks
+
+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 MeetingPageLinks
+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/MeetingPageMeta.md

@@ -0,0 +1,41 @@
+
+# MeetingPageMeta
+
+Pagination metadata for MeetingPage.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+`perPage` | number
+`nextCursor` | string
+`prevCursor` | string
+
+## Example
+
+```typescript
+import type { MeetingPageMeta } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "perPage": null,
+  "nextCursor": null,
+  "prevCursor": null,
+} satisfies MeetingPageMeta
+
+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 MeetingPageMeta
+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/MeetingType.md

@@ -0,0 +1,42 @@
+
+# MeetingType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`programId` | number
+`code` | string
+`name` | string
+`autoDiscovered` | boolean
+
+## Example
+
+```typescript
+import type { MeetingType } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "programId": null,
+  "code": O,
+  "name": Open,
+  "autoDiscovered": null,
+} satisfies MeetingType
+
+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 MeetingType
+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)
+
+