@caraer/client 2.0.576 → 2.0.583

package/dist/esm/api.d.ts

@@ -985,6 +985,7 @@ export interface AppSettingFieldSchema {
     'itemLabel'?: string;
     'value'?: any;
     'hasValue'?: boolean;
+    'clearValue'?: boolean;
     'mappingValue'?: AppSettingFieldMappingStructure;
     'valueScope'?: string;
     'settingsGroup'?: boolean;
@@ -2762,8 +2763,8 @@ export declare const EventRsvpRequestScopeEnum: {
 };
 export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
 export interface ExistingWidgetSummary {
-    'yproperty'?: string;
     'xproperty'?: string;
+    'yproperty'?: string;
     'ymetric'?: string;
     'title'?: string;
     'chartType'?: string;
@@ -5370,7 +5371,7 @@ export interface RecordDTO {
      */
     'index'?: number;
     /**
-     * Property values as a name→value map, or a LEGACY array of {name,type,value} objects (same shape as LEGACY GET responses).
+     * Property values as a name→value map, or a LEGACY array of {name,type,value} objects (same shape as LEGACY GET responses). File properties accept existing company file keys/URLs, an inline upload object {fileName,contentBase64,contentType?}, or a base64 data URL. Bare base64 bytes require the object form with fileName. Multi-file properties also accept an ordered array mixing existing keys/URLs and inline uploads; semicolon-separated keys and null remain supported. Uploads are stored as ordinary file keys after authorization and property validation. File type and configured upload size limits apply; base64 text counts toward the request limit.
      */
     'properties'?: {
         [key: string]: any | null;
@@ -8207,6 +8208,8 @@ export interface WebpageAccessGrantDTO {
  * Data transfer object representing a webpage with its various states, properties, and associated form/versions
  */
 export interface WebpageDTO {
+    'canonicalUrl'?: string;
+    'lastModified'?: string;
     /**
      * The environment of the webpage.
      */
@@ -8432,6 +8435,7 @@ export interface WebpageUnlockRequest {
 export interface WebsiteSettingsDTO {
     'subdomain'?: string;
     'customDomain'?: string;
+    'primaryEnvironment'?: string;
     'recordType'?: string;
     'recordValue'?: string;
     'favicon'?: string;
@@ -9570,7 +9574,7 @@ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configur
      */
     getAppWebhooks: (appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
+     * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
      * @summary Retrieve a paginated list of applications
      * @param {PaginationRequest} paginationRequest
      * @param {string} [type]
@@ -9846,7 +9850,7 @@ export declare const ApplicationsApiFp: (configuration?: Configuration) => {
      */
     getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponseSubscribeWebhookDTO>>;
     /**
-     * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
+     * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
      * @summary Retrieve a paginated list of applications
      * @param {PaginationRequest} paginationRequest
      * @param {string} [type]
@@ -10130,7 +10134,7 @@ export declare const ApplicationsApiFactory: (configuration?: Configuration, bas
      */
     getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponseSubscribeWebhookDTO>;
     /**
-     * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
+     * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
      * @summary Retrieve a paginated list of applications
      * @param {PaginationRequest} paginationRequest
      * @param {string} [type]
@@ -10414,7 +10418,7 @@ export declare class ApplicationsApi extends BaseAPI {
      */
     getAppWebhooks(appUuid: string, paginationRequest: PaginationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponseSubscribeWebhookDTO, any, {}>>;
     /**
-     * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
+     * Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
      * @summary Retrieve a paginated list of applications
      * @param {PaginationRequest} paginationRequest
      * @param {string} [type]
@@ -12083,10 +12087,11 @@ export declare const CMSV2PublicApiAxiosParamCreator: (configuration?: Configura
      *
      * @summary Installed apps and modules for a company\'s website build
      * @param {string} xCaraerSubdomain
+     * @param {string} [channel]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    buildManifest: (xCaraerSubdomain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    buildManifest: (xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Navigation menus for the header and footer
@@ -12222,10 +12227,11 @@ export declare const CMSV2PublicApiFp: (configuration?: Configuration) => {
      *
      * @summary Installed apps and modules for a company\'s website build
      * @param {string} xCaraerSubdomain
+     * @param {string} [channel]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
+    buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
     /**
      *
      * @summary Navigation menus for the header and footer
@@ -12361,10 +12367,11 @@ export declare const CMSV2PublicApiFactory: (configuration?: Configuration, base
      *
      * @summary Installed apps and modules for a company\'s website build
      * @param {string} xCaraerSubdomain
+     * @param {string} [channel]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
+    buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
     /**
      *
      * @summary Navigation menus for the header and footer
@@ -12500,10 +12507,11 @@ export declare class CMSV2PublicApi extends BaseAPI {
      *
      * @summary Installed apps and modules for a company\'s website build
      * @param {string} xCaraerSubdomain
+     * @param {string} [channel]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    buildManifest(xCaraerSubdomain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
+    buildManifest(xCaraerSubdomain: string, channel?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
     /**
      *
      * @summary Navigation menus for the header and footer
@@ -12764,6 +12772,122 @@ export declare class CMSV2TransferApi extends BaseAPI {
      */
     status(companyUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
 }
+/**
+ * CMSWebsiteUpdatesApi - axios parameter creator
+ */
+export declare const CMSWebsiteUpdatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Pending module updates for this website
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pending: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Build a preview site with every pending module update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    preview: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Rejected with 409 when the preview revision is no longer the current pending set.
+     * @summary Promote a previewed module set to production
+     * @param {{ [key: string]: any | null; }} [requestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    promote: (requestBody?: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CMSWebsiteUpdatesApi - functional programming interface
+ */
+export declare const CMSWebsiteUpdatesApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Pending module updates for this website
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pending(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
+    /**
+     *
+     * @summary Build a preview site with every pending module update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    preview(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
+    /**
+     * Rejected with 409 when the preview revision is no longer the current pending set.
+     * @summary Promote a previewed module set to production
+     * @param {{ [key: string]: any | null; }} [requestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    promote(requestBody?: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
+};
+/**
+ * CMSWebsiteUpdatesApi - factory interface
+ */
+export declare const CMSWebsiteUpdatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Pending module updates for this website
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pending(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
+    /**
+     *
+     * @summary Build a preview site with every pending module update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    preview(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
+    /**
+     * Rejected with 409 when the preview revision is no longer the current pending set.
+     * @summary Promote a previewed module set to production
+     * @param {{ [key: string]: any | null; }} [requestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    promote(requestBody?: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
+};
+/**
+ * CMSWebsiteUpdatesApi - object-oriented interface
+ */
+export declare class CMSWebsiteUpdatesApi extends BaseAPI {
+    /**
+     *
+     * @summary Pending module updates for this website
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pending(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
+    /**
+     *
+     * @summary Build a preview site with every pending module update
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    preview(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
+    /**
+     * Rejected with 409 when the preview revision is no longer the current pending set.
+     * @summary Promote a previewed module set to production
+     * @param {{ [key: string]: any | null; }} [requestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    promote(requestBody?: {
+        [key: string]: any | null;
+    }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
+}
 /**
  * CalendarsApi - axios parameter creator
  */
@@ -15943,7 +16067,7 @@ export declare const PropertyApiAxiosParamCreator: (configuration?: Configuratio
      */
     getPropertyCalculationTypes: (objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Deletes the soft-deleted HAS_PROPERTY link to this object. If the property is not linked to any other object, the property node is hard-deleted.
+     * Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
      * @summary Permanently remove archived property
      * @param {string} objectUuid
      * @param {string} propertyUuid
@@ -16075,7 +16199,7 @@ export declare const PropertyApiFp: (configuration?: Configuration) => {
      */
     getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListString>>;
     /**
-     * Deletes the soft-deleted HAS_PROPERTY link to this object. If the property is not linked to any other object, the property node is hard-deleted.
+     * Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
      * @summary Permanently remove archived property
      * @param {string} objectUuid
      * @param {string} propertyUuid
@@ -16207,7 +16331,7 @@ export declare const PropertyApiFactory: (configuration?: Configuration, basePat
      */
     getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListString>;
     /**
-     * Deletes the soft-deleted HAS_PROPERTY link to this object. If the property is not linked to any other object, the property node is hard-deleted.
+     * Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
      * @summary Permanently remove archived property
      * @param {string} objectUuid
      * @param {string} propertyUuid
@@ -16339,7 +16463,7 @@ export declare class PropertyApi extends BaseAPI {
      */
     getPropertyCalculationTypes(objectUuid: string, propertyUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListString, any, {}>>;
     /**
-     * Deletes the soft-deleted HAS_PROPERTY link to this object. If the property is not linked to any other object, the property node is hard-deleted.
+     * Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
      * @summary Permanently remove archived property
      * @param {string} objectUuid
      * @param {string} propertyUuid
@@ -16551,11 +16675,11 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
      * @param {string} uuid
      * @param {string} name
      * @param {string} [object] Optional object name used to resolve the record before building the preview.
-     * @param {PreviewParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
+     * @param {Preview1ParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    preview: (uuid: string, name: string, object?: string, parse?: PreviewParseEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    preview1: (uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
      * @summary Advanced graph-aware record query
@@ -16817,11 +16941,11 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
      * @param {string} uuid
      * @param {string} name
      * @param {string} [object] Optional object name used to resolve the record before building the preview.
-     * @param {PreviewParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
+     * @param {Preview1ParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    preview(uuid: string, name: string, object?: string, parse?: PreviewParseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponsePreviewDTO>>;
+    preview1(uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponsePreviewDTO>>;
     /**
      * Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
      * @summary Advanced graph-aware record query
@@ -17083,11 +17207,11 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
      * @param {string} uuid
      * @param {string} name
      * @param {string} [object] Optional object name used to resolve the record before building the preview.
-     * @param {PreviewParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
+     * @param {Preview1ParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    preview(uuid: string, name: string, object?: string, parse?: PreviewParseEnum, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponsePreviewDTO>;
+    preview1(uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponsePreviewDTO>;
     /**
      * Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
      * @summary Advanced graph-aware record query
@@ -17349,11 +17473,11 @@ export declare class RecordsApi extends BaseAPI {
      * @param {string} uuid
      * @param {string} name
      * @param {string} [object] Optional object name used to resolve the record before building the preview.
-     * @param {PreviewParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
+     * @param {Preview1ParseEnum} [parse] Value presentation mode: omit/false/db for raw stored values; true/human_readable for display strings; structured for rich JSON (e.g. PropertyOption arrays, related records).
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    preview(uuid: string, name: string, object?: string, parse?: PreviewParseEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponsePreviewDTO, any, {}>>;
+    preview1(uuid: string, name: string, object?: string, parse?: Preview1ParseEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponsePreviewDTO, any, {}>>;
     /**
      * Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
      * @summary Advanced graph-aware record query
@@ -17514,12 +17638,12 @@ export declare const IndexFlowParseEnum: {
     readonly Structured: "STRUCTURED";
 };
 export type IndexFlowParseEnum = typeof IndexFlowParseEnum[keyof typeof IndexFlowParseEnum];
-export declare const PreviewParseEnum: {
+export declare const Preview1ParseEnum: {
     readonly Db: "DB";
     readonly HumanReadable: "HUMAN_READABLE";
     readonly Structured: "STRUCTURED";
 };
-export type PreviewParseEnum = typeof PreviewParseEnum[keyof typeof PreviewParseEnum];
+export type Preview1ParseEnum = typeof Preview1ParseEnum[keyof typeof Preview1ParseEnum];
 export declare const SearchParseEnum: {
     readonly Db: "DB";
     readonly HumanReadable: "HUMAN_READABLE";