@caraer/client 2.0.696 → 2.0.702

package/docs/SuccessResponseNavigationDTO.md

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

@@ -0,0 +1,46 @@
+# UserDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**firstname** | **string** |  | [optional] [default to undefined]
+**lastname** | **string** |  | [optional] [default to undefined]
+**initials** | **string** |  | [optional] [default to undefined]
+**selectedCompany** | [**CompanyDTO**](CompanyDTO.md) |  | [optional] [default to undefined]
+**companies** | [**Array<SimpleCompanyDTO>**](SimpleCompanyDTO.md) |  | [optional] [default to undefined]
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+**filters** | [**{ [key: string]: Filter; }**](Filter.md) |  | [optional] [default to undefined]
+**role** | **string** |  | [optional] [default to undefined]
+**roles** | **Array<string>** |  | [optional] [default to undefined]
+**token** | [**ApiTokenDTO**](ApiTokenDTO.md) |  | [optional] [default to undefined]
+**record** | [**ModelRecord**](ModelRecord.md) |  | [optional] [default to undefined]
+**easterEggs** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserDTO } from '@caraer/client';
+
+const instance: UserDTO = {
+    uuid,
+    email,
+    firstname,
+    lastname,
+    initials,
+    selectedCompany,
+    companies,
+    scopes,
+    filters,
+    role,
+    roles,
+    token,
+    record,
+    easterEggs,
+};
+```
+
+[[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/ViewNavigationPreferencesRequest.md

@@ -0,0 +1,23 @@
+# ViewNavigationPreferencesRequest
+
+Personal view navigation overrides. Omitted entries preserve their values; a null entry clears that override and restores the legacy sharing default. Does not change sharing or record access.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indices** | **{ [key: string]: number; }** |  | [optional] [default to undefined]
+**favorites** | **{ [key: string]: boolean; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ViewNavigationPreferencesRequest } from '@caraer/client';
+
+const instance: ViewNavigationPreferencesRequest = {
+    indices,
+    favorites,
+};
+```
+
+[[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/WebpageEditorDefaultsDTO.md

@@ -0,0 +1,25 @@
+# WebpageEditorDefaultsDTO
+
+Read-only style, color and font defaults for an authorized webpage editor. Contains no company administration or executable script configuration.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**componentStyles** | [**{ [key: string]: PageContentStylingDTO; }**](PageContentStylingDTO.md) |  | [optional] [default to undefined]
+**palette** | [**Palette**](Palette.md) |  | [optional] [default to undefined]
+**fonts** | [**Array<CustomFontDTO>**](CustomFontDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebpageEditorDefaultsDTO } from '@caraer/client';
+
+const instance: WebpageEditorDefaultsDTO = {
+    componentStyles,
+    palette,
+    fonts,
+};
+```
+
+[[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/WebpagesApi.md

@@ -31,11 +31,13 @@ All URIs are relative to *https://v2.api.caraer.com*
 |[**getWebpageEditingStatus**](#getwebpageeditingstatus) | **GET** /api/v2/webpages/{uuid}/editing-status | Check if a webpage is being edited|
 |[**getWebpagePickerPages**](#getwebpagepickerpages) | **GET** /api/v2/webpages/picker/pages | List webpages for picker dropdowns|
 |[**listProtectionGrants**](#listprotectiongrants) | **GET** /api/v2/webpages/{uuid}/protection/grants | List signed URL grants for a webpage|
+|[**page**](#page) | **GET** /api/v2/webpages/{uuid}/editor-defaults | Get authorized webpage editor defaults|
 |[**publishFile**](#publishfile) | **POST** /api/v2/webpages/publishFile | Public URL for a library file|
 |[**publishWebpage**](#publishwebpage) | **PUT** /api/v2/webpages/{uuid}/publish | Publish a webpage|
 |[**releaseTemplateWebpageEditingSession**](#releasetemplatewebpageeditingsession) | **DELETE** /api/v2/webpages/template/{objectName}/{environment}/editing-session | Release a template webpage editing session|
 |[**releaseWebpageEditingSession**](#releasewebpageeditingsession) | **DELETE** /api/v2/webpages/{uuid}/editing-session | Release a webpage editing session|
 |[**revokeProtectionGrant**](#revokeprotectiongrant) | **DELETE** /api/v2/webpages/{uuid}/protection/grants/{grantUuid} | Revoke a signed URL grant|
+|[**template**](#template) | **GET** /api/v2/webpages/template/{objectName}/{environment}/editor-defaults | Get authorized template editor defaults|
 |[**unlockPublicWebpage**](#unlockpublicwebpage) | **POST** /api/v2/webpages/public/uuid/{uuid}/unlock | Unlock password-protected webpage|
 |[**unpublishWebpage**](#unpublishwebpage) | **PUT** /api/v2/webpages/{uuid}/unpublish | Unpublish a webpage|
 |[**updateWebpage**](#updatewebpage) | **PUT** /api/v2/webpages/{uuid} | Update a webpage|
@@ -1730,6 +1732,64 @@ const { status, data } = await apiInstance.listProtectionGrants(
  - **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)
+
+# **page**
+> ShowResponseWebpageEditorDefaultsDTO page()
+
+Returns only public component styling, color tokens and custom fonts for the selected company. Uses the same page, record and environment-property read checks as reading this webpage; company administration access is not required.
+
+### Example
+
+```typescript
+import {
+    WebpagesApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new WebpagesApi(configuration);
+
+let uuid: string; // (default to undefined)
+let environment: string; // (optional) (default to 'staging')
+
+const { status, data } = await apiInstance.page(
+    uuid,
+    environment
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | [**string**] |  | defaults to undefined|
+| **environment** | [**string**] |  | (optional) defaults to 'staging'|
+
+
+### Return type
+
+**ShowResponseWebpageEditorDefaultsDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -2020,6 +2080,64 @@ const { status, data } = await apiInstance.revokeProtectionGrant(
  - **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)
+
+# **template**
+> ShowResponseWebpageEditorDefaultsDTO template()
+
+Returns only public component styling, color tokens and custom fonts for the selected company after its ordinary template-read and tenant object/template resolution checks. No template, lease, company setting or publication is changed.
+
+### Example
+
+```typescript
+import {
+    WebpagesApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new WebpagesApi(configuration);
+
+let objectName: string; // (default to undefined)
+let environment: string; // (default to undefined)
+
+const { status, data } = await apiInstance.template(
+    objectName,
+    environment
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectName** | [**string**] |  | defaults to undefined|
+| **environment** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseWebpageEditorDefaultsDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caraer/client",
-  "version": "2.0.696",
+  "version": "2.0.702",
   "description": "Generated TypeScript client for the Caraer API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {