@caraer/client 2.0.696 → 2.0.702

package/docs/ApiTokenDTO.md

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

@@ -6,6 +6,9 @@ Data transfer object for an app bar (location-specific settings and action confi
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**navigationPlacement** | **string** | TOOL_BAR navigation: SUITE (legacy default) or suite-independent SETTINGS. Omission preserves an existing value. | [optional] [default to undefined]
+**requiredUserScopes** | **Array<string>** | Literal human caller scopes required for TOOL_BAR discovery and iframe access. Omission preserves; [] clears. | [optional] [default to undefined]
+**routeAliases** | **Array<string>** | Unique unreserved settings-relative route slugs for a SETTINGS tool. Omission preserves; [] clears. | [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]
@@ -31,6 +34,9 @@ Name | Type | Description | Notes
 import { AppBarDTO } from '@caraer/client';
 
 const instance: AppBarDTO = {
+    navigationPlacement,
+    requiredUserScopes,
+    routeAliases,
     uuid,
     name,
     label,

package/docs/AppBarIframeSessionRequest.md

@@ -6,6 +6,8 @@ Request body for creating an iframe session token
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**suite** | **string** | Selected suite for explicit SUITE tool requests; omitted legacy requests retain configured-suite behavior | [optional] [default to undefined]
+**navigationPlacement** | **string** | Explicit TOOL_BAR placement; must match the stored descriptor | [optional] [default to undefined]
 **object** | **string** | Object name in context | [optional] [default to undefined]
 **recordUuid** | **string** | UUID of the record in context | [optional] [default to undefined]
 **viewId** | **string** | View ID in context | [optional] [default to undefined]
@@ -18,6 +20,8 @@ Name | Type | Description | Notes
 import { AppBarIframeSessionRequest } from '@caraer/client';
 
 const instance: AppBarIframeSessionRequest = {
+    suite,
+    navigationPlacement,
     object,
     recordUuid,
     viewId,

package/docs/AppBarsApi.md

@@ -29,6 +29,7 @@ let recordUuid: string; //Record UUID in context (optional) (default to undefine
 let viewId: string; //View ID in context (optional) (default to undefined)
 let trait: string; //Trait name in context (optional) (default to undefined)
 let suite: string; //Suite selected in the UI. A tool bar is included when this suite is saved on the bar. (optional) (default to undefined)
+let navigationPlacement: 'SUITE' | 'SETTINGS'; //TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent. (optional) (default to undefined)
 
 const { status, data } = await apiInstance.listAppBars(
     location,
@@ -36,7 +37,8 @@ const { status, data } = await apiInstance.listAppBars(
     recordUuid,
     viewId,
     trait,
-    suite
+    suite,
+    navigationPlacement
 );
 ```
 
@@ -50,6 +52,7 @@ const { status, data } = await apiInstance.listAppBars(
 | **viewId** | [**string**] | View ID in context | (optional) defaults to undefined|
 | **trait** | [**string**] | Trait name in context | (optional) defaults to undefined|
 | **suite** | [**string**] | Suite selected in the UI. A tool bar is included when this suite is saved on the bar. | (optional) defaults to undefined|
+| **navigationPlacement** | [**&#39;SUITE&#39; | &#39;SETTINGS&#39;**]**Array<&#39;SUITE&#39; &#124; &#39;SETTINGS&#39;>** | TOOL_BAR placement. Omitted means legacy SUITE; SETTINGS is suite-independent. | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/AppDTO.md

@@ -6,6 +6,8 @@ Full app payload (AppCreatorDTO) to apply
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**brandmarkReference** | **string** | Stable creator input for brandmark; display uses brandmark URL | [optional] [readonly] [default to undefined]
+**imageReference** | **string** | Stable creator input for details.image; display uses image URL | [optional] [readonly] [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]
@@ -62,6 +64,8 @@ Name | Type | Description | Notes
 import { AppDTO } from '@caraer/client';
 
 const instance: AppDTO = {
+    brandmarkReference,
+    imageReference,
     uuid,
     name,
     label,

package/docs/AppDetailsDTO.md

@@ -9,6 +9,7 @@ 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]
+**imageReference** | **string** | Stable creator input for image; never persist a signed display URL | [optional] [readonly] [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]
@@ -38,6 +39,7 @@ const instance: AppDetailsDTO = {
     title,
     description,
     image,
+    imageReference,
     brandColor,
     textColor,
     url,

package/docs/AppSettingFieldSchema.md

@@ -33,8 +33,8 @@ Name | Type | Description | Notes
 **clearValue** | **boolean** |  | [optional] [default to undefined]
 **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) |  | [optional] [default to undefined]
 **valueScope** | **string** |  | [optional] [default to undefined]
-**action** | **boolean** |  | [optional] [default to undefined]
 **settingsGroup** | **boolean** |  | [optional] [default to undefined]
+**action** | **boolean** |  | [optional] [default to undefined]
 **filterPropertyTypes** | **Array<string>** |  | [optional] [default to undefined]
 **filterPropertyFormats** | **Array<string>** |  | [optional] [default to undefined]
 
@@ -72,8 +72,8 @@ const instance: AppSettingFieldSchema = {
     clearValue,
     mappingValue,
     valueScope,
-    action,
     settingsGroup,
+    action,
     filterPropertyTypes,
     filterPropertyFormats,
 };

package/docs/BrowserAuthExchangeRequest.md

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

@@ -0,0 +1,28 @@
+# BrowserAuthSessionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accessToken** | **string** |  | [optional] [default to undefined]
+**refreshToken** | **string** |  | [optional] [default to undefined]
+**tokenType** | **string** |  | [optional] [default to undefined]
+**user** | [**UserDTO**](UserDTO.md) |  | [optional] [default to undefined]
+**companyUuid** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BrowserAuthSessionResponse } from '@caraer/client';
+
+const instance: BrowserAuthSessionResponse = {
+    accessToken,
+    refreshToken,
+    tokenType,
+    user,
+    companyUuid,
+};
+```
+
+[[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/BrowserAuthStartRequest.md

@@ -0,0 +1,28 @@
+# BrowserAuthStartRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **string** |  | [optional] [default to undefined]
+**redirectUri** | **string** |  | [optional] [default to undefined]
+**codeChallenge** | **string** |  | [optional] [default to undefined]
+**codeChallengeMethod** | **string** |  | [optional] [default to undefined]
+**state** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BrowserAuthStartRequest } from '@caraer/client';
+
+const instance: BrowserAuthStartRequest = {
+    provider,
+    redirectUri,
+    codeChallenge,
+    codeChallengeMethod,
+    state,
+};
+```
+
+[[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/BrowserAuthStartResponse.md

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

@@ -0,0 +1,176 @@
+# BrowserAuthenticationApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**authorize**](#authorize) | **GET** /api/v2/auth/browser/authorize | Open the browser-owned provider session|
+|[**exchange**](#exchange) | **POST** /api/v2/auth/browser/exchange | Exchange a native callback code|
+|[**start**](#start) | **POST** /api/v2/auth/browser/start | Start browser sign-in|
+
+# **authorize**
+> authorize()
+
+
+### Example
+
+```typescript
+import {
+    BrowserAuthenticationApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new BrowserAuthenticationApi(configuration);
+
+let flow: string; // (default to undefined)
+
+const { status, data } = await apiInstance.authorize(
+    flow
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **flow** | [**string**] |  | 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** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **exchange**
+> ShowResponseBrowserAuthSessionResponse exchange(browserAuthExchangeRequest)
+
+Exchanges an unexpired single-use code only after exact redirect and PKCE verifier checks. Access/refresh tokens are returned in JSON and never in callback URLs.
+
+### Example
+
+```typescript
+import {
+    BrowserAuthenticationApi,
+    Configuration,
+    BrowserAuthExchangeRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new BrowserAuthenticationApi(configuration);
+
+let browserAuthExchangeRequest: BrowserAuthExchangeRequest; //
+
+const { status, data } = await apiInstance.exchange(
+    browserAuthExchangeRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **browserAuthExchangeRequest** | **BrowserAuthExchangeRequest**|  | |
+
+
+### Return type
+
+**ShowResponseBrowserAuthSessionResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **start**
+> ShowResponseBrowserAuthStartResponse start(browserAuthStartRequest)
+
+Requires an exact configured redirect URI, random client state and S256 PKCE challenge. Open the returned URL in the system browser.
+
+### Example
+
+```typescript
+import {
+    BrowserAuthenticationApi,
+    Configuration,
+    BrowserAuthStartRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new BrowserAuthenticationApi(configuration);
+
+let browserAuthStartRequest: BrowserAuthStartRequest; //
+
+const { status, data } = await apiInstance.start(
+    browserAuthStartRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **browserAuthStartRequest** | **BrowserAuthStartRequest**|  | |
+
+
+### Return type
+
+**ShowResponseBrowserAuthStartResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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/BulkEditRecordErrorItem.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **clientRef** | **string** | Client reference echoed from the request, if provided. | [optional] [default to undefined]
 **message** | **string** | Summary message for this record\'s failure. | [optional] [default to undefined]
 **errors** | [**Array<CaraerErrorType>**](CaraerErrorType.md) | Field-level validation errors. | [optional] [default to undefined]
+**recordWriteOutcome** | **string** | Proof for this item only that its owning record command did not start record/relationship persistence. Other bulk items may have persisted; ancillary file ingestion is not covered. | [optional] [default to undefined]
 
 ## Example
 
@@ -21,6 +22,7 @@ const instance: BulkEditRecordErrorItem = {
     clientRef,
     message,
     errors,
+    recordWriteOutcome,
 };
 ```
 

package/docs/CreatePrivateAppRequest.md

@@ -6,6 +6,8 @@ Private app creator manifest; label is required and internal name is optional
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**brandmarkReference** | **string** | Stable creator input for brandmark; display uses brandmark URL | [optional] [readonly] [default to undefined]
+**imageReference** | **string** | Stable creator input for details.image; display uses image URL | [optional] [readonly] [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 | [default to undefined]
@@ -62,6 +64,8 @@ Name | Type | Description | Notes
 import { CreatePrivateAppRequest } from '@caraer/client';
 
 const instance: CreatePrivateAppRequest = {
+    brandmarkReference,
+    imageReference,
     uuid,
     name,
     label,

package/docs/EnsureRelationDTO.md

@@ -0,0 +1,27 @@
+# EnsureRelationDTO
+
+Atomic ensure-link receipt. UNCHANGED leaves every existing edge property untouched.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fromUuid** | **string** |  | [optional] [default to undefined]
+**toUuid** | **string** |  | [optional] [default to undefined]
+**relationName** | **string** |  | [optional] [default to undefined]
+**outcome** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EnsureRelationDTO } from '@caraer/client';
+
+const instance: EnsureRelationDTO = {
+    fromUuid,
+    toUuid,
+    relationName,
+    outcome,
+};
+```
+
+[[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/ErrorResponse.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **message** | **string** | The error message providing details about the failure. | [optional] [default to undefined]
 **errors** | [**Array<CaraerErrorType>**](CaraerErrorType.md) | A list of error types providing further details about the error. | [optional] [default to undefined]
 **status** | **number** | The HTTP status code associated with the error. | [optional] [default to undefined]
+**recordWriteOutcome** | **string** | Present only when the owning direct-record command proves record/relationship persistence did not start. Does not imply no file-ingestion side effects or whole-request idempotency. | [optional] [default to undefined]
 **stackTrace** | **string** |  | [optional] [default to undefined]
 **roles** | **Array<string>** | Roles the caller is missing when the failure is an authorization error. | [optional] [default to undefined]
 **scopes** | **Array<string>** | Scopes the caller is missing when the failure is an authorization error. | [optional] [default to undefined]
@@ -23,6 +24,7 @@ const instance: ErrorResponse = {
     message,
     errors,
     status,
+    recordWriteOutcome,
     stackTrace,
     roles,
     scopes,

package/docs/FavoriteViewDTO.md

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