@caraer/client 2.0.347

package/docs/PageContentDTO.md

@@ -0,0 +1,73 @@
+# PageContentDTO
+
+Data transfer object representing a webpage content
+
+## 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]
+**category** | **string** | Category of the content | [optional] [default to undefined]
+**parentUuid** | **string** | Unique identifier for the parent content | [optional] [default to undefined]
+**type** | **string** | Type of the content (\'box\' or \'component\') | [optional] [default to undefined]
+**display** | **string** | Display of the content for box (\'column\', \'row\' or \'wrap\') and for component () | [optional] [default to undefined]
+**text** | **string** | Text content of the content | [optional] [default to undefined]
+**customCss** | **string** | Direct CSS for this content node, scoped to data-component-uuid at render time | [optional] [default to undefined]
+**styling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | Styling of the content | [optional] [default to undefined]
+**settings** | [**PageContentSettingsDTO**](PageContentSettingsDTO.md) | Settings for the content | [optional] [default to undefined]
+**children** | [**Array<PageContentDTO>**](PageContentDTO.md) | Children of the content | [optional] [default to undefined]
+**scope** | **string** | Module storage scope: company or personal | [optional] [default to undefined]
+**moduleKind** | **string** | Module kind: content (section/component) or page (full page design) | [optional] [default to undefined]
+**pageCustomCss** | **string** | Page-level custom CSS for page modules | [optional] [default to undefined]
+**pageCustomJsHead** | **string** | Page-level custom JS for the head for page modules | [optional] [default to undefined]
+**pageCustomJsBody** | **string** | Page-level custom JS for the body for page modules | [optional] [default to undefined]
+**sidebarUuid** | **string** | Sidebar preview UUID for page modules | [optional] [default to undefined]
+**sidebarRelationUuid** | **string** | Sidebar relation UUID for page modules | [optional] [default to undefined]
+**sidebarObjectUuid** | **string** | Sidebar object UUID for page modules | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PageContentDTO } from '@caraer/client';
+
+const instance: PageContentDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    category,
+    parentUuid,
+    type,
+    display,
+    text,
+    customCss,
+    styling,
+    settings,
+    children,
+    scope,
+    moduleKind,
+    pageCustomCss,
+    pageCustomJsHead,
+    pageCustomJsBody,
+    sidebarUuid,
+    sidebarRelationUuid,
+    sidebarObjectUuid,
+};
+```
+
+[[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/PageContentSettingsDTO.md

@@ -0,0 +1,111 @@
+# PageContentSettingsDTO
+
+Data transfer object representing the settings for a content
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**form** | [**FormDTO**](FormDTO.md) | The form associated with the content | [optional] [default to undefined]
+**openIcon** | **string** | The icon to display when the accordion is open | [optional] [default to undefined]
+**closeIcon** | **string** | The icon to display when the accordion is closed | [optional] [default to undefined]
+**alt** | **string** | The alt text of the image | [optional] [default to undefined]
+**key** | **string** | The key of the image | [optional] [default to undefined]
+**playVideo** | **boolean** | Whether the video should play automatically | [optional] [default to undefined]
+**startMuted** | **boolean** | Whether the image should start muted | [optional] [default to undefined]
+**loopVideo** | **boolean** | Whether the video should loop | [optional] [default to undefined]
+**startOffset** | **number** | The start offset of the video | [optional] [default to undefined]
+**link** | **string** | The link of the button | [optional] [default to undefined]
+**style** | **string** | The style of the button. Primary, secondary, tertiary or custom | [optional] [default to undefined]
+**ctaId** | **string** | Optional CTA tracking identifier for CMS buttons | [optional] [default to undefined]
+**openInNewWindow** | **boolean** | Whether the link should open in a new window | [optional] [default to undefined]
+**sliderType** | **string** | The slider type. Dots, arrows and swipe | [optional] [default to undefined]
+**carouselSpeed** | **number** | The carousel speed. | [optional] [default to undefined]
+**enableControls** | **boolean** | Whether carousel prev/next controls are shown | [optional] [default to undefined]
+**previewObject** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | The object of the previews | [optional] [default to undefined]
+**previews** | [**{ [key: string]: PreviewDTO; }**](PreviewDTO.md) | The previews associated with the layouts | [optional] [default to undefined]
+**previewLayoutOrder** | **Array<string>** | The order of preview layouts | [optional] [default to undefined]
+**filter** | [**Filter**](Filter.md) | The filter associated with the settings | [optional] [default to undefined]
+**orderBy** | [**PropertyDTO**](PropertyDTO.md) | The order by property associated with the settings | [optional] [default to undefined]
+**orderByDirection** | **string** | The order by direction associated with the settings. ASC or DESC, default is ASC | [optional] [default to undefined]
+**asWebpages** | **boolean** | Whether the previews should be shown as webpages | [optional] [default to undefined]
+**loop** | **boolean** | Whether the previews should loop | [optional] [default to undefined]
+**limit** | **number** | The limit associated with the settings | [optional] [default to undefined]
+**groupBy** | [**PropertyDTO**](PropertyDTO.md) | The group by property associated with the settings | [optional] [default to undefined]
+**hideOnNoResults** | **boolean** | Whether the previews should be hidden when there are no results | [optional] [default to undefined]
+**filterType** | **string** | The type of the filter block. left_bar or top_search | [optional] [default to undefined]
+**searchResultSingleString** | **string** | The single result string of the filter block | [optional] [default to undefined]
+**searchResultPluralString** | **string** | The Plural result string of the filter block | [optional] [default to undefined]
+**noResultsString** | **string** | The no results string of the filter block | [optional] [default to undefined]
+**searchFieldEnabled** | **boolean** | Whether the search field should be enabled | [optional] [default to undefined]
+**searchFieldPlaceholder** | **string** | The placeholder of the search field | [optional] [default to undefined]
+**filterBlockEnabled** | **boolean** | Whether the filter block should be enabled | [optional] [default to undefined]
+**filterTitle** | **string** | The title of the filter block | [optional] [default to undefined]
+**filterSubtitle** | **string** | The subtitle of the filter block | [optional] [default to undefined]
+**filterProperties** | [**Array<PropertyDTO>**](PropertyDTO.md) | The properties of the filter block | [optional] [default to undefined]
+**enableFilterTiles** | **boolean** | Whether the filter tiles should be enabled | [optional] [default to undefined]
+**enableFilterQuery** | **boolean** | Whether the filter query should be enabled | [optional] [default to undefined]
+**enableRemoveAllFiltersButton** | **boolean** | Whether the remove all filters button should be enabled | [optional] [default to undefined]
+**ctaEnabled** | **boolean** | Whether the CTA should be enabled | [optional] [default to undefined]
+**ctaTitle** | **string** | The title of the CTA | [optional] [default to undefined]
+**ctaText** | **string** | The text of the CTA | [optional] [default to undefined]
+**ctaButtonText** | **string** | The button text of the CTA | [optional] [default to undefined]
+**ctaButtonLink** | **string** | The button link of the CTA | [optional] [default to undefined]
+**platforms** | **Array<string>** | The platforms shown in the share component | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PageContentSettingsDTO } from '@caraer/client';
+
+const instance: PageContentSettingsDTO = {
+    form,
+    openIcon,
+    closeIcon,
+    alt,
+    key,
+    playVideo,
+    startMuted,
+    loopVideo,
+    startOffset,
+    link,
+    style,
+    ctaId,
+    openInNewWindow,
+    sliderType,
+    carouselSpeed,
+    enableControls,
+    previewObject,
+    previews,
+    previewLayoutOrder,
+    filter,
+    orderBy,
+    orderByDirection,
+    asWebpages,
+    loop,
+    limit,
+    groupBy,
+    hideOnNoResults,
+    filterType,
+    searchResultSingleString,
+    searchResultPluralString,
+    noResultsString,
+    searchFieldEnabled,
+    searchFieldPlaceholder,
+    filterBlockEnabled,
+    filterTitle,
+    filterSubtitle,
+    filterProperties,
+    enableFilterTiles,
+    enableFilterQuery,
+    enableRemoveAllFiltersButton,
+    ctaEnabled,
+    ctaTitle,
+    ctaText,
+    ctaButtonText,
+    ctaButtonLink,
+    platforms,
+};
+```
+
+[[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/PageContentStylingDTO.md

@@ -0,0 +1,26 @@
+# PageContentStylingDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**all** | [**StyleSetDTO**](StyleSetDTO.md) | The style set for all devices | [optional] [default to undefined]
+**mobile** | [**StyleSetDTO**](StyleSetDTO.md) | The style set for the mobile device | [optional] [default to undefined]
+**tablet** | [**StyleSetDTO**](StyleSetDTO.md) | The style set for the tablet device | [optional] [default to undefined]
+**desktop** | [**StyleSetDTO**](StyleSetDTO.md) | The style set for the desktop device | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PageContentStylingDTO } from '@caraer/client';
+
+const instance: PageContentStylingDTO = {
+    all,
+    mobile,
+    tablet,
+    desktop,
+};
+```
+
+[[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/PaginationResponse.md

@@ -0,0 +1,31 @@
+# PaginationResponse
+
+Response object for paginated data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | **Array<any>** | The data returned in the current page of the pagination. | [optional] [default to undefined]
+**total** | **number** | The total number of items available. | [optional] [default to undefined]
+**page** | **number** | The current page number (starts from 1). | [optional] [default to undefined]
+**perPage** | **number** | The number of items displayed per page. | [optional] [default to undefined]
+**lastPage** | **number** | The last page number available for the pagination. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponse } from '@caraer/client';
+
+const instance: PaginationResponse = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponsePreviewDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponsePreviewDTO
+
+Response object for paginated data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**Array<PreviewDTO>**](PreviewDTO.md) | The data returned in the current page of the pagination. | [optional] [default to undefined]
+**total** | **number** | The total number of items available. | [optional] [default to undefined]
+**page** | **number** | The current page number (starts from 1). | [optional] [default to undefined]
+**perPage** | **number** | The number of items displayed per page. | [optional] [default to undefined]
+**lastPage** | **number** | The last page number available for the pagination. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponsePreviewDTO } from '@caraer/client';
+
+const instance: PaginationResponsePreviewDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/PaginationResponseWebpageAccessGrantDTO.md

@@ -0,0 +1,31 @@
+# PaginationResponseWebpageAccessGrantDTO
+
+Response object for paginated data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**Array<WebpageAccessGrantDTO>**](WebpageAccessGrantDTO.md) | The data returned in the current page of the pagination. | [optional] [default to undefined]
+**total** | **number** | The total number of items available. | [optional] [default to undefined]
+**page** | **number** | The current page number (starts from 1). | [optional] [default to undefined]
+**perPage** | **number** | The number of items displayed per page. | [optional] [default to undefined]
+**lastPage** | **number** | The last page number available for the pagination. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationResponseWebpageAccessGrantDTO } from '@caraer/client';
+
+const instance: PaginationResponseWebpageAccessGrantDTO = {
+    message,
+    data,
+    total,
+    page,
+    perPage,
+    lastPage,
+};
+```
+
+[[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/Phone.md

@@ -0,0 +1,18 @@
+# Phone
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { Phone } from '@caraer/client';
+
+const instance: Phone = {
+};
+```
+
+[[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/PreviewDTO.md

@@ -0,0 +1,77 @@
+# PreviewDTO
+
+Data transfer object representing a preview entity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** | Description of the preview | [optional] [default to undefined]
+**object** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | The Caraer object associated with this preview | [optional] [default to undefined]
+**recordUuid** | **string** | UUID of the associated record | [optional] [default to undefined]
+**primary** | **boolean** | Indicates whether this preview is the primary one | [optional] [default to undefined]
+**grid** | **Array<Array<PreviewItemDTO>>** | Rows of the preview grid | [optional] [default to undefined]
+**previewType** | **string** | Preview type | [optional] [default to undefined]
+**profileImage** | [**PropertyDTO**](PropertyDTO.md) | Profile image property | [optional] [default to undefined]
+**profileImagePosition** | **string** | Profile image position (top, left, right, bottom, background) | [optional] [default to undefined]
+**profileImageStyling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | Style set for the profile image | [optional] [default to undefined]
+**firstInitialProperty** | [**PropertyDTO**](PropertyDTO.md) | First initial property | [optional] [default to undefined]
+**secondInitialProperty** | [**PropertyDTO**](PropertyDTO.md) | Second initial property | [optional] [default to undefined]
+**profileImageValue** | **string** | Value of the profile image | [optional] [default to undefined]
+**firstInitialPropertyValue** | **string** | Value of the first initial property | [optional] [default to undefined]
+**secondInitialPropertyValue** | **string** | Value of the second initial property | [optional] [default to undefined]
+**customCss** | **string** | Custom CSS styles for the preview | [optional] [default to undefined]
+**url** | **string** | URL of the preview | [optional] [default to undefined]
+**styling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | The styling of the preview | [optional] [default to undefined]
+**sortProperty** | **string** | Property name used for server-side list sorting | [optional] [default to undefined]
+**sortValue** | **any** |  | [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 { PreviewDTO } from '@caraer/client';
+
+const instance: PreviewDTO = {
+    description,
+    object,
+    recordUuid,
+    primary,
+    grid,
+    previewType,
+    profileImage,
+    profileImagePosition,
+    profileImageStyling,
+    firstInitialProperty,
+    secondInitialProperty,
+    profileImageValue,
+    firstInitialPropertyValue,
+    secondInitialPropertyValue,
+    customCss,
+    url,
+    styling,
+    sortProperty,
+    sortValue,
+    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/PreviewItemDTO.md

@@ -0,0 +1,43 @@
+# PreviewItemDTO
+
+Data Transfer Object for PreviewItem, used for transferring preview details.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | [**PropertyDTO**](PropertyDTO.md) | The property details associated with the preview item. | [optional] [default to undefined]
+**text** | **string** | The text content associated with the preview item. | [optional] [default to undefined]
+**value** | **any** |  | [optional] [default to undefined]
+**relatedObject** | [**PreviewRelatedObjectDTO**](PreviewRelatedObjectDTO.md) | The related object information for the preview item. | [optional] [default to undefined]
+**relatedObjectValue** | **any** |  | [optional] [default to undefined]
+**divider** | **string** | Whether the preview item is a divider. (solid, dashed, dotted, spacer) | [optional] [default to undefined]
+**buttonText** | **string** | The button text associated with the preview item. | [optional] [default to undefined]
+**buttonUrl** | **string** | The button url associated with the preview item. | [optional] [default to undefined]
+**buttonTextValue** | **any** |  | [optional] [default to undefined]
+**buttonUrlValue** | **any** |  | [optional] [default to undefined]
+**settings** | [**PreviewItemSettingsDTO**](PreviewItemSettingsDTO.md) | The settings associated with the preview item. | [optional] [default to undefined]
+**styling** | [**PageContentStylingDTO**](PageContentStylingDTO.md) | The styling associated with the preview item. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PreviewItemDTO } from '@caraer/client';
+
+const instance: PreviewItemDTO = {
+    property,
+    text,
+    value,
+    relatedObject,
+    relatedObjectValue,
+    divider,
+    buttonText,
+    buttonUrl,
+    buttonTextValue,
+    buttonUrlValue,
+    settings,
+    styling,
+};
+```
+
+[[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/PreviewItemSettingsDTO.md

@@ -0,0 +1,43 @@
+# PreviewItemSettingsDTO
+
+Data Transfer Object for PreviewItemSettings, used for transferring preview item settings.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**showIcon** | **boolean** | Whether the preview item should show the icon. | [optional] [default to undefined]
+**iconPadding** | **number** | The padding of the icon. | [optional] [default to undefined]
+**iconColor** | **string** | The color of the icon. | [optional] [default to undefined]
+**iconSize** | **number** | The size of the icon. | [optional] [default to undefined]
+**defaultValue** | **string** | The default value of the preview item. | [optional] [default to undefined]
+**editable** | **boolean** | Whether this preview property is editable inline. | [optional] [default to undefined]
+**helpText** | **string** | The help text of the preview item. | [optional] [default to undefined]
+**paragraph** | **string** | The paragraph of the preview item p, h1, h2, h3, h4, h5, h6. | [optional] [default to undefined]
+**showColor** | **boolean** | Whether the preview item should show the color of the select option. | [optional] [default to undefined]
+**showBorder** | **boolean** | Whether the preview item should show the border around the select option. | [optional] [default to undefined]
+**buttonType** | **string** | What type the button should be (primary, secondary or tertiary) | [optional] [default to undefined]
+**showFavicon** | **boolean** | Whether to show the favicon of the button URL. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PreviewItemSettingsDTO } from '@caraer/client';
+
+const instance: PreviewItemSettingsDTO = {
+    showIcon,
+    iconPadding,
+    iconColor,
+    iconSize,
+    defaultValue,
+    editable,
+    helpText,
+    paragraph,
+    showColor,
+    showBorder,
+    buttonType,
+    showFavicon,
+};
+```
+
+[[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/PreviewRelatedObjectDTO.md

@@ -0,0 +1,23 @@
+# PreviewRelatedObjectDTO
+
+Data transfer object representing a PreviewRelatedObject, constructed using related object and relation data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | The related object data. | [optional] [default to undefined]
+**relation** | [**RelationDTO**](RelationDTO.md) | The type of relation between objects. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PreviewRelatedObjectDTO } from '@caraer/client';
+
+const instance: PreviewRelatedObjectDTO = {
+    object,
+    relation,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)