@caraer/client 2.0.528 → 2.0.530

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;
@@ -2582,8 +2584,8 @@ export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof t
 
 export interface ExistingWidgetSummary {
     'ymetric'?: string;
-    'yproperty'?: string;
     'xproperty'?: string;
+    'yproperty'?: 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.
  */
@@ -16435,7 +16473,7 @@ export const CMSV2TransferApiAxiosParamCreator = function (configuration?: Confi
     return {
         /**
          * 
-         * @summary Attach a manually created caraer-web project
+         * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
          * @param {string} companyUuid 
          * @param {{ [key: string]: string; }} requestBody 
          * @param {*} [options] Override http request option.
@@ -16601,7 +16639,7 @@ export const CMSV2TransferApiFp = function(configuration?: Configuration) {
     return {
         /**
          * 
-         * @summary Attach a manually created caraer-web project
+         * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
          * @param {string} companyUuid 
          * @param {{ [key: string]: string; }} requestBody 
          * @param {*} [options] Override http request option.
@@ -16663,7 +16701,7 @@ export const CMSV2TransferApiFactory = function (configuration?: Configuration,
     return {
         /**
          * 
-         * @summary Attach a manually created caraer-web project
+         * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
          * @param {string} companyUuid 
          * @param {{ [key: string]: string; }} requestBody 
          * @param {*} [options] Override http request option.
@@ -16711,7 +16749,7 @@ export const CMSV2TransferApiFactory = function (configuration?: Configuration,
 export class CMSV2TransferApi extends BaseAPI {
     /**
      * 
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid 
      * @param {{ [key: string]: string; }} requestBody 
      * @param {*} [options] Override http request option.

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;
@@ -2572,8 +2574,8 @@ export declare const EventRsvpRequestScopeEnum: {
 export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
 export interface ExistingWidgetSummary {
     'ymetric'?: string;
-    'yproperty'?: string;
     'xproperty'?: string;
+    'yproperty'?: 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.
  */
@@ -12259,7 +12297,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
 export declare const CMSV2TransferApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.
@@ -12299,7 +12337,7 @@ export declare const CMSV2TransferApiAxiosParamCreator: (configuration?: Configu
 export declare const CMSV2TransferApiFp: (configuration?: Configuration) => {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.
@@ -12339,7 +12377,7 @@ export declare const CMSV2TransferApiFp: (configuration?: Configuration) => {
 export declare const CMSV2TransferApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.
@@ -12379,7 +12417,7 @@ export declare const CMSV2TransferApiFactory: (configuration?: Configuration, ba
 export declare class CMSV2TransferApi extends BaseAPI {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.

package/dist/api.js

@@ -7950,7 +7950,7 @@ const CMSV2TransferApiAxiosParamCreator = function (configuration) {
     return {
         /**
          *
-         * @summary Attach a manually created caraer-web project
+         * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
          * @param {string} companyUuid
          * @param {{ [key: string]: string; }} requestBody
          * @param {*} [options] Override http request option.
@@ -8096,7 +8096,7 @@ const CMSV2TransferApiFp = function (configuration) {
     return {
         /**
          *
-         * @summary Attach a manually created caraer-web project
+         * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
          * @param {string} companyUuid
          * @param {{ [key: string]: string; }} requestBody
          * @param {*} [options] Override http request option.
@@ -8170,7 +8170,7 @@ const CMSV2TransferApiFactory = function (configuration, basePath, axios) {
     return {
         /**
          *
-         * @summary Attach a manually created caraer-web project
+         * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
          * @param {string} companyUuid
          * @param {{ [key: string]: string; }} requestBody
          * @param {*} [options] Override http request option.
@@ -8218,7 +8218,7 @@ exports.CMSV2TransferApiFactory = CMSV2TransferApiFactory;
 class CMSV2TransferApi extends base_1.BaseAPI {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.

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;
@@ -2572,8 +2574,8 @@ export declare const EventRsvpRequestScopeEnum: {
 export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
 export interface ExistingWidgetSummary {
     'ymetric'?: string;
-    'yproperty'?: string;
     'xproperty'?: string;
+    'yproperty'?: 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.
  */
@@ -12259,7 +12297,7 @@ export declare class CMSV2PublicApi extends BaseAPI {
 export declare const CMSV2TransferApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.
@@ -12299,7 +12337,7 @@ export declare const CMSV2TransferApiAxiosParamCreator: (configuration?: Configu
 export declare const CMSV2TransferApiFp: (configuration?: Configuration) => {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.
@@ -12339,7 +12377,7 @@ export declare const CMSV2TransferApiFp: (configuration?: Configuration) => {
 export declare const CMSV2TransferApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.
@@ -12379,7 +12417,7 @@ export declare const CMSV2TransferApiFactory: (configuration?: Configuration, ba
 export declare class CMSV2TransferApi extends BaseAPI {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.

package/dist/esm/api.js

@@ -7904,7 +7904,7 @@ export const CMSV2TransferApiAxiosParamCreator = function (configuration) {
     return {
         /**
          *
-         * @summary Attach a manually created caraer-web project
+         * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
          * @param {string} companyUuid
          * @param {{ [key: string]: string; }} requestBody
          * @param {*} [options] Override http request option.
@@ -8049,7 +8049,7 @@ export const CMSV2TransferApiFp = function (configuration) {
     return {
         /**
          *
-         * @summary Attach a manually created caraer-web project
+         * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
          * @param {string} companyUuid
          * @param {{ [key: string]: string; }} requestBody
          * @param {*} [options] Override http request option.
@@ -8122,7 +8122,7 @@ export const CMSV2TransferApiFactory = function (configuration, basePath, axios)
     return {
         /**
          *
-         * @summary Attach a manually created caraer-web project
+         * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
          * @param {string} companyUuid
          * @param {{ [key: string]: string; }} requestBody
          * @param {*} [options] Override http request option.
@@ -8169,7 +8169,7 @@ export const CMSV2TransferApiFactory = function (configuration, basePath, axios)
 export class CMSV2TransferApi extends BaseAPI {
     /**
      *
-     * @summary Attach a manually created caraer-web project
+     * @summary Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy
      * @param {string} companyUuid
      * @param {{ [key: string]: string; }} requestBody
      * @param {*} [options] Override http request option.

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/CMSV2TransferApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *https://v2.api.caraer.com*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**attach**](#attach) | **POST** /api/v2/company/{companyUuid}/cms-transfer/attach | Attach a manually created caraer-web project|
+|[**attach**](#attach) | **POST** /api/v2/company/{companyUuid}/cms-transfer/attach | Attach a project, link Caraer-HQ/caraer-web, write its v2 environment, and deploy|
 |[**cutover**](#cutover) | **POST** /api/v2/company/{companyUuid}/cms-transfer/cutover | Switch the live site to CMS v2: schema, caraer-web repo, and hostname|
 |[**rollback**](#rollback) | **POST** /api/v2/company/{companyUuid}/cms-transfer/rollback | Restore the live hostname to the stored v1 project|
 |[**status**](#status) | **GET** /api/v2/company/{companyUuid}/cms-transfer | Transfer status for one company|

package/docs/ExistingWidgetSummary.md

@@ -6,8 +6,8 @@
 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]
 **title** | **string** |  | [optional] [default to undefined]
 **chartType** | **string** |  | [optional] [default to undefined]
 **xProperty** | **string** |  | [optional] [default to undefined]
@@ -21,8 +21,8 @@ import { ExistingWidgetSummary } from '@caraer/client';
 
 const instance: ExistingWidgetSummary = {
     ymetric,
-    yproperty,
     xproperty,
+    yproperty,
     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.530",
   "description": "Generated TypeScript client for the Caraer API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {