@caraer/client 2.0.347

package/docs/AutomationsApi.md

@@ -0,0 +1,54 @@
+# AutomationsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getToken**](#gettoken) | **GET** /api/v2/automations/token | Get Latenode JWT token for current user|
+
+# **getToken**
+> string getToken()
+
+Generates a short-lived Latenode JWT token for the authenticated user, to be used with the Latenode embedded SDK.
+
+### Example
+
+```typescript
+import {
+    AutomationsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AutomationsApi(configuration);
+
+const { status, data } = await apiInstance.getToken();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully generated token |  -  |
+|**401** | Unauthorized access |  -  |
+|**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/BillingSettingsDTO.md

@@ -0,0 +1,51 @@
+# BillingSettingsDTO
+
+The billing settings of the company.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** | The name of the entity | [default to undefined]
+**label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
+**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
+**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
+**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
+**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
+**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
+**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
+**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
+**billingEmail** | **string** | The email address of the billing contact. | [optional] [default to undefined]
+**address** | **string** | The address of the billing contact. | [optional] [default to undefined]
+**city** | **string** | The city of the billing contact. | [optional] [default to undefined]
+**state** | **string** | The state of the billing contact. | [optional] [default to undefined]
+**zip** | **string** | The zip code of the billing contact. | [optional] [default to undefined]
+**country** | **string** | The country of the billing contact. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BillingSettingsDTO } from '@caraer/client';
+
+const instance: BillingSettingsDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    billingEmail,
+    address,
+    city,
+    state,
+    zip,
+    country,
+};
+```
+
+[[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/CaraerErrorType.md

@@ -0,0 +1,24 @@
+# CaraerErrorType
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | The error message providing details about the failure. | [default to undefined]
+**type** | **string** | The type of error. | [default to undefined]
+**correctionSuggestion** | **string** | A suggestion on how to correct the error. | [default to undefined]
+
+## Example
+
+```typescript
+import { CaraerErrorType } from '@caraer/client';
+
+const instance: CaraerErrorType = {
+    message,
+    type,
+    correctionSuggestion,
+};
+```
+
+[[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/CaraerObjectDTO.md

@@ -0,0 +1,65 @@
+# CaraerObjectDTO
+
+Data transfer object representing a Caraer object with its configuration, properties, relations, and views
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** | Unique identifier name for the object | [optional] [default to undefined]
+**label** | **string** | Display label for the object | [optional] [default to undefined]
+**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
+**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
+**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
+**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
+**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
+**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
+**index** | **number** | Index number for ordering objects | [optional] [default to undefined]
+**plural** | **string** | Plural form of the object\'s name, used for display purposes | [optional] [default to undefined]
+**description** | **string** | Detailed description of the object\'s purpose and usage | [optional] [default to undefined]
+**groups** | **Array<string>** | Collection of group names this object belongs to | [optional] [default to undefined]
+**icon** | **string** | Icon identifier for visual representation of the object | [optional] [default to undefined]
+**showInMenu** | **boolean** | Indicates if this object should be displayed in navigation menus | [optional] [default to undefined]
+**defaultTrait** | **string** | Name of the default trait applied to this object | [optional] [default to undefined]
+**traits** | **Array<string>** | List of trait names associated with this object | [optional] [default to undefined]
+**views** | [**Array<ViewDTO>**](ViewDTO.md) | List of view configurations for displaying this object | [optional] [default to undefined]
+**properties** | [**Array<PropertyDTO>**](PropertyDTO.md) | List of properties defined for this object | [optional] [default to undefined]
+**relations** | [**Array<RelationDTO>**](RelationDTO.md) | List of relations this object has with other objects | [optional] [default to undefined]
+**suites** | **Array<string>** | List of suite names this object belongs to | [optional] [default to undefined]
+**extendsTo** | [**Array<CaraerObjectDTO>**](CaraerObjectDTO.md) | List of objects this object extends to | [optional] [default to undefined]
+**editable** | **boolean** | When false, the object schema cannot be updated or deleted via the API | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CaraerObjectDTO } from '@caraer/client';
+
+const instance: CaraerObjectDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    plural,
+    description,
+    groups,
+    icon,
+    showInMenu,
+    defaultTrait,
+    traits,
+    views,
+    properties,
+    relations,
+    suites,
+    extendsTo,
+    editable,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)