@caraer/client 2.0.347

package/docs/ShowItem.md

@@ -0,0 +1,35 @@
+# ShowItem
+
+DTO representing an item with properties defined for displaying and handling in UI related operations.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **string** | The name of the object to which this pagination item belongs. | [optional] [default to undefined]
+**relation** | **string** | The relationship between objects. | [optional] [default to undefined]
+**property** | **string** | The name of the property within the object. | [optional] [default to undefined]
+**separator** | **string** | Separator string used to visually separate this item. | [optional] [default to undefined]
+**sticky** | **boolean** | Flag indicating whether this item is sticky and will stay fixed in the list. | [optional] [default to false]
+**width** | **number** | Width of the item in pixels. | [optional] [default to undefined]
+**calculationFunction** | **string** | Calculation function used to calculate the value of the item. | [optional] [default to undefined]
+**calculationResult** | **any** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShowItem } from '@caraer/client';
+
+const instance: ShowItem = {
+    object,
+    relation,
+    property,
+    separator,
+    sticky,
+    width,
+    calculationFunction,
+    calculationResult,
+};
+```
+
+[[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/ShowResponse.md

@@ -0,0 +1,23 @@
+# ShowResponse
+
+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** | **any** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShowResponse } from '@caraer/client';
+
+const instance: ShowResponse = {
+    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/ShowResponseObjectAccessGrantCandidatesDTO.md

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

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

@@ -0,0 +1,27 @@
+# SignedUrlResultDTO
+
+Generated signed URL for a protected webpage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**grantUuid** | **string** |  | [optional] [default to undefined]
+**token** | **string** |  | [optional] [default to undefined]
+**expiresAt** | **number** |  | [optional] [default to undefined]
+**queryParams** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignedUrlResultDTO } from '@caraer/client';
+
+const instance: SignedUrlResultDTO = {
+    grantUuid,
+    token,
+    expiresAt,
+    queryParams,
+};
+```
+
+[[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/SimplePublicCompanyDTO.md

@@ -0,0 +1,69 @@
+# SimplePublicCompanyDTO
+
+Data Transfer Object representing a public-facing view of a company
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier of the company | [optional] [default to undefined]
+**updatedAt** | **number** | Timestamp of the last update (in milliseconds since epoch) | [optional] [default to undefined]
+**website** | **string** | The website URL of the company | [optional] [default to undefined]
+**cookiePolicy** | **string** | Cookie policy URL of the company | [optional] [default to undefined]
+**favicon** | **string** | Path to the company\'s favicon | [optional] [default to undefined]
+**privacyPolicy** | **string** | Privacy policy URL of the company | [optional] [default to undefined]
+**accentColor** | **string** | The accent color used by the company | [optional] [default to undefined]
+**twitterUrl** | **string** | Twitter URL of the company\'s social media page | [optional] [default to undefined]
+**primaryColor** | **string** | The company\'s primary color used in branding | [optional] [default to undefined]
+**termsAndConditions** | **string** | Terms and conditions URL of the company | [optional] [default to undefined]
+**facebookUrl** | **string** | URL to the company\'s Facebook page | [optional] [default to undefined]
+**youtubeUrl** | **string** | URL to the company\'s YouTube page | [optional] [default to undefined]
+**companyColor** | **string** | Company\'s branding color | [optional] [default to undefined]
+**name** | **string** | Name of the company | [optional] [default to undefined]
+**logo** | **string** | Path to the company\'s logo image | [optional] [default to undefined]
+**instagramUrl** | **string** | URL to the company\'s Instagram page | [optional] [default to undefined]
+**fontColor** | **string** | Font color used in company\'s branding | [optional] [default to undefined]
+**secondaryColor** | **string** | Secondary color used in company\'s branding | [optional] [default to undefined]
+**rightNavBarButtonEnabled** | **boolean** | Boolean flag indicating if the right navigation bar button is enabled | [optional] [default to undefined]
+**rightNavBarButtonTitle** | **string** | Title of the right navigation bar button | [optional] [default to undefined]
+**rightNavBarButtonLink** | **string** | Link for the right navigation bar button | [optional] [default to undefined]
+**cssScript** | **string** | CSS scripts added by the company | [optional] [default to undefined]
+**jsHeadScript** | **string** | JavaScript code injected into the head tag of the HTML page | [optional] [default to undefined]
+**jsBodyScript** | **string** | JavaScript code injected into the body tag of the HTML page | [optional] [default to undefined]
+**customDomain** | **string** | Custom domain name used by the company | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SimplePublicCompanyDTO } from '@caraer/client';
+
+const instance: SimplePublicCompanyDTO = {
+    uuid,
+    updatedAt,
+    website,
+    cookiePolicy,
+    favicon,
+    privacyPolicy,
+    accentColor,
+    twitterUrl,
+    primaryColor,
+    termsAndConditions,
+    facebookUrl,
+    youtubeUrl,
+    companyColor,
+    name,
+    logo,
+    instagramUrl,
+    fontColor,
+    secondaryColor,
+    rightNavBarButtonEnabled,
+    rightNavBarButtonTitle,
+    rightNavBarButtonLink,
+    cssScript,
+    jsHeadScript,
+    jsBodyScript,
+    customDomain,
+};
+```
+
+[[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/SingleCheckbox.md

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

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

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

@@ -0,0 +1,27 @@
+# SortItem
+
+Represents a sortable item, including object, relation, property, and sort direction.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **string** | The name of the object to which this pagination item belongs. | [optional] [default to undefined]
+**relation** | **string** | The relationship between objects. | [optional] [default to undefined]
+**property** | **string** | The name of the property within the object. | [optional] [default to undefined]
+**direction** | **string** | The direction for sorting. Can be ASC (ascending) or DESC (descending). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SortItem } from '@caraer/client';
+
+const instance: SortItem = {
+    object,
+    relation,
+    property,
+    direction,
+};
+```
+
+[[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/SseEmitter.md

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

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