@caraer/client 2.0.640 → 2.0.655

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/.openapi-generator/VERSION

@@ -1 +1 @@
-7.26.0
+7.27.0

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.
  */
@@ -3729,9 +3736,9 @@ export interface ModelRecord {
     'complete'?: boolean;
     'deleted'?: boolean;
     'uuid': string;
-    'user'?: PublicUserDTO;
     'properties'?: Array<FilledProperty>;
     'objects'?: { [key: string]: any | null; };
+    'user'?: PublicUserDTO;
 }
 export interface MultiFile extends PropertyFormat {
 }
@@ -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