@griffin-app/griffin-hub-sdk 1.0.0

package/docs/AgentsApi.md

@@ -0,0 +1,265 @@
+# AgentsApi
+
+All URIs are relative to *http://localhost:3000*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**agentsGet**](#agentsget) | **GET** /agents/ | |
+|[**agentsIdDelete**](#agentsiddelete) | **DELETE** /agents/{id} | |
+|[**agentsIdHeartbeatPost**](#agentsidheartbeatpost) | **POST** /agents/{id}/heartbeat | |
+|[**agentsLocationsGet**](#agentslocationsget) | **GET** /agents/locations | |
+|[**agentsRegisterPost**](#agentsregisterpost) | **POST** /agents/register | |
+
+# **agentsGet**
+> AgentsGet200Response agentsGet()
+
+List all agents with optional filtering
+
+### Example
+
+```typescript
+import {
+    AgentsApi,
+    Configuration
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgentsApi(configuration);
+
+let location: string; //Filter by location (optional) (default to undefined)
+let status: 'online' | 'offline'; //Filter by status (optional) (default to undefined)
+
+const { status, data } = await apiInstance.agentsGet(
+    location,
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **location** | [**string**] | Filter by location | (optional) defaults to undefined|
+| **status** | [**&#39;online&#39; | &#39;offline&#39;**]**Array<&#39;online&#39; &#124; &#39;offline&#39;>** | Filter by status | (optional) defaults to undefined|
+
+
+### Return type
+
+**AgentsGet200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **agentsIdDelete**
+> AgentsIdHeartbeatPost200Response agentsIdDelete()
+
+Deregister an agent
+
+### Example
+
+```typescript
+import {
+    AgentsApi,
+    Configuration
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgentsApi(configuration);
+
+let id: string; //Agent ID (default to undefined)
+
+const { status, data } = await apiInstance.agentsIdDelete(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Agent ID | defaults to undefined|
+
+
+### Return type
+
+**AgentsIdHeartbeatPost200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **agentsIdHeartbeatPost**
+> AgentsIdHeartbeatPost200Response agentsIdHeartbeatPost()
+
+Record a heartbeat from an agent
+
+### Example
+
+```typescript
+import {
+    AgentsApi,
+    Configuration
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgentsApi(configuration);
+
+let id: string; //Agent ID (default to undefined)
+
+const { status, data } = await apiInstance.agentsIdHeartbeatPost(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Agent ID | defaults to undefined|
+
+
+### Return type
+
+**AgentsIdHeartbeatPost200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Default Response |  -  |
+|**404** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **agentsLocationsGet**
+> AgentsLocationsGet200Response agentsLocationsGet()
+
+Get all registered locations (with at least one online agent)
+
+### Example
+
+```typescript
+import {
+    AgentsApi,
+    Configuration
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgentsApi(configuration);
+
+const { status, data } = await apiInstance.agentsLocationsGet();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AgentsLocationsGet200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **agentsRegisterPost**
+> AgentsRegisterPost200Response agentsRegisterPost(agentsRegisterPostRequest)
+
+Register a new agent with the hub
+
+### Example
+
+```typescript
+import {
+    AgentsApi,
+    Configuration,
+    AgentsRegisterPostRequest
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgentsApi(configuration);
+
+let agentsRegisterPostRequest: AgentsRegisterPostRequest; //
+
+const { status, data } = await apiInstance.agentsRegisterPost(
+    agentsRegisterPostRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **agentsRegisterPostRequest** | **AgentsRegisterPostRequest**|  | |
+
+
+### Return type
+
+**AgentsRegisterPost200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/AgentsGet200Response.md

@@ -0,0 +1,22 @@
+# AgentsGet200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<AgentsGet200ResponseDataInner>**](AgentsGet200ResponseDataInner.md) |  | [default to undefined]
+**total** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AgentsGet200Response } from 'griffin-hub-sdk';
+
+const instance: AgentsGet200Response = {
+    data,
+    total,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AgentsGet200ResponseDataInner.md

@@ -0,0 +1,30 @@
+# AgentsGet200ResponseDataInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**location** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**lastHeartbeat** | **string** |  | [default to undefined]
+**registeredAt** | **string** |  | [default to undefined]
+**metadata** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgentsGet200ResponseDataInner } from 'griffin-hub-sdk';
+
+const instance: AgentsGet200ResponseDataInner = {
+    id,
+    location,
+    status,
+    lastHeartbeat,
+    registeredAt,
+    metadata,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AgentsIdHeartbeatPost200Response.md

@@ -0,0 +1,20 @@
+# AgentsIdHeartbeatPost200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AgentsIdHeartbeatPost200Response } from 'griffin-hub-sdk';
+
+const instance: AgentsIdHeartbeatPost200Response = {
+    success,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AgentsIdHeartbeatPost404Response.md

@@ -0,0 +1,20 @@
+# AgentsIdHeartbeatPost404Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AgentsIdHeartbeatPost404Response } from 'griffin-hub-sdk';
+
+const instance: AgentsIdHeartbeatPost404Response = {
+    error,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AgentsLocationsGet200Response.md

@@ -0,0 +1,20 @@
+# AgentsLocationsGet200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locations** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AgentsLocationsGet200Response } from 'griffin-hub-sdk';
+
+const instance: AgentsLocationsGet200Response = {
+    locations,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AgentsRegisterPost200Response.md

@@ -0,0 +1,30 @@
+# AgentsRegisterPost200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**location** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**lastHeartbeat** | **string** |  | [default to undefined]
+**registeredAt** | **string** |  | [default to undefined]
+**metadata** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgentsRegisterPost200Response } from 'griffin-hub-sdk';
+
+const instance: AgentsRegisterPost200Response = {
+    id,
+    location,
+    status,
+    lastHeartbeat,
+    registeredAt,
+    metadata,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AgentsRegisterPostRequest.md

@@ -0,0 +1,22 @@
+# AgentsRegisterPostRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location** | **string** |  | [default to undefined]
+**metadata** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgentsRegisterPostRequest } from 'griffin-hub-sdk';
+
+const instance: AgentsRegisterPostRequest = {
+    location,
+    metadata,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Assertion.md

@@ -0,0 +1,30 @@
+# Assertion
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assertionType** | **string** |  | [default to undefined]
+**nodeId** | **string** |  | [default to undefined]
+**accessor** | **string** |  | [default to undefined]
+**path** | **string** |  | [default to undefined]
+**predicate** | [**JSONAssertion1Predicate**](JSONAssertion1Predicate.md) |  | [default to undefined]
+**expected** | **any** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Assertion } from 'griffin-hub-sdk';
+
+const instance: Assertion = {
+    assertionType,
+    nodeId,
+    accessor,
+    path,
+    predicate,
+    expected,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Assertion1.md

@@ -0,0 +1,30 @@
+# Assertion1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assertionType** | **string** |  | [default to undefined]
+**nodeId** | **string** |  | [default to undefined]
+**accessor** | **string** |  | [default to undefined]
+**path** | **string** |  | [default to undefined]
+**predicate** | [**JSONAssertion1Predicate**](JSONAssertion1Predicate.md) |  | [default to undefined]
+**expected** | **any** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Assertion1 } from 'griffin-hub-sdk';
+
+const instance: Assertion1 = {
+    assertionType,
+    nodeId,
+    accessor,
+    path,
+    predicate,
+    expected,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Assertion1AnyOf.md

@@ -0,0 +1,28 @@
+# Assertion1AnyOf
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assertionType** | **string** |  | [default to undefined]
+**nodeId** | **string** |  | [default to undefined]
+**accessor** | **string** |  | [default to undefined]
+**path** | **Array<string>** |  | [default to undefined]
+**predicate** | [**JSONAssertion1Predicate**](JSONAssertion1Predicate.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Assertion1AnyOf } from 'griffin-hub-sdk';
+
+const instance: Assertion1AnyOf = {
+    assertionType,
+    nodeId,
+    accessor,
+    path,
+    predicate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Assertion1AnyOf1.md

@@ -0,0 +1,24 @@
+# Assertion1AnyOf1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assertionType** | **string** |  | [default to undefined]
+**path** | **Array<string>** |  | [default to undefined]
+**expected** | **any** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Assertion1AnyOf1 } from 'griffin-hub-sdk';
+
+const instance: Assertion1AnyOf1 = {
+    assertionType,
+    path,
+    expected,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Assertion1AnyOf2.md

@@ -0,0 +1,24 @@
+# Assertion1AnyOf2
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assertionType** | **string** |  | [default to undefined]
+**path** | **string** |  | [default to undefined]
+**expected** | **any** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Assertion1AnyOf2 } from 'griffin-hub-sdk';
+
+const instance: Assertion1AnyOf2 = {
+    assertionType,
+    path,
+    expected,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Assertions.md

@@ -0,0 +1,24 @@
+# Assertions
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**assertions** | [**Array<Assertion1>**](Assertion1.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Assertions } from 'griffin-hub-sdk';
+
+const instance: Assertions = {
+    id,
+    type,
+    assertions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Assertions1.md

@@ -0,0 +1,24 @@
+# Assertions1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**assertions** | [**Array<Assertion1>**](Assertion1.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Assertions1 } from 'griffin-hub-sdk';
+
+const instance: Assertions1 = {
+    id,
+    type,
+    assertions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BinaryPredicate.md

@@ -0,0 +1,22 @@
+# BinaryPredicate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expected** | **any** |  | [default to undefined]
+**operator** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BinaryPredicate } from 'griffin-hub-sdk';
+
+const instance: BinaryPredicate = {
+    expected,
+    operator,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BinaryPredicate1.md

@@ -0,0 +1,22 @@
+# BinaryPredicate1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expected** | **any** |  | [default to undefined]
+**operator** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BinaryPredicate1 } from 'griffin-hub-sdk';
+
+const instance: BinaryPredicate1 = {
+    expected,
+    operator,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)