@caraer/client 2.0.695 → 2.0.701

package/docs/ObjectsApi.md

@@ -192,7 +192,7 @@ This endpoint does not have any parameters.
 # **getObject**
 > ShowResponseCaraerObjectDTO getObject()
 
-Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response.
+Fetches a single object by its UUID. Optional parameters determine whether to include views, properties, and relations in the response. Hidden property definitions require includeHiddenProperties=true together with properties=true; property read authorization still applies and archived definitions remain excluded.
 
 ### Example
 
@@ -209,12 +209,14 @@ let uuid: string; // (default to undefined)
 let views: string; // (optional) (default to 'false')
 let properties: string; // (optional) (default to 'false')
 let relations: string; // (optional) (default to 'false')
+let includeHiddenProperties: boolean; // (optional) (default to false)
 
 const { status, data } = await apiInstance.getObject(
     uuid,
     views,
     properties,
-    relations
+    relations,
+    includeHiddenProperties
 );
 ```
 
@@ -226,6 +228,7 @@ const { status, data } = await apiInstance.getObject(
 | **views** | [**string**] |  | (optional) defaults to 'false'|
 | **properties** | [**string**] |  | (optional) defaults to 'false'|
 | **relations** | [**string**] |  | (optional) defaults to 'false'|
+| **includeHiddenProperties** | [**boolean**] |  | (optional) defaults to false|
 
 
 ### Return type

package/docs/Palette.md

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

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

@@ -10,10 +10,12 @@ All URIs are relative to *https://v2.api.caraer.com*
 |[**archivedObjects**](#archivedobjects) | **GET** /api/v2/records/archived/objects | List objects with visible archived records|
 |[**bulkDelete**](#bulkdelete) | **POST** /api/v2/records/{objectName}/bulk-delete | Bulk delete records|
 |[**bulkEdit**](#bulkedit) | **PUT** /api/v2/records/{objectName}/bulk | Bulk create or update records|
+|[**capabilities**](#capabilities) | **POST** /api/v2/records/relations/capabilities | Inspect bounded record relation operations|
 |[**create**](#create) | **POST** /api/v2/records/{objectName} | Create a new record|
 |[**createOrUpdate**](#createorupdate) | **POST** /api/v2/records/{objectName}/createOrUpdate | Create or update a record|
 |[**createRelation**](#createrelation) | **POST** /api/v2/records/relations/{fromUuid}/{relationName}/{toUuid} | Create a relation between records|
 |[**deleteRelation**](#deleterelation) | **DELETE** /api/v2/records/relations/{fromUuid}/{relationName}/{toUuid} | Delete a relation between records|
+|[**ensure**](#ensure) | **PUT** /api/v2/records/relations/{fromUuid}/{relationName}/{toUuid} | Ensure a relation without changing an existing edge|
 |[**extend**](#extend) | **POST** /api/v2/records/{uuid}/extend | Extend a record|
 |[**index**](#index) | **POST** /api/v2/records/index | Fetch paginated records|
 |[**indexFlow**](#indexflow) | **POST** /api/v2/records/index/flow | Fetch records for flow view|
@@ -375,6 +377,62 @@ const { status, data } = await apiInstance.bulkEdit(
 
 [[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)
 
+# **capabilities**
+> ShowResponseRelationCapabilities capabilities(relationCapabilityRequest)
+
+Read-only current eligibility for up to 50 explicit pairs. Uses ordinary record visibility and named-relation scopes; never a mutation grant. Unavailable items disclose no edge state.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration,
+    RelationCapabilityRequest
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let relationCapabilityRequest: RelationCapabilityRequest; //
+
+const { status, data } = await apiInstance.capabilities(
+    relationCapabilityRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **relationCapabilityRequest** | **RelationCapabilityRequest**|  | |
+
+
+### Return type
+
+**ShowResponseRelationCapabilities**
+
+### 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)
+
 # **create**
 > CreateResponse create(recordDTO)
 
@@ -643,6 +701,67 @@ const { status, data } = await apiInstance.deleteRelation(
 
 [[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)
 
+# **ensure**
+> SuccessResponseEnsureRelationDTO ensure()
+
+Bodyless atomic ensure-link using ordinary record reads, relation normalization, immutability and exact relation-write scopes. Existing edges retain all properties and primary flags. New edges are non-primary. No edge-property/primary settings are accepted by this operation; use the existing POST/PATCH operations to change edge values. Receipt identities echo request endpoints.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+let fromUuid: string; // (default to undefined)
+let relationName: string; // (default to undefined)
+let toUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.ensure(
+    fromUuid,
+    relationName,
+    toUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **fromUuid** | [**string**] |  | defaults to undefined|
+| **relationName** | [**string**] |  | defaults to undefined|
+| **toUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponseEnsureRelationDTO**
+
+### 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)
+
 # **extend**
 > SuccessResponseObject extend(extendRecordRequest)
 

package/docs/RelationCapabilities.md

@@ -0,0 +1,26 @@
+# RelationCapabilities
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**unlinkMatch** | **string** |  | [optional] [default to undefined]
+**primaryReset** | **string** |  | [optional] [default to undefined]
+**pairs** | [**Array<RelationCapabilityPairCapability>**](RelationCapabilityPairCapability.md) |  | [optional] [default to undefined]
+**ensureLink** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RelationCapabilities } from '@caraer/client';
+
+const instance: RelationCapabilities = {
+    unlinkMatch,
+    primaryReset,
+    pairs,
+    ensureLink,
+};
+```
+
+[[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/RelationCapabilityEdge.md

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

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

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

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

@@ -0,0 +1,34 @@
+# RelationCapabilityPairCapability
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **number** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**link** | [**RelationCapabilityOperation**](RelationCapabilityOperation.md) |  | [optional] [default to undefined]
+**unlink** | [**RelationCapabilityOperation**](RelationCapabilityOperation.md) |  | [optional] [default to undefined]
+**primary** | [**RelationCapabilityPrimary**](RelationCapabilityPrimary.md) |  | [optional] [default to undefined]
+**edges** | [**RelationCapabilityEdges**](RelationCapabilityEdges.md) |  | [optional] [default to undefined]
+**reason** | **string** |  | [optional] [default to undefined]
+**linkAttemptPermitted** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RelationCapabilityPairCapability } from '@caraer/client';
+
+const instance: RelationCapabilityPairCapability = {
+    index,
+    status,
+    link,
+    unlink,
+    primary,
+    edges,
+    reason,
+    linkAttemptPermitted,
+};
+```
+
+[[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/RelationCapabilityPrimary.md

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

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

@@ -0,0 +1,23 @@
+# ShowResponseBrowserAuthSessionResponse
+
+Represents the response for viewing or showing a specific resource.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**BrowserAuthSessionResponse**](BrowserAuthSessionResponse.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShowResponseBrowserAuthSessionResponse } from '@caraer/client';
+
+const instance: ShowResponseBrowserAuthSessionResponse = {
+    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/ShowResponseBrowserAuthStartResponse.md

@@ -0,0 +1,23 @@
+# ShowResponseBrowserAuthStartResponse
+
+Represents the response for viewing or showing a specific resource.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**BrowserAuthStartResponse**](BrowserAuthStartResponse.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShowResponseBrowserAuthStartResponse } from '@caraer/client';
+
+const instance: ShowResponseBrowserAuthStartResponse = {
+    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/ShowResponseItem.md

@@ -0,0 +1,23 @@
+# ShowResponseItem
+
+Represents the response for viewing or showing a specific resource.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**Item**](Item.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShowResponseItem } from '@caraer/client';
+
+const instance: ShowResponseItem = {
+    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/ShowResponseNotificationDeviceReceipt.md

@@ -0,0 +1,23 @@
+# ShowResponseNotificationDeviceReceipt
+
+Represents the response for viewing or showing a specific resource.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**NotificationDeviceReceipt**](NotificationDeviceReceipt.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShowResponseNotificationDeviceReceipt } from '@caraer/client';
+
+const instance: ShowResponseNotificationDeviceReceipt = {
+    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/ShowResponseRelationCapabilities.md

@@ -0,0 +1,23 @@
+# ShowResponseRelationCapabilities
+
+Represents the response for viewing or showing a specific resource.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**RelationCapabilities**](RelationCapabilities.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShowResponseRelationCapabilities } from '@caraer/client';
+
+const instance: ShowResponseRelationCapabilities = {
+    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/ShowResponseWebpageEditorDefaultsDTO.md

@@ -0,0 +1,23 @@
+# ShowResponseWebpageEditorDefaultsDTO
+
+Represents the response for viewing or showing a specific resource.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**WebpageEditorDefaultsDTO**](WebpageEditorDefaultsDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShowResponseWebpageEditorDefaultsDTO } from '@caraer/client';
+
+const instance: ShowResponseWebpageEditorDefaultsDTO = {
+    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/SimpleCompanyDTO.md

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

@@ -0,0 +1,23 @@
+# SuccessResponseEnsureRelationDTO
+
+Represents a standard successful response with a message and optional data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**EnsureRelationDTO**](EnsureRelationDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SuccessResponseEnsureRelationDTO } from '@caraer/client';
+
+const instance: SuccessResponseEnsureRelationDTO = {
+    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/SuccessResponseListFavoriteViewDTO.md

@@ -0,0 +1,23 @@
+# SuccessResponseListFavoriteViewDTO
+
+Represents a standard successful response with a message and optional data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**Array<FavoriteViewDTO>**](FavoriteViewDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SuccessResponseListFavoriteViewDTO } from '@caraer/client';
+
+const instance: SuccessResponseListFavoriteViewDTO = {
+    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/SuccessResponseListNavigationViewDTO.md

@@ -0,0 +1,23 @@
+# SuccessResponseListNavigationViewDTO
+
+Represents a standard successful response with a message and optional data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**Array<NavigationViewDTO>**](NavigationViewDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SuccessResponseListNavigationViewDTO } from '@caraer/client';
+
+const instance: SuccessResponseListNavigationViewDTO = {
+    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)