@caraer/client 2.0.347

package/docs/AppBarIframeSessionsApi.md

@@ -0,0 +1,119 @@
+# AppBarIframeSessionsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createIframeSession**](#createiframesession) | **POST** /api/v2/app-bars/{appBarUuid}/iframe-session | Create an iframe session token|
+|[**validateIframeSession**](#validateiframesession) | **POST** /api/v2/app-bars/iframe-session/validate | Validate an iframe session token|
+
+# **createIframeSession**
+> createIframeSession()
+
+Issues a short-lived opaque token for an iframe-based app bar. The token can be validated by the embedded app to confirm user, company, view, and filter context.
+
+### Example
+
+```typescript
+import {
+    AppBarIframeSessionsApi,
+    Configuration,
+    AppBarIframeSessionRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBarIframeSessionsApi(configuration);
+
+let appBarUuid: string; //UUID of the iframe app bar (default to undefined)
+let appBarIframeSessionRequest: AppBarIframeSessionRequest; // (optional)
+
+const { status, data } = await apiInstance.createIframeSession(
+    appBarUuid,
+    appBarIframeSessionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appBarIframeSessionRequest** | **AppBarIframeSessionRequest**|  | |
+| **appBarUuid** | [**string**] | UUID of the iframe app bar | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Token created |  -  |
+|**400** | Invalid request |  -  |
+|**404** | App bar 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)
+
+# **validateIframeSession**
+> validateIframeSession(appBarIframeSessionValidateRequest)
+
+Public endpoint for embedded apps to validate a caraer_iframe_token and receive safe context.
+
+### Example
+
+```typescript
+import {
+    AppBarIframeSessionsApi,
+    Configuration,
+    AppBarIframeSessionValidateRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBarIframeSessionsApi(configuration);
+
+let appBarIframeSessionValidateRequest: AppBarIframeSessionValidateRequest; //
+
+const { status, data } = await apiInstance.validateIframeSession(
+    appBarIframeSessionValidateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appBarIframeSessionValidateRequest** | **AppBarIframeSessionValidateRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Token validated |  -  |
+|**401** | Invalid or expired token |  -  |
+
+[[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/AppBarTriggerRequest.md

@@ -0,0 +1,31 @@
+# AppBarTriggerRequest
+
+Request body for triggering an action-based app bar
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recordUuid** | **string** | UUID of the record in context | [optional] [default to undefined]
+**object** | **string** | Object name in context | [optional] [default to undefined]
+**viewId** | **string** | View ID in context | [optional] [default to undefined]
+**trait** | **string** | Trait name in context | [optional] [default to undefined]
+**viewData** | **{ [key: string]: any | null; }** | Current view data for rebuilding the active index | [optional] [default to undefined]
+**settingsValues** | **{ [key: string]: any | null; }** | Values for settingsSchema fields supplied at trigger time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppBarTriggerRequest } from '@caraer/client';
+
+const instance: AppBarTriggerRequest = {
+    recordUuid,
+    object,
+    viewId,
+    trait,
+    viewData,
+    settingsValues,
+};
+```
+
+[[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/AppBarVisibilityEntry.md

@@ -0,0 +1,22 @@
+# AppBarVisibilityEntry
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**objects** | **Array<string>** |  | [optional] [default to undefined]
+**suites** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppBarVisibilityEntry } from '@caraer/client';
+
+const instance: AppBarVisibilityEntry = {
+    objects,
+    suites,
+};
+```
+
+[[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/AppBarsApi.md

@@ -0,0 +1,130 @@
+# AppBarsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**listAppBars**](#listappbars) | **GET** /api/v2/app-bars | List installed app bars for a location|
+|[**triggerAppBar**](#triggerappbar) | **POST** /api/v2/app-bars/{appBarUuid}/trigger | Trigger an action-based app bar|
+
+# **listAppBars**
+> listAppBars()
+
+Returns all app bars from installed apps for the authenticated user\'s company at the given location.
+
+### Example
+
+```typescript
+import {
+    AppBarsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBarsApi(configuration);
+
+let location: 'RECORD_PREVIEW' | 'RECORD_OVERVIEW' | 'RECORD_DETAIL' | 'TOOL_BAR' | 'TRAIT_BAR'; //App bar location (default to undefined)
+let object: string; //Object name in context (optional) (default to undefined)
+let recordUuid: string; //Record UUID in context (optional) (default to undefined)
+let viewId: string; //View ID in context (optional) (default to undefined)
+let trait: string; //Trait name in context (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listAppBars(
+    location,
+    object,
+    recordUuid,
+    viewId,
+    trait
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **location** | [**&#39;RECORD_PREVIEW&#39; | &#39;RECORD_OVERVIEW&#39; | &#39;RECORD_DETAIL&#39; | &#39;TOOL_BAR&#39; | &#39;TRAIT_BAR&#39;**]**Array<&#39;RECORD_PREVIEW&#39; &#124; &#39;RECORD_OVERVIEW&#39; &#124; &#39;RECORD_DETAIL&#39; &#124; &#39;TOOL_BAR&#39; &#124; &#39;TRAIT_BAR&#39;>** | App bar location | defaults to undefined|
+| **object** | [**string**] | Object name in context | (optional) defaults to undefined|
+| **recordUuid** | [**string**] | Record UUID in context | (optional) defaults to undefined|
+| **viewId** | [**string**] | View ID in context | (optional) defaults to undefined|
+| **trait** | [**string**] | Trait name in context | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | App bars retrieved |  -  |
+|**400** | Invalid request |  -  |
+
+[[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)
+
+# **triggerAppBar**
+> triggerAppBar()
+
+Fires the app bar webhook with optional settings values and record/view context.
+
+### Example
+
+```typescript
+import {
+    AppBarsApi,
+    Configuration,
+    AppBarTriggerRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new AppBarsApi(configuration);
+
+let appBarUuid: string; //UUID of the app bar to trigger (default to undefined)
+let appBarTriggerRequest: AppBarTriggerRequest; // (optional)
+
+const { status, data } = await apiInstance.triggerAppBar(
+    appBarUuid,
+    appBarTriggerRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appBarTriggerRequest** | **AppBarTriggerRequest**|  | |
+| **appBarUuid** | [**string**] | UUID of the app bar to trigger | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Trigger accepted |  -  |
+|**400** | Invalid request |  -  |
+|**404** | App bar 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)
+

package/docs/AppDTO.md

@@ -0,0 +1,101 @@
+# AppDTO
+
+Full app payload (AppCreatorDTO) to apply
+
+## 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]
+**privateApp** | **boolean** | Indicates whether this app is private (only available to the creator\'s company) | [optional] [default to undefined]
+**hideApiKeyField** | **boolean** | Whether to hide the API token field in app settings UI | [optional] [default to undefined]
+**details** | [**AppDetailsDTO**](AppDetailsDTO.md) | Additional details and specifications about the application | [optional] [default to undefined]
+**pricingPlans** | [**Array<AppPricingDTO>**](AppPricingDTO.md) | Pricing information for the application | [optional] [default to undefined]
+**appBars** | [**Array<AppBarDTO>**](AppBarDTO.md) | App bars (location-specific configuration and actions) | [optional] [default to undefined]
+**serverlessFunctions** | [**Array<ServerlessFunctionDTO>**](ServerlessFunctionDTO.md) | Serverless functions owned by this app | [optional] [default to undefined]
+**installWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when the app is installed | [optional] [default to undefined]
+**uninstallWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when the app is uninstalled | [optional] [default to undefined]
+**rotateWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when the app installation token is rotated | [optional] [default to undefined]
+**updateWebhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook triggered when an already installed app is saved again | [optional] [default to undefined]
+**settingsSchema** | [**Array<AppSettingFieldSchema>**](AppSettingFieldSchema.md) | JSON array of AppSettingFieldSchema (app-level setting field definitions) | [optional] [default to undefined]
+**webhookRateLimitPerMinute** | **number** | Webhook rate limit per minute | [optional] [default to undefined]
+**billFailedWebhookRequests** | **boolean** | Whether failed webhook requests are considered billable for this app | [optional] [default to undefined]
+**appPublish** | [**AppPublishDTO**](AppPublishDTO.md) | Publish and review state for the app in the marketplace (creator view) | [optional] [default to undefined]
+**hasApp** | [**HasAppDTO**](HasAppDTO.md) | Installation link (company–app) with token, scopes, and per-installation settingsValues; present when includeSettings is true | [optional] [default to undefined]
+**image** | **string** | URL to the application\'s image or icon (derived from details.image) | [optional] [default to undefined]
+**url** | **string** | URL where the application can be accessed (derived from details.url) | [optional] [default to undefined]
+**category** | **string** | Category the application belongs to (derived from details.category) | [optional] [default to undefined]
+**installed** | **boolean** | Whether the app is installed for the current company | [optional] [default to undefined]
+**requiredScopes** | **Array<string>** | Required scopes requested by the app (macro patterns or concrete scope strings). | [optional] [default to undefined]
+**resolvedRequiredScopes** | **Array<string>** | Resolved concrete required scopes derived from requiredScopes and dynamic availableScopes. | [optional] [default to undefined]
+**authMethod** | **string** | Authentication method for this app (API_KEY default, OAUTH2 for OAuth 2.0) | [optional] [default to undefined]
+**oauthClientId** | **string** | OAuth 2.0 client identifier (OAuth apps only) | [optional] [default to undefined]
+**oauthClientSecret** | **string** | OAuth 2.0 client secret; only returned once on create or secret rotation | [optional] [default to undefined]
+**oauthClientSecretConfigured** | **boolean** | Whether an OAuth client secret is stored for this app (plain value is not re-readable) | [optional] [default to undefined]
+**oauthRedirectUris** | **Array<string>** | Registered OAuth redirect URIs (OAuth apps only) | [optional] [default to undefined]
+**oauthAuthorizeUrl** | **string** | OAuth authorization endpoint URL | [optional] [default to undefined]
+**oauthTokenUrl** | **string** | OAuth token endpoint URL | [optional] [default to undefined]
+**installUrl** | **string** | External URL where end users install this app (e.g. ChatGPT connector page) | [optional] [default to undefined]
+**brandmark** | **string** | Square brandmark URL used in compact app surfaces | [optional] [default to undefined]
+**description** | **string** | Internal app description used in Caraer admin views | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppDTO } from '@caraer/client';
+
+const instance: AppDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    privateApp,
+    hideApiKeyField,
+    details,
+    pricingPlans,
+    appBars,
+    serverlessFunctions,
+    installWebhook,
+    uninstallWebhook,
+    rotateWebhook,
+    updateWebhook,
+    settingsSchema,
+    webhookRateLimitPerMinute,
+    billFailedWebhookRequests,
+    appPublish,
+    hasApp,
+    image,
+    url,
+    category,
+    installed,
+    requiredScopes,
+    resolvedRequiredScopes,
+    authMethod,
+    oauthClientId,
+    oauthClientSecret,
+    oauthClientSecretConfigured,
+    oauthRedirectUris,
+    oauthAuthorizeUrl,
+    oauthTokenUrl,
+    installUrl,
+    brandmark,
+    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/AppDetailsDTO.md

@@ -0,0 +1,63 @@
+# AppDetailsDTO
+
+Detailed DTO representing an application with all available configuration and visibility metadata for the current company context
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** |  | [optional] [default to undefined]
+**description** | **string** | Short marketplace description shown on app cards and detail pages | [optional] [default to undefined]
+**image** | **string** |  | [optional] [default to undefined]
+**brandColor** | **string** | Hex accent color (#RRGGBB) for installed app-bar action buttons and toolbar icons | [optional] [default to undefined]
+**textColor** | **string** | Hex text color (#RRGGBB) for text on brand-colored marketplace UI elements | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+**category** | **string** | Main marketplace category key from GET /api/v2/apps/categories | [optional] [default to undefined]
+**subcategories** | **Array<string>** | Selected subcategory keys under the main category | [optional] [default to undefined]
+**privacyPolicy** | **string** |  | [optional] [default to undefined]
+**termsAndConditions** | **string** |  | [optional] [default to undefined]
+**processingAgreement** | **string** |  | [optional] [default to undefined]
+**disclaimer** | **string** |  | [optional] [default to undefined]
+**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]
+
+## Example
+
+```typescript
+import { AppDetailsDTO } from '@caraer/client';
+
+const instance: AppDetailsDTO = {
+    title,
+    description,
+    image,
+    brandColor,
+    textColor,
+    url,
+    category,
+    subcategories,
+    privacyPolicy,
+    termsAndConditions,
+    processingAgreement,
+    disclaimer,
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+};
+```
+
+[[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/AppPricingDTO.md

@@ -0,0 +1,55 @@
+# AppPricingDTO
+
+Data transfer object for app pricing (flat or tiered)
+
+## 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]
+**title** | **string** | Pricing title | [optional] [default to undefined]
+**description** | **string** | Pricing description | [optional] [default to undefined]
+**pricingType** | **string** | Pricing type: TIERED or FLAT | [optional] [default to undefined]
+**pricePerUnit** | **string** | Price per unit (FLAT, e.g. 10.00) | [optional] [default to undefined]
+**unit** | **string** | Unit label (FLAT, e.g. document) | [optional] [default to undefined]
+**freeUnits** | **string** | Free units included (FLAT, e.g. 100) | [optional] [default to undefined]
+**freeUnitsPeriod** | **string** | Free units period (FLAT, e.g. month) | [optional] [default to undefined]
+**tiers** | [**Array<AppTierDTO>**](AppTierDTO.md) | Tiers for tiered pricing (TIERED) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppPricingDTO } from '@caraer/client';
+
+const instance: AppPricingDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    title,
+    description,
+    pricingType,
+    pricePerUnit,
+    unit,
+    freeUnits,
+    freeUnitsPeriod,
+    tiers,
+};
+```
+
+[[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/AppPublishDTO.md

@@ -0,0 +1,51 @@
+# AppPublishDTO
+
+Publish and review state for a public app in the marketplace
+
+## 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]
+**publishState** | **string** | Publish state: DRAFT, SUBMITTED, IN_REVIEW, APPROVED, PUBLISHED, REJECTED, CHANGES_REQUESTED | [optional] [default to undefined]
+**submittedAt** | **number** | Timestamp when developer submitted for review | [optional] [default to undefined]
+**reviewedAt** | **number** | Timestamp when review was completed | [optional] [default to undefined]
+**publishedAt** | **number** | Timestamp when app went live in marketplace | [optional] [default to undefined]
+**feedback** | **string** | Feedback shown to developer (e.g. rejection reason) | [optional] [default to undefined]
+**reviewerNotes** | **string** | Internal reviewer notes (admin only, not exposed to developer) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppPublishDTO } from '@caraer/client';
+
+const instance: AppPublishDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    publishState,
+    submittedAt,
+    reviewedAt,
+    publishedAt,
+    feedback,
+    reviewerNotes,
+};
+```
+
+[[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/AppRequest.md

@@ -0,0 +1,21 @@
+# AppRequest
+
+Settings required to uninstall the application
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**settings** | [**Array<AppSettingFieldSchema>**](AppSettingFieldSchema.md) | A map of configuration settings. The keys are strings representing the setting names, and the values represent the setting values, which can be different types. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppRequest } from '@caraer/client';
+
+const instance: AppRequest = {
+    settings,
+};
+```
+
+[[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/AppSettingFieldMappingStructure.md

@@ -0,0 +1,22 @@
+# AppSettingFieldMappingStructure
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**objectName** | **string** |  | [optional] [default to undefined]
+**items** | [**Array<AppSettingFieldMappingStructureItem>**](AppSettingFieldMappingStructureItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppSettingFieldMappingStructure } from '@caraer/client';
+
+const instance: AppSettingFieldMappingStructure = {
+    objectName,
+    items,
+};
+```
+
+[[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/AppSettingFieldMappingStructureItem.md

@@ -0,0 +1,32 @@
+# AppSettingFieldMappingStructureItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fieldLabel** | **string** |  | [optional] [default to undefined]
+**fieldName** | **string** |  | [optional] [default to undefined]
+**fieldHelpText** | **string** |  | [optional] [default to undefined]
+**isRequired** | **boolean** |  | [optional] [default to undefined]
+**allowedPropertyTypes** | **Array<string>** |  | [optional] [default to undefined]
+**allowedPropertyFormats** | **Array<string>** |  | [optional] [default to undefined]
+**propertyName** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AppSettingFieldMappingStructureItem } from '@caraer/client';
+
+const instance: AppSettingFieldMappingStructureItem = {
+    fieldLabel,
+    fieldName,
+    fieldHelpText,
+    isRequired,
+    allowedPropertyTypes,
+    allowedPropertyFormats,
+    propertyName,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)