@caraer/client 2.0.528 → 2.0.529

package/.openapi-generator/FILES

@@ -129,6 +129,9 @@ docs/EventRsvpRequest.md
 docs/ExistingWidgetSummary.md
 docs/ExtendRecordRequest.md
 docs/FeedDTO.md
+docs/FeedFormatPreviewDTO.md
+docs/FeedFormatPreviewRequest.md
+docs/FeedFormatSuggestionRequest.md
 docs/FeedImportRunDTO.md
 docs/FeedsApi.md
 docs/File.md
@@ -328,6 +331,7 @@ docs/SuccessResponseCalendarBootstrapDTO.md
 docs/SuccessResponseCollectionRelation.md
 docs/SuccessResponseCompanyDTO.md
 docs/SuccessResponseFeedDTO.md
+docs/SuccessResponseFeedFormatPreviewDTO.md
 docs/SuccessResponseFeedImportRunDTO.md
 docs/SuccessResponseFlow.md
 docs/SuccessResponseListAggregateResponse.md

package/api.ts

@@ -967,6 +967,8 @@ export interface AppSettingFieldMappingStructureItem {
     'relationName'?: string;
     'objectName'?: string;
     'recordUuid'?: string;
+    'formatPattern'?: string;
+    'formatReplacement'?: string;
 }
 export interface AppSettingFieldSchema {
     'name'?: string;
@@ -2581,9 +2583,9 @@ export const EventRsvpRequestScopeEnum = {
 export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
 
 export interface ExistingWidgetSummary {
-    'ymetric'?: string;
-    'yproperty'?: string;
     'xproperty'?: string;
+    'yproperty'?: string;
+    'ymetric'?: string;
     'title'?: string;
     'chartType'?: string;
     'xProperty'?: string;
@@ -2678,6 +2680,29 @@ export interface FeedDTO {
     'availableEnvironments'?: Array<string>;
     'siblingImportFeeds'?: Array<string>;
 }
+export interface FeedFormatPreviewDTO {
+    'sample'?: string;
+    'formatPattern'?: string;
+    'formatReplacement'?: string;
+    'output'?: string;
+    'matches'?: boolean;
+    'storedValuePattern'?: string;
+    'storedValueHint'?: string;
+    'formatName'?: string;
+}
+export interface FeedFormatPreviewRequest {
+    'sample'?: string;
+    'formatPattern'?: string;
+    'formatReplacement'?: string;
+    'propertyName'?: string;
+    'objectName'?: string;
+}
+export interface FeedFormatSuggestionRequest {
+    'feed'?: FeedDTO;
+    'fieldName'?: string;
+    'propertyName'?: string;
+    'objectName'?: string;
+}
 export interface FeedImportRunDTO {
     'dryRun'?: boolean;
     'status'?: string;
@@ -6955,6 +6980,19 @@ export interface SuccessResponseFeedDTO {
      */
     'data'?: FeedDTO;
 }
+/**
+ * Represents a standard successful response with a message and optional data.
+ */
+export interface SuccessResponseFeedFormatPreviewDTO {
+    /**
+     * A message detailing the result of the operation.
+     */
+    'message'?: string;
+    /**
+     * The data payload of the response, if any.
+     */
+    'data'?: FeedFormatPreviewDTO;
+}
 /**
  * Represents a standard successful response with a message and optional data.
  */

package/dist/api.d.ts

@@ -957,6 +957,8 @@ export interface AppSettingFieldMappingStructureItem {
     'relationName'?: string;
     'objectName'?: string;
     'recordUuid'?: string;
+    'formatPattern'?: string;
+    'formatReplacement'?: string;
 }
 export interface AppSettingFieldSchema {
     'name'?: string;
@@ -2571,9 +2573,9 @@ export declare const EventRsvpRequestScopeEnum: {
 };
 export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
 export interface ExistingWidgetSummary {
-    'ymetric'?: string;
-    'yproperty'?: string;
     'xproperty'?: string;
+    'yproperty'?: string;
+    'ymetric'?: string;
     'title'?: string;
     'chartType'?: string;
     'xProperty'?: string;
@@ -2668,6 +2670,29 @@ export interface FeedDTO {
     'availableEnvironments'?: Array<string>;
     'siblingImportFeeds'?: Array<string>;
 }
+export interface FeedFormatPreviewDTO {
+    'sample'?: string;
+    'formatPattern'?: string;
+    'formatReplacement'?: string;
+    'output'?: string;
+    'matches'?: boolean;
+    'storedValuePattern'?: string;
+    'storedValueHint'?: string;
+    'formatName'?: string;
+}
+export interface FeedFormatPreviewRequest {
+    'sample'?: string;
+    'formatPattern'?: string;
+    'formatReplacement'?: string;
+    'propertyName'?: string;
+    'objectName'?: string;
+}
+export interface FeedFormatSuggestionRequest {
+    'feed'?: FeedDTO;
+    'fieldName'?: string;
+    'propertyName'?: string;
+    'objectName'?: string;
+}
 export interface FeedImportRunDTO {
     'dryRun'?: boolean;
     'status'?: string;
@@ -7057,6 +7082,19 @@ export interface SuccessResponseFeedDTO {
      */
     'data'?: FeedDTO;
 }
+/**
+ * Represents a standard successful response with a message and optional data.
+ */
+export interface SuccessResponseFeedFormatPreviewDTO {
+    /**
+     * A message detailing the result of the operation.
+     */
+    'message'?: string;
+    /**
+     * The data payload of the response, if any.
+     */
+    'data'?: FeedFormatPreviewDTO;
+}
 /**
  * Represents a standard successful response with a message and optional data.
  */

package/dist/esm/api.d.ts

@@ -957,6 +957,8 @@ export interface AppSettingFieldMappingStructureItem {
     'relationName'?: string;
     'objectName'?: string;
     'recordUuid'?: string;
+    'formatPattern'?: string;
+    'formatReplacement'?: string;
 }
 export interface AppSettingFieldSchema {
     'name'?: string;
@@ -2571,9 +2573,9 @@ export declare const EventRsvpRequestScopeEnum: {
 };
 export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
 export interface ExistingWidgetSummary {
-    'ymetric'?: string;
-    'yproperty'?: string;
     'xproperty'?: string;
+    'yproperty'?: string;
+    'ymetric'?: string;
     'title'?: string;
     'chartType'?: string;
     'xProperty'?: string;
@@ -2668,6 +2670,29 @@ export interface FeedDTO {
     'availableEnvironments'?: Array<string>;
     'siblingImportFeeds'?: Array<string>;
 }
+export interface FeedFormatPreviewDTO {
+    'sample'?: string;
+    'formatPattern'?: string;
+    'formatReplacement'?: string;
+    'output'?: string;
+    'matches'?: boolean;
+    'storedValuePattern'?: string;
+    'storedValueHint'?: string;
+    'formatName'?: string;
+}
+export interface FeedFormatPreviewRequest {
+    'sample'?: string;
+    'formatPattern'?: string;
+    'formatReplacement'?: string;
+    'propertyName'?: string;
+    'objectName'?: string;
+}
+export interface FeedFormatSuggestionRequest {
+    'feed'?: FeedDTO;
+    'fieldName'?: string;
+    'propertyName'?: string;
+    'objectName'?: string;
+}
 export interface FeedImportRunDTO {
     'dryRun'?: boolean;
     'status'?: string;
@@ -7057,6 +7082,19 @@ export interface SuccessResponseFeedDTO {
      */
     'data'?: FeedDTO;
 }
+/**
+ * Represents a standard successful response with a message and optional data.
+ */
+export interface SuccessResponseFeedFormatPreviewDTO {
+    /**
+     * A message detailing the result of the operation.
+     */
+    'message'?: string;
+    /**
+     * The data payload of the response, if any.
+     */
+    'data'?: FeedFormatPreviewDTO;
+}
 /**
  * Represents a standard successful response with a message and optional data.
  */

package/docs/AppSettingFieldMappingStructureItem.md

@@ -16,6 +16,8 @@ Name | Type | Description | Notes
 **relationName** | **string** |  | [optional] [default to undefined]
 **objectName** | **string** |  | [optional] [default to undefined]
 **recordUuid** | **string** |  | [optional] [default to undefined]
+**formatPattern** | **string** |  | [optional] [default to undefined]
+**formatReplacement** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -34,6 +36,8 @@ const instance: AppSettingFieldMappingStructureItem = {
     relationName,
     objectName,
     recordUuid,
+    formatPattern,
+    formatReplacement,
 };
 ```
 

package/docs/ExistingWidgetSummary.md

@@ -5,9 +5,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ymetric** | **string** |  | [optional] [default to undefined]
-**yproperty** | **string** |  | [optional] [default to undefined]
 **xproperty** | **string** |  | [optional] [default to undefined]
+**yproperty** | **string** |  | [optional] [default to undefined]
+**ymetric** | **string** |  | [optional] [default to undefined]
 **title** | **string** |  | [optional] [default to undefined]
 **chartType** | **string** |  | [optional] [default to undefined]
 **xProperty** | **string** |  | [optional] [default to undefined]
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
 import { ExistingWidgetSummary } from '@caraer/client';
 
 const instance: ExistingWidgetSummary = {
-    ymetric,
-    yproperty,
     xproperty,
+    yproperty,
+    ymetric,
     title,
     chartType,
     xProperty,

package/docs/FeedFormatPreviewDTO.md

@@ -0,0 +1,34 @@
+# FeedFormatPreviewDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sample** | **string** |  | [optional] [default to undefined]
+**formatPattern** | **string** |  | [optional] [default to undefined]
+**formatReplacement** | **string** |  | [optional] [default to undefined]
+**output** | **string** |  | [optional] [default to undefined]
+**matches** | **boolean** |  | [optional] [default to undefined]
+**storedValuePattern** | **string** |  | [optional] [default to undefined]
+**storedValueHint** | **string** |  | [optional] [default to undefined]
+**formatName** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FeedFormatPreviewDTO } from '@caraer/client';
+
+const instance: FeedFormatPreviewDTO = {
+    sample,
+    formatPattern,
+    formatReplacement,
+    output,
+    matches,
+    storedValuePattern,
+    storedValueHint,
+    formatName,
+};
+```
+
+[[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/FeedFormatPreviewRequest.md

@@ -0,0 +1,28 @@
+# FeedFormatPreviewRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sample** | **string** |  | [optional] [default to undefined]
+**formatPattern** | **string** |  | [optional] [default to undefined]
+**formatReplacement** | **string** |  | [optional] [default to undefined]
+**propertyName** | **string** |  | [optional] [default to undefined]
+**objectName** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FeedFormatPreviewRequest } from '@caraer/client';
+
+const instance: FeedFormatPreviewRequest = {
+    sample,
+    formatPattern,
+    formatReplacement,
+    propertyName,
+    objectName,
+};
+```
+
+[[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/FeedFormatSuggestionRequest.md

@@ -0,0 +1,26 @@
+# FeedFormatSuggestionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**feed** | [**FeedDTO**](FeedDTO.md) |  | [optional] [default to undefined]
+**fieldName** | **string** |  | [optional] [default to undefined]
+**propertyName** | **string** |  | [optional] [default to undefined]
+**objectName** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FeedFormatSuggestionRequest } from '@caraer/client';
+
+const instance: FeedFormatSuggestionRequest = {
+    feed,
+    fieldName,
+    propertyName,
+    objectName,
+};
+```
+
+[[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/SuccessResponseFeedFormatPreviewDTO.md

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

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