@caraer/client 2.0.347

package/docs/RelationsApi.md

@@ -0,0 +1,627 @@
+# RelationsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addConnection**](#addconnection) | **PUT** /api/v2/relations/{relationUuid}/connection/{from}/{to} | Add a connection to a relation|
+|[**createRelationOrUpdate**](#createrelationorupdate) | **POST** /api/v2/relations/{objectUuid} | Create or update a relation|
+|[**deleteConnection**](#deleteconnection) | **DELETE** /api/v2/relations/{relationUuid}/connection/{from}/{to} | Delete a connection from a relation|
+|[**deleteRelation1**](#deleterelation1) | **DELETE** /api/v2/relations/{relationUuid} | Delete a relation|
+|[**getRelation**](#getrelation) | **GET** /api/v2/relations/{relationUuid} | Get relation details|
+|[**getRelationForObject**](#getrelationforobject) | **GET** /api/v2/relations/{relationUuid}/{objectUuid} | Get relation details for a specific object|
+|[**getRelations**](#getrelations) | **POST** /api/v2/relations/index | Fetch paginated relations|
+|[**getRelationsBetweenObjects**](#getrelationsbetweenobjects) | **POST** /api/v2/relations/index/{fromObjectUuid}/{toObjectUuid} | Get all relations between two objects|
+|[**getRelationsByObject**](#getrelationsbyobject) | **POST** /api/v2/relations/index/{objectUuid} | Fetch relations for a specific object|
+|[**restoreRelation**](#restorerelation) | **POST** /api/v2/relations/{relationUuid}/restore | Restore a deleted relation|
+|[**updateIndices**](#updateindices) | **PUT** /api/v2/relations/updateIndices | Update relation indices|
+
+# **addConnection**
+> SuccessResponse addConnection()
+
+Creates a connection between two objects for a given relation. The \'from\' and \'to\' UUIDs identify the objects to connect.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let relationUuid: string; // (default to undefined)
+let from: string; // (default to undefined)
+let to: string; // (default to undefined)
+
+const { status, data } = await apiInstance.addConnection(
+    relationUuid,
+    from,
+    to
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **relationUuid** | [**string**] |  | defaults to undefined|
+| **from** | [**string**] |  | defaults to undefined|
+| **to** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Connection created successfully |  -  |
+|**404** | One or more entities not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **createRelationOrUpdate**
+> UpdateResponse createRelationOrUpdate(relationDTO)
+
+Creates a new relation or updates an existing one for the specified object. If a relation with the same name exists, it is updated; otherwise, a new relation is created. Returns an UpdateResponse if updated or a CreateResponse if created.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration,
+    RelationDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let objectUuid: string; // (default to undefined)
+let relationDTO: RelationDTO; //Relation data
+
+const { status, data } = await apiInstance.createRelationOrUpdate(
+    objectUuid,
+    relationDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **relationDTO** | **RelationDTO**| Relation data | |
+| **objectUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**UpdateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Relation updated successfully |  -  |
+|**201** | Relation created successfully |  -  |
+|**400** | Invalid input data |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **deleteConnection**
+> SuccessResponse deleteConnection()
+
+Deletes a connection between two objects for a given relation using the specified UUIDs.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let relationUuid: string; // (default to undefined)
+let from: string; // (default to undefined)
+let to: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteConnection(
+    relationUuid,
+    from,
+    to
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **relationUuid** | [**string**] |  | defaults to undefined|
+| **from** | [**string**] |  | defaults to undefined|
+| **to** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Connection deleted successfully |  -  |
+|**404** | One or more entities not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **deleteRelation1**
+> DeleteResponse deleteRelation1()
+
+Deletes a relation specified by its UUID. Returns a DeleteResponse with the deleted relation details.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let relationUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteRelation1(
+    relationUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **relationUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeleteResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Relation deleted successfully |  -  |
+|**404** | Relation not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **getRelation**
+> ShowResponse getRelation()
+
+Retrieves the details of a relation by its UUID. Returns a ShowResponse containing a RelationDTO.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let relationUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getRelation(
+    relationUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **relationUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Relation retrieved successfully |  -  |
+|**404** | Relation not found |  -  |
+
+[[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)
+
+# **getRelationForObject**
+> ShowResponse getRelationForObject()
+
+Retrieves a relation by its UUID and associates it with the specified object, returning a RelationDTO that includes details from the related object.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let relationUuid: string; // (default to undefined)
+let objectUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getRelationForObject(
+    relationUuid,
+    objectUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **relationUuid** | [**string**] |  | defaults to undefined|
+| **objectUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Relation for object retrieved successfully |  -  |
+|**404** | Relation or object not found |  -  |
+
+[[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)
+
+# **getRelations**
+> PaginationResponse getRelations(body)
+
+Retrieves a paginated list of relations. Returns a PaginationResponse containing RelationDTO objects based on the provided pagination criteria.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let body: any; //Pagination request for relations
+
+const { status, data } = await apiInstance.getRelations(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**| Pagination request for relations | |
+
+
+### Return type
+
+**PaginationResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Relations fetched successfully |  -  |
+|**400** | Invalid pagination request |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **getRelationsBetweenObjects**
+> PaginationResponse getRelationsBetweenObjects(body)
+
+Retrieves all relations between two objects based on the provided object UUIDs.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let fromObjectUuid: string; // (default to undefined)
+let toObjectUuid: string; // (default to undefined)
+let body: any; //
+
+const { status, data } = await apiInstance.getRelationsBetweenObjects(
+    fromObjectUuid,
+    toObjectUuid,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**|  | |
+| **fromObjectUuid** | [**string**] |  | defaults to undefined|
+| **toObjectUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PaginationResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Relations retrieved successfully |  -  |
+|**404** | One or more objects not found |  -  |
+
+[[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)
+
+# **getRelationsByObject**
+> PaginationResponse getRelationsByObject(body)
+
+Returns relation definitions where this object participates in the **schema** graph for that relation name: either as origin `(thisObject)-[:relationName]->(:Object)` or as target `(:Object)-[:relationName]->(thisObject)`. Unrelated relations (same name elsewhere, or no typed edge touching this object) are excluded. Uses the object’s `name` to filter; request path uses object UUID.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let objectUuid: string; // (default to undefined)
+let body: any; //Pagination request for relations
+
+const { status, data } = await apiInstance.getRelationsByObject(
+    objectUuid,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**| Pagination request for relations | |
+| **objectUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PaginationResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Relations fetched successfully |  -  |
+|**404** | Object not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **restoreRelation**
+> RestoreResponse restoreRelation()
+
+Restores a previously deleted relation by its UUID. Returns a RestoreResponse with the restored relation details.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let relationUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.restoreRelation(
+    relationUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **relationUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RestoreResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Relation restored successfully |  -  |
+|**404** | Relation not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **updateIndices**
+> SuccessResponse updateIndices(body)
+
+Updates the indices for relations. The request body should contain a mapping of relation UUIDs to their new index values. Returns a SuccessResponse containing the updated relation objects.
+
+### Example
+
+```typescript
+import {
+    RelationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RelationsApi(configuration);
+
+let body: string; //Mapping of relation UUIDs to new index values
+
+const { status, data } = await apiInstance.updateIndices(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**| Mapping of relation UUIDs to new index values | |
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Indices updated successfully |  -  |
+|**400** | Invalid input provided |  -  |
+|**500** | Internal server error |  -  |
+
+[[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/ResetPasswordRequest.md

@@ -0,0 +1,24 @@
+# ResetPasswordRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ResetPasswordRequest } from '@caraer/client';
+
+const instance: ResetPasswordRequest = {
+    email,
+    token,
+    password,
+};
+```
+
+[[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/RestoreResponse.md

@@ -0,0 +1,23 @@
+# RestoreResponse
+
+Represents the response returned when a restore operation is performed successfully.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | **any** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RestoreResponse } from '@caraer/client';
+
+const instance: RestoreResponse = {
+    message,
+    data,
+};
+```
+
+[[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/RestoreResponseCaraerObjectDTO.md

@@ -0,0 +1,23 @@
+# RestoreResponseCaraerObjectDTO
+
+Represents the response returned when a restore operation is performed successfully.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RestoreResponseCaraerObjectDTO } from '@caraer/client';
+
+const instance: RestoreResponseCaraerObjectDTO = {
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)