c4r-aggregator-client 1.0.0

package/docs/StatsLocations.md

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

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

@@ -0,0 +1,45 @@
+
+# StatsMeetings
+
+Meeting-count breakdowns in Stats.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`active` | number
+`inactive` | number
+`byProgram` | { [key: string]: number; }
+`byAttendanceOption` | { [key: string]: number; }
+`byDay` | { [key: string]: number; }
+
+## Example
+
+```typescript
+import type { StatsMeetings } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+  "active": null,
+  "inactive": null,
+  "byProgram": {"AA":54321},
+  "byAttendanceOption": {"in_person":30000,"hybrid":15000,"online":8001,"inactive":1320},
+  "byDay": null,
+} satisfies StatsMeetings
+
+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 StatsMeetings
+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/StatsProgramsBreakdownInner.md

@@ -0,0 +1,45 @@
+
+# StatsProgramsBreakdownInner
+
+Per-program counts. When `?program=` filters the response, the breakdown is scoped to that program; otherwise it lists every registered program.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`name` | string
+`meetingsTotal` | number
+`meetingsActive` | number
+`sourcesTotal` | number
+`sourcesActive` | number
+
+## Example
+
+```typescript
+import type { StatsProgramsBreakdownInner } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": AA,
+  "name": Alcoholics Anonymous,
+  "meetingsTotal": null,
+  "meetingsActive": null,
+  "sourcesTotal": null,
+  "sourcesActive": null,
+} satisfies StatsProgramsBreakdownInner
+
+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 StatsProgramsBreakdownInner
+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/StatsSources.md

@@ -0,0 +1,39 @@
+
+# StatsSources
+
+Source-count breakdowns in Stats.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`byState` | { [key: string]: number; }
+`topByMeetingCount` | [Array<StatsSourcesTopByMeetingCountInner>](StatsSourcesTopByMeetingCountInner.md)
+
+## Example
+
+```typescript
+import type { StatsSources } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+  "byState": {"active":90,"degraded":4,"dormant":2},
+  "topByMeetingCount": null,
+} satisfies StatsSources
+
+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 StatsSources
+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/StatsSourcesTopByMeetingCountInner.md

@@ -0,0 +1,39 @@
+
+# StatsSourcesTopByMeetingCountInner
+
+Entry in Stats.sources.top_by_meeting_count[].
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`meetingCount` | number
+
+## Example
+
+```typescript
+import type { StatsSourcesTopByMeetingCountInner } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "meetingCount": null,
+} satisfies StatsSourcesTopByMeetingCountInner
+
+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 StatsSourcesTopByMeetingCountInner
+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/StoreSourceValidationError.md

@@ -0,0 +1,41 @@
+
+# StoreSourceValidationError
+
+Either a feed-validation error (upstream unreachable / wrong shape) or a standard request-validation error.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`errorType` | string
+`message` | string
+`errors` | { [key: string]: Array<string>; }
+
+## Example
+
+```typescript
+import type { StoreSourceValidationError } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": invalid_feed,
+  "errorType": null,
+  "message": null,
+  "errors": null,
+} satisfies StoreSourceValidationError
+
+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 StoreSourceValidationError
+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/UpdateSourceRequest.md

@@ -0,0 +1,44 @@
+
+# UpdateSourceRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`feedUrl` | string
+`feedKind` | string
+`sharingKey` | string
+`fetchIntervalMinutes` | number
+`notificationWebhookUrl` | string
+
+## Example
+
+```typescript
+import type { UpdateSourceRequest } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "feedUrl": null,
+  "feedKind": null,
+  "sharingKey": null,
+  "fetchIntervalMinutes": null,
+  "notificationWebhookUrl": null,
+} satisfies UpdateSourceRequest
+
+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 UpdateSourceRequest
+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/ValidationError.md

@@ -0,0 +1,36 @@
+
+# ValidationError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`errors` | { [key: string]: Array<string>; }
+
+## Example
+
+```typescript
+import type { ValidationError } from 'c4r-aggregator-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "errors": null,
+} satisfies ValidationError
+
+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 ValidationError
+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/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "c4r-aggregator-client",
+  "version": "1.0.0",
+  "description": "OpenAPI client for c4r-aggregator-client",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pjaudiomv/c4r-aggregator.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  }
+}