@caraer/client 2.0.347

package/docs/RestoreResponseSavedFilterDTO.md

@@ -0,0 +1,23 @@
+# RestoreResponseSavedFilterDTO
+
+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** | [**SavedFilterDTO**](SavedFilterDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RestoreResponseSavedFilterDTO } from '@caraer/client';
+
+const instance: RestoreResponseSavedFilterDTO = {
+    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/RestoreResponseTeamDTO.md

@@ -0,0 +1,23 @@
+# RestoreResponseTeamDTO
+
+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** | [**TeamDTO**](TeamDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RestoreResponseTeamDTO } from '@caraer/client';
+
+const instance: RestoreResponseTeamDTO = {
+    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/RestoreResponseViewDTO.md

@@ -0,0 +1,23 @@
+# RestoreResponseViewDTO
+
+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** | [**ViewDTO**](ViewDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RestoreResponseViewDTO } from '@caraer/client';
+
+const instance: RestoreResponseViewDTO = {
+    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/ReviewRequest.md

@@ -0,0 +1,25 @@
+# ReviewRequest
+
+Review request with feedback, reviewer notes, and publish state
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**feedback** | **string** | Feedback shown to the developer. | [optional] [default to undefined]
+**reviewerNotes** | **string** | Internal notes for reviewers (not shown to the developer). | [optional] [default to undefined]
+**publishState** | **string** | Publish state after review: APPROVED, REJECTED, CHANGES_REQUESTED. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReviewRequest } from '@caraer/client';
+
+const instance: ReviewRequest = {
+    feedback,
+    reviewerNotes,
+    publishState,
+};
+```
+
+[[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/SavePropertyDTO.md

@@ -0,0 +1,71 @@
+# SavePropertyDTO
+
+DTO representing a property to be saved
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** | The internal name of the property | [optional] [default to undefined]
+**label** | **string** | The display label of the property | [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]
+**description** | **string** | A brief description of the property | [optional] [default to undefined]
+**type** | **string** | The data type of the property | [optional] [default to undefined]
+**_options** | [**Array<PropertyOption>**](PropertyOption.md) | List of available options for the property | [optional] [default to undefined]
+**group** | **string** | The group to which this property belongs | [optional] [default to undefined]
+**format** | **string** | Property format type | [optional] [default to undefined]
+**rules** | **Array<string>** | Collection of rules applied to the property | [optional] [default to undefined]
+**hidden** | **boolean** | Indicates if the property is hidden by default | [optional] [default to undefined]
+**lifecycleActive** | **boolean** | When true, property value changes are tracked as lifecycle records | [optional] [default to undefined]
+**nonPublic** | **boolean** | Indicates if the property is not accessible publicly | [optional] [default to undefined]
+**indexed** | **boolean** | Indicates if the property is indexed | [optional] [default to undefined]
+**formatSettings** | **{ [key: string]: any | null; }** | Settings to configure the format of the property | [optional] [default to undefined]
+**immutable** | **boolean** | Indicates if the property is immutable | [optional] [default to undefined]
+**editable** | **boolean** | Indicates if the property can be edited | [optional] [default to undefined]
+**icon** | **string** | The icon associated with the property | [optional] [default to undefined]
+**webpagePublic** | **boolean** | Indicates if the property is webpage public | [optional] [default to undefined]
+**embeddable** | **boolean** | Indicates if the property is embeddable | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SavePropertyDTO } from '@caraer/client';
+
+const instance: SavePropertyDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    description,
+    type,
+    _options,
+    group,
+    format,
+    rules,
+    hidden,
+    lifecycleActive,
+    nonPublic,
+    indexed,
+    formatSettings,
+    immutable,
+    editable,
+    icon,
+    webpagePublic,
+    embeddable,
+};
+```
+
+[[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/SavedFilterDTO.md

@@ -0,0 +1,45 @@
+# SavedFilterDTO
+
+Data transfer object representing a saved filter configuration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** | The name identifier of the saved filter | [default to undefined]
+**label** | **string** | Display label for the saved filter | [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]
+**description** | **string** | Description of what this saved filter is used for | [optional] [default to undefined]
+**mainObject** | **string** | The main object for the saved filter | [optional] [default to undefined]
+**filter** | [**Filter**](Filter.md) | The filter definition used when querying records | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SavedFilterDTO } from '@caraer/client';
+
+const instance: SavedFilterDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    description,
+    mainObject,
+    filter,
+};
+```
+
+[[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/SendNotificationRequest.md

@@ -0,0 +1,35 @@
+# SendNotificationRequest
+
+Request body for sending an in-app notification to a user
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**targetUserUuid** | **string** | UUID of the user who should receive the notification | [default to undefined]
+**title** | **string** | Notification title | [default to undefined]
+**body** | **string** | Notification body (supports Markdown for links) | [default to undefined]
+**type** | **string** | Notification type identifier | [optional] [default to undefined]
+**icon** | **string** | Optional icon identifier | [optional] [default to undefined]
+**action** | **string** | Optional structured action identifier | [optional] [default to undefined]
+**actionTitle** | **string** | Optional label for the action button | [optional] [default to undefined]
+**data** | **{ [key: string]: any | null; }** | Optional action payload | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SendNotificationRequest } from '@caraer/client';
+
+const instance: SendNotificationRequest = {
+    targetUserUuid,
+    title,
+    body,
+    type,
+    icon,
+    action,
+    actionTitle,
+    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/ServerlessFunctionDTO.md

@@ -0,0 +1,45 @@
+# ServerlessFunctionDTO
+
+Data transfer object for a serverless function (runtime and code) owned by an app
+
+## 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]
+**runtime** | **string** | Runtime identifier (e.g. javascript, python) | [optional] [default to undefined]
+**code** | **string** | Function source code | [optional] [default to undefined]
+**description** | **string** | Optional description of the serverless function | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ServerlessFunctionDTO } from '@caraer/client';
+
+const instance: ServerlessFunctionDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    runtime,
+    code,
+    description,
+};
+```
+
+[[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/ServerlessFunctionsApi.md

@@ -0,0 +1,298 @@
+# ServerlessFunctionsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**create1**](#create1) | **POST** /api/v2/apps/{appUuid}/serverless-functions | Create a serverless function|
+|[**index2**](#index2) | **POST** /api/v2/apps/{appUuid}/serverless-functions/index | List serverless functions for an app|
+|[**show**](#show) | **GET** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Get a serverless function|
+|[**testServerlessFunction**](#testserverlessfunction) | **POST** /api/v2/apps/{appUuid}/serverless-functions/{uuid}/test | Test a serverless function|
+|[**update1**](#update1) | **PUT** /api/v2/apps/{appUuid}/serverless-functions/{uuid} | Update a serverless function|
+
+# **create1**
+> CreateResponse create1(serverlessFunctionDTO)
+
+Creates a new serverless function attached to the specified app.
+
+### Example
+
+```typescript
+import {
+    ServerlessFunctionsApi,
+    Configuration,
+    ServerlessFunctionDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new ServerlessFunctionsApi(configuration);
+
+let appUuid: string; //UUID of the app to attach the serverless function to (default to undefined)
+let serverlessFunctionDTO: ServerlessFunctionDTO; //Serverless function payload (runtime and code)
+
+const { status, data } = await apiInstance.create1(
+    appUuid,
+    serverlessFunctionDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **serverlessFunctionDTO** | **ServerlessFunctionDTO**| Serverless function payload (runtime and code) | |
+| **appUuid** | [**string**] | UUID of the app to attach the serverless function to | defaults to undefined|
+
+
+### Return type
+
+**CreateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully created serverless function |  -  |
+|**400** | Invalid request or app not installed for company |  -  |
+
+[[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)
+
+# **index2**
+> PaginationResponse index2(body)
+
+Retrieves a paginated list of serverless functions that belong to the specified app.
+
+### Example
+
+```typescript
+import {
+    ServerlessFunctionsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new ServerlessFunctionsApi(configuration);
+
+let appUuid: string; //UUID of the app whose serverless functions to list (default to undefined)
+let body: any; //Pagination and filtering options for the request
+
+const { status, data } = await apiInstance.index2(
+    appUuid,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**| Pagination and filtering options for the request | |
+| **appUuid** | [**string**] | UUID of the app whose serverless functions to list | 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** | Successfully retrieved serverless functions |  -  |
+|**400** | Invalid request or app not installed for company |  -  |
+|**401** | Unauthorized access |  -  |
+
+[[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)
+
+# **show**
+> ShowResponse show()
+
+Retrieves a serverless function by its UUID, ensuring it belongs to the specified app.
+
+### Example
+
+```typescript
+import {
+    ServerlessFunctionsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new ServerlessFunctionsApi(configuration);
+
+let appUuid: string; //UUID of the app (default to undefined)
+let uuid: string; //UUID of the serverless function (default to undefined)
+
+const { status, data } = await apiInstance.show(
+    appUuid,
+    uuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] | UUID of the app | defaults to undefined|
+| **uuid** | [**string**] | UUID of the serverless function | 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** | Successfully retrieved serverless function |  -  |
+|**404** | Serverless function not found for this app |  -  |
+
+[[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)
+
+# **testServerlessFunction**
+> SuccessResponse testServerlessFunction(testServerlessFunctionRequest)
+
+Provisions (if needed) and invokes a serverless function for a given record and event type, using the same payload shape as webhooks.
+
+### Example
+
+```typescript
+import {
+    ServerlessFunctionsApi,
+    Configuration,
+    TestServerlessFunctionRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new ServerlessFunctionsApi(configuration);
+
+let appUuid: string; //UUID of the app (default to undefined)
+let uuid: string; //UUID of the serverless function to test (default to undefined)
+let testServerlessFunctionRequest: TestServerlessFunctionRequest; //Test serverless function payload (recordUuid and eventType)
+
+const { status, data } = await apiInstance.testServerlessFunction(
+    appUuid,
+    uuid,
+    testServerlessFunctionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **testServerlessFunctionRequest** | **TestServerlessFunctionRequest**| Test serverless function payload (recordUuid and eventType) | |
+| **appUuid** | [**string**] | UUID of the app | defaults to undefined|
+| **uuid** | [**string**] | UUID of the serverless function to test | defaults to undefined|
+
+
+### 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** | Serverless function test executed |  -  |
+|**400** | Invalid input provided |  -  |
+|**404** | App, serverless function, or record 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)
+
+# **update1**
+> ShowResponse update1(serverlessFunctionDTO)
+
+Updates an existing serverless function\'s runtime and code, keeping it attached to the same app.
+
+### Example
+
+```typescript
+import {
+    ServerlessFunctionsApi,
+    Configuration,
+    ServerlessFunctionDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new ServerlessFunctionsApi(configuration);
+
+let appUuid: string; //UUID of the app (default to undefined)
+let uuid: string; //UUID of the serverless function to update (default to undefined)
+let serverlessFunctionDTO: ServerlessFunctionDTO; //Updated serverless function payload (runtime and code)
+
+const { status, data } = await apiInstance.update1(
+    appUuid,
+    uuid,
+    serverlessFunctionDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **serverlessFunctionDTO** | **ServerlessFunctionDTO**| Updated serverless function payload (runtime and code) | |
+| **appUuid** | [**string**] | UUID of the app | defaults to undefined|
+| **uuid** | [**string**] | UUID of the serverless function to update | defaults to undefined|
+
+
+### Return type
+
+**ShowResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully updated serverless function |  -  |
+|**404** | Serverless function not found for this app |  -  |
+
+[[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/SettingField.md

@@ -0,0 +1,40 @@
+# SettingField
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**helpText** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**required** | **boolean** |  | [optional] [default to undefined]
+**dynamic** | **boolean** |  | [optional] [default to undefined]
+**hidden** | **boolean** |  | [optional] [default to undefined]
+**disabled** | **boolean** |  | [optional] [default to undefined]
+**_options** | [**Array<SettingOption>**](SettingOption.md) |  | [optional] [default to undefined]
+**defaultValue** | **any** |  | [optional] [default to undefined]
+**value** | **any** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SettingField } from '@caraer/client';
+
+const instance: SettingField = {
+    name,
+    label,
+    helpText,
+    type,
+    required,
+    dynamic,
+    hidden,
+    disabled,
+    _options,
+    defaultValue,
+    value,
+};
+```
+
+[[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/SettingOption.md

@@ -0,0 +1,24 @@
+# SettingOption
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**helpText** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SettingOption } from '@caraer/client';
+
+const instance: SettingOption = {
+    name,
+    label,
+    helpText,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)