@caraer/client 2.0.507 → 2.0.509

package/dist/esm/api.d.ts

@@ -1441,6 +1441,7 @@ export interface CmsPageModuleInstance {
 export interface CmsPagePatch {
     'op'?: string;
     'moduleId'?: string;
+    'ref'?: string;
     'field'?: string;
     'value'?: any;
     'fields'?: {
@@ -2566,9 +2567,9 @@ export declare const EventRsvpRequestScopeEnum: {
 };
 export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
 export interface ExistingWidgetSummary {
-    'xproperty'?: string;
     'ymetric'?: string;
     'yproperty'?: string;
+    'xproperty'?: string;
     'title'?: string;
     'chartType'?: string;
     'xProperty'?: string;
@@ -3498,11 +3499,11 @@ export interface ModelRecord {
     'deleted'?: boolean;
     'complete'?: boolean;
     'uuid': string;
+    'user'?: PublicUserDTO;
     'properties'?: Array<FilledProperty>;
     'objects'?: {
         [key: string]: any | null;
     };
-    'user'?: PublicUserDTO;
 }
 export interface MultiFile extends PropertyFormat {
 }
@@ -5736,8 +5737,8 @@ export interface SettingField {
     'hidden'?: boolean;
     'disabled'?: boolean;
     'options'?: Array<SettingOption>;
-    'defaultValue'?: any;
     'value'?: any;
+    'defaultValue'?: any;
 }
 export declare const SettingFieldTypeEnum: {
     readonly String: "STRING";
@@ -10734,6 +10735,15 @@ export declare const CMSV2PagesApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     createTranslation: (recordUuid: string, key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Discard a Modify-this-module playground session
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    discardModuleFork: (recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page.
      * @summary Create or reuse the custom 404 page
@@ -10812,6 +10822,18 @@ export declare const CMSV2PagesApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     previewLink: (recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Rewrite forked module source from a prompt
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    promptModuleFork: (recordUuid: string, sessionId: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
      * @summary Publish one locale, or all of them
@@ -10854,6 +10876,18 @@ export declare const CMSV2PagesApiAxiosParamCreator: (configuration?: Configurat
     saveMeta: (recordUuid: string, requestBody: {
         [key: string]: any | null;
     }, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module.
+     * @summary Publish the forked module into a private app
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    saveModuleFork: (recordUuid: string, sessionId: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Replace a CMS v2 object template
@@ -10864,6 +10898,17 @@ export declare const CMSV2PagesApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     saveTemplate: (objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * CMS v2 companies and pages only. Copies the installed module\'s published source into a playground session. Live code edits stay off the company site until save publishes a platform v2 private-app package and a rebuild compiles it.
+     * @summary Start a Modify-this-module playground session
+     * @param {string} recordUuid
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startModuleFork: (recordUuid: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Take one locale offline
@@ -10907,6 +10952,15 @@ export declare const CMSV2PagesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
+    /**
+     *
+     * @summary Discard a Modify-this-module playground session
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
     /**
      * Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page.
      * @summary Create or reuse the custom 404 page
@@ -10985,6 +11039,18 @@ export declare const CMSV2PagesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
+    /**
+     *
+     * @summary Rewrite forked module source from a prompt
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    promptModuleFork(recordUuid: string, sessionId: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
     /**
      * Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
      * @summary Publish one locale, or all of them
@@ -11027,6 +11093,18 @@ export declare const CMSV2PagesApiFp: (configuration?: Configuration) => {
     saveMeta(recordUuid: string, requestBody: {
         [key: string]: any | null;
     }, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDTO>>;
+    /**
+     * Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module.
+     * @summary Publish the forked module into a private app
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    saveModuleFork(recordUuid: string, sessionId: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
     /**
      *
      * @summary Replace a CMS v2 object template
@@ -11037,6 +11115,17 @@ export declare const CMSV2PagesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseCmsPageDocument>>;
+    /**
+     * CMS v2 companies and pages only. Copies the installed module\'s published source into a playground session. Live code edits stay off the company site until save publishes a platform v2 private-app package and a rebuild compiles it.
+     * @summary Start a Modify-this-module playground session
+     * @param {string} recordUuid
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startModuleFork(recordUuid: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
     /**
      *
      * @summary Take one locale offline
@@ -11080,6 +11169,15 @@ export declare const CMSV2PagesApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
+    /**
+     *
+     * @summary Discard a Modify-this-module playground session
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
     /**
      * Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page.
      * @summary Create or reuse the custom 404 page
@@ -11158,6 +11256,18 @@ export declare const CMSV2PagesApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
+    /**
+     *
+     * @summary Rewrite forked module source from a prompt
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    promptModuleFork(recordUuid: string, sessionId: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
     /**
      * Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
      * @summary Publish one locale, or all of them
@@ -11200,6 +11310,18 @@ export declare const CMSV2PagesApiFactory: (configuration?: Configuration, baseP
     saveMeta(recordUuid: string, requestBody: {
         [key: string]: any | null;
     }, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDTO>;
+    /**
+     * Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module.
+     * @summary Publish the forked module into a private app
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    saveModuleFork(recordUuid: string, sessionId: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
     /**
      *
      * @summary Replace a CMS v2 object template
@@ -11210,6 +11332,17 @@ export declare const CMSV2PagesApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseCmsPageDocument>;
+    /**
+     * CMS v2 companies and pages only. Copies the installed module\'s published source into a playground session. Live code edits stay off the company site until save publishes a platform v2 private-app package and a rebuild compiles it.
+     * @summary Start a Modify-this-module playground session
+     * @param {string} recordUuid
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startModuleFork(recordUuid: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
     /**
      *
      * @summary Take one locale offline
@@ -11253,6 +11386,15 @@ export declare class CMSV2PagesApi extends BaseAPI {
      * @throws {RequiredError}
      */
     createTranslation(recordUuid: string, key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
+    /**
+     *
+     * @summary Discard a Modify-this-module playground session
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    discardModuleFork(recordUuid: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
     /**
      * Finds the page at /404 on the root Webpage object, or creates an empty draft there, and stores it as the company custom 404 page.
      * @summary Create or reuse the custom 404 page
@@ -11331,6 +11473,18 @@ export declare class CMSV2PagesApi extends BaseAPI {
      * @throws {RequiredError}
      */
     previewLink(recordUuid: string, locale?: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
+    /**
+     *
+     * @summary Rewrite forked module source from a prompt
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    promptModuleFork(recordUuid: string, sessionId: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
     /**
      * Copies the draft over the published document. Publishing is per locale so a translated page can ship without republishing the others.
      * @summary Publish one locale, or all of them
@@ -11373,6 +11527,18 @@ export declare class CMSV2PagesApi extends BaseAPI {
     saveMeta(recordUuid: string, requestBody: {
         [key: string]: any | null;
     }, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDTO, any, {}>>;
+    /**
+     * Merges the new module into the whole npm package so sibling modules are not retired, then swaps this placement with set_module.
+     * @summary Publish the forked module into a private app
+     * @param {string} recordUuid
+     * @param {string} sessionId
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    saveModuleFork(recordUuid: string, sessionId: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
     /**
      *
      * @summary Replace a CMS v2 object template
@@ -11383,6 +11549,17 @@ export declare class CMSV2PagesApi extends BaseAPI {
      * @throws {RequiredError}
      */
     saveTemplate(objectUuid: string, cmsPageDocument: CmsPageDocument, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseCmsPageDocument, any, {}>>;
+    /**
+     * CMS v2 companies and pages only. Copies the installed module\'s published source into a playground session. Live code edits stay off the company site until save publishes a platform v2 private-app package and a rebuild compiles it.
+     * @summary Start a Modify-this-module playground session
+     * @param {string} recordUuid
+     * @param {{ [key: string]: any | null; }} requestBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startModuleFork(recordUuid: string, requestBody: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
     /**
      *
      * @summary Take one locale offline