eiagov-typescript-fetch-client 1.0.0

package/docs/Facet.md

@@ -0,0 +1,38 @@
+
+# Facet
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`alias` | string
+
+## Example
+
+```typescript
+import type { Facet } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "alias": null,
+} satisfies Facet
+
+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 Facet
+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/FacetDetails.md

@@ -0,0 +1,36 @@
+
+# FacetDetails
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalFacets` | number
+`facets` | [Array<Facet>](Facet.md)
+
+## Example
+
+```typescript
+import type { FacetDetails } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalFacets": null,
+  "facets": null,
+} satisfies FacetDetails
+
+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 FacetDetails
+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/FacetDetailsContainer.md

@@ -0,0 +1,38 @@
+
+# FacetDetailsContainer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`apiVersion` | string
+`request` | [RouteRequest](RouteRequest.md)
+`response` | [FacetDetails](FacetDetails.md)
+
+## Example
+
+```typescript
+import type { FacetDetailsContainer } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "apiVersion": null,
+  "request": null,
+  "response": null,
+} satisfies FacetDetailsContainer
+
+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 FacetDetailsContainer
+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/FacetMetaData.md

@@ -0,0 +1,36 @@
+
+# FacetMetaData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { FacetMetaData } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "description": null,
+} satisfies FacetMetaData
+
+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 FacetMetaData
+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/FacetOptionList.md

@@ -0,0 +1,36 @@
+
+# FacetOptionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalFacetOptions` | number
+`facetOptions` | Array<string>
+
+## Example
+
+```typescript
+import type { FacetOptionList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalFacetOptions": null,
+  "facetOptions": null,
+} satisfies FacetOptionList
+
+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 FacetOptionList
+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/FacetOptionListContainer.md

@@ -0,0 +1,38 @@
+
+# FacetOptionListContainer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`apiVersion` | string
+`request` | [RouteRequest](RouteRequest.md)
+`response` | [FacetOptionList](FacetOptionList.md)
+
+## Example
+
+```typescript
+import type { FacetOptionListContainer } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "apiVersion": null,
+  "request": null,
+  "response": null,
+} satisfies FacetOptionListContainer
+
+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 FacetOptionListContainer
+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/FinalRoute.md

@@ -0,0 +1,52 @@
+
+# FinalRoute
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`frequency` | [Array<Frequency>](Frequency.md)
+`facets` | [Array<FacetMetaData>](FacetMetaData.md)
+`data` | any
+`startPeriod` | string
+`endPeriod` | string
+`defaultDateFormat` | string
+`defaultFrequency` | string
+
+## Example
+
+```typescript
+import type { FinalRoute } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "frequency": null,
+  "facets": null,
+  "data": null,
+  "startPeriod": null,
+  "endPeriod": null,
+  "defaultDateFormat": null,
+  "defaultFrequency": null,
+} satisfies FinalRoute
+
+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 FinalRoute
+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/FinalRouteResponse.md

@@ -0,0 +1,36 @@
+
+# FinalRouteResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`response` | [FinalRoute](FinalRoute.md)
+`request` | [RouteRequest](RouteRequest.md)
+
+## Example
+
+```typescript
+import type { FinalRouteResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "response": null,
+  "request": null,
+} satisfies FinalRouteResponse
+
+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 FinalRouteResponse
+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/FinalRouteResponseContainer.md

@@ -0,0 +1,38 @@
+
+# FinalRouteResponseContainer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`apiVersion` | string
+`request` | [RouteRequest](RouteRequest.md)
+`response` | [FinalRouteResponse](FinalRouteResponse.md)
+
+## Example
+
+```typescript
+import type { FinalRouteResponseContainer } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "apiVersion": null,
+  "request": null,
+  "response": null,
+} satisfies FinalRouteResponseContainer
+
+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 FinalRouteResponseContainer
+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/Frequency.md

@@ -0,0 +1,40 @@
+
+# Frequency
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`description` | string
+`format` | string
+`query` | string
+
+## Example
+
+```typescript
+import type { Frequency } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "description": null,
+  "format": null,
+  "query": null,
+} satisfies Frequency
+
+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 Frequency
+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)
+
+