@caraer/client 2.0.639 → 2.0.650

package/.openapi-generator/FILES

@@ -51,6 +51,7 @@ docs/AppSettingOptionsSource.md
 docs/AppSettingsSection.md
 docs/AppSubcategoryDTO.md
 docs/ApplicationsApi.md
+docs/ArchivedRecordObjectDTO.md
 docs/AutomationsApi.md
 docs/BillingApi.md
 docs/BillingSettingsDTO.md
@@ -337,6 +338,7 @@ docs/SuccessResponseListAggregateResponse.md
 docs/SuccessResponseListAppExternalOAuthProviderDTO.md
 docs/SuccessResponseListAppInboundRouteDTO.md
 docs/SuccessResponseListAppScheduleDTO.md
+docs/SuccessResponseListArchivedRecordObjectDTO.md
 docs/SuccessResponseListCalendarRecordDTO.md
 docs/SuccessResponseListCalendarTeamOptionDTO.md
 docs/SuccessResponseListCaraerObjectDTO.md

package/api.ts

@@ -1026,8 +1026,8 @@ export interface AppSettingFieldSchema {
     'clearValue'?: boolean;
     'mappingValue'?: AppSettingFieldMappingStructure;
     'valueScope'?: string;
-    'settingsGroup'?: boolean;
     'action'?: boolean;
+    'settingsGroup'?: boolean;
     'filterPropertyTypes'?: Array<string>;
     'filterPropertyFormats'?: Array<string>;
 }
@@ -1057,6 +1057,13 @@ export interface AppSubcategoryDTO {
      */
     'label'?: string;
 }
+export interface ArchivedRecordObjectDTO {
+    'uuid'?: string;
+    'name'?: string;
+    'label'?: string;
+    'icon'?: string;
+    'index'?: number;
+}
 /**
  * The billing settings of the company.
  */
@@ -2813,9 +2820,9 @@ export 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;
@@ -5389,7 +5396,7 @@ export interface RecordRelationRequestDTO {
      */
     'uuid'?: string;
     /**
-     * Properties to update on the existing record referenced by uuid before linking
+     * With uuid: patch the existing target before linking. Without uuid or record: create-or-update the target using its unique properties, then link. Use objectName when ambiguous.
      */
     'properties'?: { [key: string]: any | null; };
     /**
@@ -7249,6 +7256,19 @@ export interface SuccessResponseListAppScheduleDTO {
      */
     'data'?: Array<AppScheduleDTO>;
 }
+/**
+ * Represents a standard successful response with a message and optional data.
+ */
+export interface SuccessResponseListArchivedRecordObjectDTO {
+    /**
+     * A message detailing the result of the operation.
+     */
+    'message'?: string;
+    /**
+     * The data payload of the response, if any.
+     */
+    'data'?: Array<ArchivedRecordObjectDTO>;
+}
 /**
  * Represents a standard successful response with a message and optional data.
  */
