@caraer/client 2.0.347

package/docs/WebMenusApi.md

@@ -0,0 +1,336 @@
+# WebMenusApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createWebMenu**](#createwebmenu) | **POST** /api/v2/webmenus | Create web menu|
+|[**deleteWebMenu**](#deletewebmenu) | **DELETE** /api/v2/webmenus/{uuid} | Delete web menu|
+|[**getWebMenu**](#getwebmenu) | **GET** /api/v2/webmenus/{uuid} | Show web menu|
+|[**indexWebMenus**](#indexwebmenus) | **POST** /api/v2/webmenus/index | Index web menus|
+|[**restoreWebMenu**](#restorewebmenu) | **POST** /api/v2/webmenus/{uuid}/restore | Restore deleted web menu|
+|[**updateWebMenu**](#updatewebmenu) | **PUT** /api/v2/webmenus/{uuid} | Update web menu|
+
+# **createWebMenu**
+> CreateResponse createWebMenu(webMenuDTO)
+
+Create web menu
+
+### Example
+
+```typescript
+import {
+    WebMenusApi,
+    Configuration,
+    WebMenuDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new WebMenusApi(configuration);
+
+let webMenuDTO: WebMenuDTO; //
+
+const { status, data } = await apiInstance.createWebMenu(
+    webMenuDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **webMenuDTO** | **WebMenuDTO**|  | |
+
+
+### 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** | Web menu created successfully |  -  |
+|**400** | Bad request |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **deleteWebMenu**
+> DeleteResponse deleteWebMenu()
+
+Delete web menu
+
+### Example
+
+```typescript
+import {
+    WebMenusApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new WebMenusApi(configuration);
+
+let uuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteWebMenu(
+    uuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeleteResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Web menu deleted successfully |  -  |
+|**400** | Bad request |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **getWebMenu**
+> ShowResponse getWebMenu()
+
+Show web menu
+
+### Example
+
+```typescript
+import {
+    WebMenusApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new WebMenusApi(configuration);
+
+let uuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getWebMenu(
+    uuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | [**string**] |  | 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** | Web menu shown successfully |  -  |
+|**400** | Bad request |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **indexWebMenus**
+> PaginationResponse indexWebMenus(body)
+
+Index web menus
+
+### Example
+
+```typescript
+import {
+    WebMenusApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new WebMenusApi(configuration);
+
+let body: any; //
+
+const { status, data } = await apiInstance.indexWebMenus(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**|  | |
+
+
+### 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** | Web menus indexed successfully |  -  |
+|**400** | Bad request |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **restoreWebMenu**
+> RestoreResponse restoreWebMenu()
+
+Restore a deleted web menu by its UUID
+
+### Example
+
+```typescript
+import {
+    WebMenusApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new WebMenusApi(configuration);
+
+let uuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.restoreWebMenu(
+    uuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RestoreResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Web menu restored successfully |  -  |
+|**404** | Web menu not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **updateWebMenu**
+> UpdateResponse updateWebMenu(webMenuDTO)
+
+Update web menu
+
+### Example
+
+```typescript
+import {
+    WebMenusApi,
+    Configuration,
+    WebMenuDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new WebMenusApi(configuration);
+
+let uuid: string; // (default to undefined)
+let webMenuDTO: WebMenuDTO; //
+
+const { status, data } = await apiInstance.updateWebMenu(
+    uuid,
+    webMenuDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **webMenuDTO** | **WebMenuDTO**|  | |
+| **uuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**UpdateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Web menu updated successfully |  -  |
+|**400** | Bad request |  -  |
+|**500** | Internal server error |  -  |
+
+[[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/WebpageAccessGrantDTO.md

@@ -0,0 +1,51 @@
+# WebpageAccessGrantDTO
+
+Signed URL access grant for a protected webpage
+
+## 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]
+**recordUuid** | **string** |  | [optional] [default to undefined]
+**expiresAt** | **number** |  | [optional] [default to undefined]
+**revokedAt** | **number** |  | [optional] [default to undefined]
+**active** | **boolean** |  | [optional] [default to undefined]
+**tokenHash** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebpageAccessGrantDTO } from '@caraer/client';
+
+const instance: WebpageAccessGrantDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    recordUuid,
+    expiresAt,
+    revokedAt,
+    active,
+    tokenHash,
+    token,
+};
+```
+
+[[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/WebpageDTO.md

@@ -0,0 +1,69 @@
+# WebpageDTO
+
+Data transfer object representing a webpage with its various states, properties, and associated form/versions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**environment** | **string** | The environment of the webpage. | [optional] [default to undefined]
+**uuid** | **string** | The UUID of the webpage. | [optional] [default to undefined]
+**title** | **string** | The title of the webpage. | [optional] [default to undefined]
+**excerpt** | **string** | Short summary or excerpt displayed for the webpage. | [optional] [default to undefined]
+**slug** | **string** | URL-friendly identifier for the webpage. | [optional] [default to undefined]
+**image** | **string** | URL or identifier of the image associated with the webpage. | [optional] [default to undefined]
+**customCss** | **string** | Custom CSS for the webpage. | [optional] [default to undefined]
+**customJsHead** | **string** | Custom JS for the webpage. | [optional] [default to undefined]
+**customJsBody** | **string** | Custom JS for the webpage. | [optional] [default to undefined]
+**content** | [**PageContentDTO**](PageContentDTO.md) | Content of the webpage | [optional] [default to undefined]
+**sidebar** | [**PreviewDTO**](PreviewDTO.md) | Preview of the sidebar | [optional] [default to undefined]
+**sidebarRelation** | [**RelationDTO**](RelationDTO.md) | Relation of the sidebar | [optional] [default to undefined]
+**sidebarObject** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | Object of the sidebar | [optional] [default to undefined]
+**object** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | The Object object associated with the webpage, representing application data. | [optional] [default to undefined]
+**record** | [**WebpagePublicRecordDTO**](WebpagePublicRecordDTO.md) | Webpage-public backing record values (internal + parsed). Set only on public page responses. | [optional] [default to undefined]
+**_options** | [**WebpageOptionsDTO**](WebpageOptionsDTO.md) | Custom options and configurations specific to the webpage. | [optional] [default to undefined]
+**metaData** | **{ [key: string]: any | null; }** | Map of additional metadata and attributes for the webpage. | [optional] [default to undefined]
+**publishedBy** | **string** | Identifier of the user or process that published the webpage | [optional] [default to undefined]
+**publishedAt** | **number** | Timestamp representing when the webpage was published | [optional] [default to undefined]
+**unpublishedBy** | **string** | Identifier of the user or process that unpublished the webpage | [optional] [default to undefined]
+**unpublishedAt** | **number** | Timestamp representing when the webpage was unpublished | [optional] [default to undefined]
+**publishAt** | **number** | Scheduled timestamp for when the webpage will be published | [optional] [default to undefined]
+**unpublishAt** | **number** | Scheduled timestamp for when the webpage will be unpublished | [optional] [default to undefined]
+**isPublished** | **boolean** | Flag indicating whether the webpage is currently published | [optional] [default to false]
+**liveUrl** | **string** | Fully qualified public URL of the webpage, including the page trait root slug. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebpageDTO } from '@caraer/client';
+
+const instance: WebpageDTO = {
+    environment,
+    uuid,
+    title,
+    excerpt,
+    slug,
+    image,
+    customCss,
+    customJsHead,
+    customJsBody,
+    content,
+    sidebar,
+    sidebarRelation,
+    sidebarObject,
+    object,
+    record,
+    _options,
+    metaData,
+    publishedBy,
+    publishedAt,
+    unpublishedBy,
+    unpublishedAt,
+    publishAt,
+    unpublishAt,
+    isPublished,
+    liveUrl,
+};
+```
+
+[[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/WebpageEditingStatusDTO.md

@@ -0,0 +1,25 @@
+# WebpageEditingStatusDTO
+
+Whether a webpage is currently being edited by another user
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locked** | **boolean** | True when another user is actively editing this webpage | [optional] [default to undefined]
+**editor** | [**UserWithCursorLocationDTO**](UserWithCursorLocationDTO.md) | The user currently editing, when locked is true | [optional] [default to undefined]
+**message** | **string** | Human-readable message for the client UI | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebpageEditingStatusDTO } from '@caraer/client';
+
+const instance: WebpageEditingStatusDTO = {
+    locked,
+    editor,
+    message,
+};
+```
+
+[[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/WebpageOptionsDTO.md

@@ -0,0 +1,41 @@
+# WebpageOptionsDTO
+
+Data Transfer Object representing options for a webpage.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**relatedToTemplate** | **boolean** | Indicates if the webpage is related to a template. | [optional] [default to undefined]
+**protectionOverride** | **string** | Page-level protection override: inherit, none, password, signedUrl, caraerAuth | [optional] [default to undefined]
+**passwordHash** | **string** | Bcrypt hash for per-page password (never returned in public APIs) | [optional] [default to undefined]
+**password** | **string** | Recoverable per-page password value for CMS display only | [optional] [default to undefined]
+**passwordValue** | **string** | Stored recoverable per-page password value for CMS display only | [optional] [default to undefined]
+**passwordSmartContent** | **boolean** | Whether the per-page password value should be resolved as smart content | [optional] [default to undefined]
+**hasPassword** | **boolean** | Whether a per-page password is configured | [optional] [default to undefined]
+**inheritedPassword** | **string** | Recoverable inherited shared password value for CMS display only | [optional] [default to undefined]
+**inheritedPasswordValue** | **string** | Stored recoverable inherited shared password value for CMS display only | [optional] [default to undefined]
+**inheritedPasswordSmartContent** | **boolean** | Whether the inherited shared password value should be resolved as smart content | [optional] [default to undefined]
+**inheritedHasPassword** | **boolean** | Whether an inherited shared password is configured | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebpageOptionsDTO } from '@caraer/client';
+
+const instance: WebpageOptionsDTO = {
+    relatedToTemplate,
+    protectionOverride,
+    passwordHash,
+    password,
+    passwordValue,
+    passwordSmartContent,
+    hasPassword,
+    inheritedPassword,
+    inheritedPasswordValue,
+    inheritedPasswordSmartContent,
+    inheritedHasPassword,
+};
+```
+
+[[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/WebpageProtectionInfoDTO.md

@@ -0,0 +1,27 @@
+# WebpageProtectionInfoDTO
+
+Public protection metadata for a webpage (no content)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**protectionRequired** | **boolean** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**uuid** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebpageProtectionInfoDTO } from '@caraer/client';
+
+const instance: WebpageProtectionInfoDTO = {
+    protectionRequired,
+    type,
+    title,
+    uuid,
+};
+```
+
+[[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/WebpagePublicRecordDTO.md

@@ -0,0 +1,25 @@
+# WebpagePublicRecordDTO
+
+Webpage-public record values with internal and parsed property maps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | UUID of the webpage backing record | [optional] [default to undefined]
+**properties** | **{ [key: string]: any | null; }** | Internal/plain property values keyed by property name | [optional] [default to undefined]
+**parsedProperties** | **{ [key: string]: any | null; }** | Parsed/display property values keyed by property name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WebpagePublicRecordDTO } from '@caraer/client';
+
+const instance: WebpagePublicRecordDTO = {
+    uuid,
+    properties,
+    parsedProperties,
+};
+```
+
+[[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/WebpageUnlockRequest.md

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