@@ -26004,6 +26024,40 @@ export const RecordsApiAxiosParamCreator = function (configuration?: Configurati
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+         * @summary List objects with visible archived records
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archivedObjects: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v2/records/archived/objects`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
          * @summary Bulk delete records
@@ -27188,6 +27242,18 @@ export const RecordsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['RecordsApi.aggregateBatch']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+         * @summary List objects with visible archived records
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async archivedObjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListArchivedRecordObjectDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.archivedObjects(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['RecordsApi.archivedObjects']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
          * @summary Bulk delete records
@@ -27574,6 +27640,15 @@ export const RecordsApiFactory = function (configuration?: Configuration, basePa
         aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListAggregateResponse> {
             return localVarFp.aggregateBatch(aggregateBatchRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+         * @summary List objects with visible archived records
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archivedObjects(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListArchivedRecordObjectDTO> {
+            return localVarFp.archivedObjects(options).then((request) => request(axios, basePath));
+        },
         /**
          * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
          * @summary Bulk delete records
@@ -27895,6 +27970,16 @@ export class RecordsApi extends BaseAPI {
         return RecordsApiFp(this.configuration).aggregateBatch(aggregateBatchRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public archivedObjects(options?: RawAxiosRequestConfig) {
+        return RecordsApiFp(this.configuration).archivedObjects(options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records

package/dist/api.d.ts

@@ -1016,8 +1016,8 @@ export interface AppSettingFieldSchema {
     'clearValue'?: boolean;
     'mappingValue'?: AppSettingFieldMappingStructure;
     'valueScope'?: string;
-    'settingsGroup'?: boolean;
     'action'?: boolean;
+    'settingsGroup'?: boolean;
     'filterPropertyTypes'?: Array<string>;
     'filterPropertyFormats'?: Array<string>;
 }
@@ -1047,6 +1047,13 @@ export interface AppSubcategoryDTO {
      */
     'label'?: string;
 }
+export interface ArchivedRecordObjectDTO {
+    'uuid'?: string;
+    'name'?: string;
+    'label'?: string;
+    'icon'?: string;
+    'index'?: number;
+}
 /**
  * The billing settings of the company.
  */
@@ -2806,9 +2813,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;
@@ -5424,7 +5431,7 @@ export interface RecordRelationRequestDTO {
      */
     'uuid'?: string;
     /**
-     * Properties to update on the existing record referenced by uuid before linking
+     * With uuid: patch the existing target before linking. Without uuid or record: create-or-update the target using its unique properties, then link. Use objectName when ambiguous.
      */
     'properties'?: {
         [key: string]: any | null;
@@ -7352,6 +7359,19 @@ export interface SuccessResponseListAppScheduleDTO {
      */
     'data'?: Array<AppScheduleDTO>;
 }
+/**
+ * Represents a standard successful response with a message and optional data.
+ */
+export interface SuccessResponseListArchivedRecordObjectDTO {
+    /**
+     * A message detailing the result of the operation.
+     */
+    'message'?: string;
+    /**
+     * The data payload of the response, if any.
+     */
+    'data'?: Array<ArchivedRecordObjectDTO>;
+}
 /**
  * Represents a standard successful response with a message and optional data.
  */
@@ -16742,6 +16762,13 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     aggregateBatch: (aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records
@@ -17008,6 +17035,13 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListAggregateResponse>>;
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListArchivedRecordObjectDTO>>;
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records
@@ -17274,6 +17308,13 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListAggregateResponse>;
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListArchivedRecordObjectDTO>;
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records
@@ -17540,6 +17581,13 @@ export declare class RecordsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListAggregateResponse, any, {}>>;
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListArchivedRecordObjectDTO, any, {}>>;
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records

package/dist/api.js

@@ -16878,6 +16878,35 @@ const RecordsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+         * @summary List objects with visible archived records
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archivedObjects: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/v2/records/archived/objects`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication bearerAuth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
          * @summary Bulk delete records
@@ -17919,6 +17948,21 @@ const RecordsApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+         * @summary List objects with visible archived records
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archivedObjects(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.archivedObjects(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['RecordsApi.archivedObjects']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
          * @summary Bulk delete records
@@ -18371,6 +18415,15 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
         aggregateBatch(aggregateBatchRequest, options) {
             return localVarFp.aggregateBatch(aggregateBatchRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+         * @summary List objects with visible archived records
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archivedObjects(options) {
+            return localVarFp.archivedObjects(options).then((request) => request(axios, basePath));
+        },
         /**
          * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
          * @summary Bulk delete records
@@ -18689,6 +18742,15 @@ class RecordsApi extends base_1.BaseAPI {
     aggregateBatch(aggregateBatchRequest, options) {
         return (0, exports.RecordsApiFp)(this.configuration).aggregateBatch(aggregateBatchRequest, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects(options) {
+        return (0, exports.RecordsApiFp)(this.configuration).archivedObjects(options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records

package/dist/esm/api.d.ts

@@ -1016,8 +1016,8 @@ export interface AppSettingFieldSchema {
     'clearValue'?: boolean;
     'mappingValue'?: AppSettingFieldMappingStructure;
     'valueScope'?: string;
-    'settingsGroup'?: boolean;
     'action'?: boolean;
+    'settingsGroup'?: boolean;
     'filterPropertyTypes'?: Array<string>;
     'filterPropertyFormats'?: Array<string>;
 }
@@ -1047,6 +1047,13 @@ export interface AppSubcategoryDTO {
      */
     'label'?: string;
 }
+export interface ArchivedRecordObjectDTO {
+    'uuid'?: string;
+    'name'?: string;
+    'label'?: string;
+    'icon'?: string;
+    'index'?: number;
+}
 /**
  * The billing settings of the company.
  */
@@ -2806,9 +2813,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;
@@ -5424,7 +5431,7 @@ export interface RecordRelationRequestDTO {
      */
     'uuid'?: string;
     /**
-     * Properties to update on the existing record referenced by uuid before linking
+     * With uuid: patch the existing target before linking. Without uuid or record: create-or-update the target using its unique properties, then link. Use objectName when ambiguous.
      */
     'properties'?: {
         [key: string]: any | null;
@@ -7352,6 +7359,19 @@ export interface SuccessResponseListAppScheduleDTO {
      */
     'data'?: Array<AppScheduleDTO>;
 }
+/**
+ * Represents a standard successful response with a message and optional data.
+ */
+export interface SuccessResponseListArchivedRecordObjectDTO {
+    /**
+     * A message detailing the result of the operation.
+     */
+    'message'?: string;
+    /**
+     * The data payload of the response, if any.
+     */
+    'data'?: Array<ArchivedRecordObjectDTO>;
+}
 /**
  * Represents a standard successful response with a message and optional data.
  */
@@ -16742,6 +16762,13 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     aggregateBatch: (aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records
@@ -17008,6 +17035,13 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListAggregateResponse>>;
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListArchivedRecordObjectDTO>>;
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records
@@ -17274,6 +17308,13 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListAggregateResponse>;
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListArchivedRecordObjectDTO>;
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records
@@ -17540,6 +17581,13 @@ export declare class RecordsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListAggregateResponse, any, {}>>;
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListArchivedRecordObjectDTO, any, {}>>;
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records

package/dist/esm/api.js

@@ -16776,6 +16776,35 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+         * @summary List objects with visible archived records
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archivedObjects: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/v2/records/archived/objects`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication bearerAuth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
          * @summary Bulk delete records
@@ -17816,6 +17845,21 @@ export const RecordsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+         * @summary List objects with visible archived records
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archivedObjects(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.archivedObjects(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['RecordsApi.archivedObjects']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
          * @summary Bulk delete records
@@ -18267,6 +18311,15 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
         aggregateBatch(aggregateBatchRequest, options) {
             return localVarFp.aggregateBatch(aggregateBatchRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+         * @summary List objects with visible archived records
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        archivedObjects(options) {
+            return localVarFp.archivedObjects(options).then((request) => request(axios, basePath));
+        },
         /**
          * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
          * @summary Bulk delete records
@@ -18584,6 +18637,15 @@ export class RecordsApi extends BaseAPI {
     aggregateBatch(aggregateBatchRequest, options) {
         return RecordsApiFp(this.configuration).aggregateBatch(aggregateBatchRequest, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+     * @summary List objects with visible archived records
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    archivedObjects(options) {
+        return RecordsApiFp(this.configuration).archivedObjects(options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Archives, anonymizes, or permanently deletes multiple records in one request. Returns HTTP 200 when every item succeeds. Returns HTTP 200 with per-record errors when one or more items fail; successful items are still applied and listed in data.uuids.
      * @summary Bulk delete records

package/docs/AppSettingFieldSchema.md

@@ -33,8 +33,8 @@ Name | Type | Description | Notes
 **clearValue** | **boolean** |  | [optional] [default to undefined]
 **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) |  | [optional] [default to undefined]
 **valueScope** | **string** |  | [optional] [default to undefined]
-**settingsGroup** | **boolean** |  | [optional] [default to undefined]
 **action** | **boolean** |  | [optional] [default to undefined]
+**settingsGroup** | **boolean** |  | [optional] [default to undefined]
 **filterPropertyTypes** | **Array<string>** |  | [optional] [default to undefined]
 **filterPropertyFormats** | **Array<string>** |  | [optional] [default to undefined]
 
@@ -72,8 +72,8 @@ const instance: AppSettingFieldSchema = {
     clearValue,
     mappingValue,
     valueScope,
-    settingsGroup,
     action,
+    settingsGroup,
     filterPropertyTypes,
     filterPropertyFormats,
 };

package/docs/ArchivedRecordObjectDTO.md

@@ -0,0 +1,28 @@
+# ArchivedRecordObjectDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**index** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ArchivedRecordObjectDTO } from '@caraer/client';
+
+const instance: ArchivedRecordObjectDTO = {
+    uuid,
+    name,
+    label,
+    icon,
+    index,
+};
+```
+
+[[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/ExistingWidgetSummary.md

@@ -5,9 +5,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**xproperty** | **string** |  | [optional] [default to undefined]
 **ymetric** | **string** |  | [optional] [default to undefined]
 **yproperty** | **string** |  | [optional] [default to undefined]
+**xproperty** | **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 = {
-    xproperty,
     ymetric,
     yproperty,
+    xproperty,
     title,
     chartType,
     xProperty,

package/docs/RecordRelationRequestDTO.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **relationName** | **string** | Name of the relation type | [default to undefined]
 **uuid** | **string** | UUID of an existing record to link to | [optional] [default to undefined]
-**properties** | **{ [key: string]: any | null; }** | Properties to update on the existing record referenced by uuid before linking | [optional] [default to undefined]
+**properties** | **{ [key: string]: any | null; }** | With uuid: patch the existing target before linking. Without uuid or record: create-or-update the target using its unique properties, then link. Use objectName when ambiguous. | [optional] [default to undefined]
 **edgeProperties** | **{ [key: string]: any | null; }** | Values for properties declared on the relation schema, stored on the relation edge itself (not on either record). Omit to leave existing edge values untouched; a null value clears a key. | [optional] [default to undefined]
 **record** | [**RecordDTO**](RecordDTO.md) | Nested record to create or update (by uuid or unique properties) before linking | [optional] [default to undefined]
 **objectName** | **string** | Object name for nested record create when relation allows multiple target types | [optional] [default to undefined]

package/docs/RecordsApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://v2.api.caraer.com*
 |[**_delete**](#_delete) | **DELETE** /api/v2/records/{uuid} | Delete a record|
 |[**aggregate**](#aggregate) | **POST** /api/v2/records/aggregate | Aggregate records for analytics charts|
 |[**aggregateBatch**](#aggregatebatch) | **POST** /api/v2/records/aggregate/batch | Batch aggregate records for analytics dashboards|
+|[**archivedObjects**](#archivedobjects) | **GET** /api/v2/records/archived/objects | List objects with visible archived records|
 |[**bulkDelete**](#bulkdelete) | **POST** /api/v2/records/{objectName}/bulk-delete | Bulk delete records|
 |[**bulkEdit**](#bulkedit) | **PUT** /api/v2/records/{objectName}/bulk | Bulk create or update records|
 |[**create**](#create) | **POST** /api/v2/records/{objectName} | Create a new record|
@@ -202,6 +203,54 @@ const { status, data } = await apiInstance.aggregateBatch(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **archivedObjects**
+> SuccessResponseListArchivedRecordObjectDTO archivedObjects()
+
+Returns lightweight object metadata in display order. Includes primary and extended object contexts only when they contain an archived record visible under the current user\'s record permissions and access filters. Uses the selected company\'s database.
+
+### Example
+
+```typescript
+import {
+    RecordsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new RecordsApi(configuration);
+
+const { status, data } = await apiInstance.archivedObjects();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**SuccessResponseListArchivedRecordObjectDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **bulkDelete**
 > BulkDeleteRecordsResponse bulkDelete(bulkDeleteRecordsRequest)
 

package/docs/SuccessResponseListArchivedRecordObjectDTO.md

@@ -0,0 +1,23 @@
+# SuccessResponseListArchivedRecordObjectDTO
+
+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** | [**Array<ArchivedRecordObjectDTO>**](ArchivedRecordObjectDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SuccessResponseListArchivedRecordObjectDTO } from '@caraer/client';
+
+const instance: SuccessResponseListArchivedRecordObjectDTO = {
+    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.639",
+  "version": "2.0.650",
   "description": "Generated TypeScript client for the Caraer API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {