@caraer/client 2.0.640 → 2.0.655

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.js CHANGED
@@ -21,12 +21,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  step((generator = generator.apply(thisArg, _arguments || [])).next());
22
22
  });
23
23
  };
24
+ var __importDefault = (this && this.__importDefault) || function (mod) {
25
+ return (mod && mod.__esModule) ? mod : { "default": mod };
26
+ };
24
27
  Object.defineProperty(exports, "__esModule", { value: true });
25
28
  exports.CMSV2PublicApiAxiosParamCreator = exports.CMSV2PagesApi = exports.CMSV2PagesApiFactory = exports.CMSV2PagesApiFp = exports.CMSV2PagesApiAxiosParamCreator = exports.CMSV2EnvironmentsApi = exports.CMSV2EnvironmentsApiFactory = exports.CMSV2EnvironmentsApiFp = exports.CMSV2EnvironmentsApiAxiosParamCreator = exports.CMSModulesApi = exports.CMSModulesApiFactory = exports.CMSModulesApiFp = exports.CMSModulesApiAxiosParamCreator = exports.BillingApi = exports.BillingApiFactory = exports.BillingApiFp = exports.BillingApiAxiosParamCreator = exports.AutomationsApi = exports.AutomationsApiFactory = exports.AutomationsApiFp = exports.AutomationsApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AppInstallationRuntimeApi = exports.AppInstallationRuntimeApiFactory = exports.AppInstallationRuntimeApiFp = exports.AppInstallationRuntimeApiAxiosParamCreator = exports.ListAppBarsLocationEnum = exports.AppBarsApi = exports.AppBarsApiFactory = exports.AppBarsApiFp = exports.AppBarsApiAxiosParamCreator = exports.AppBarIframeSessionsApi = exports.AppBarIframeSessionsApiFactory = exports.AppBarIframeSessionsApiFp = exports.AppBarIframeSessionsApiAxiosParamCreator = exports.ValidationErrorTypeEnum = exports.SortItemDirectionEnum = exports.SettingFieldTypeEnum = exports.EventRsvpRequestScopeEnum = exports.EventRsvpRequestPartstatEnum = exports.ErrorResponseRolesEnum = exports.CreatePrivateAppRequestAuthMethodEnum = exports.CaraerErrorTypeTypeEnum = exports.AppDTOAuthMethodEnum = exports.AppBarDTOLocationEnum = exports.AdvancedRecordQueryRequestStrategyEnum = exports.AdvancedRecordQueryPlanStrategyEnum = void 0;
26
29
  exports.NotificationsApiFactory = exports.NotificationsApiFp = exports.NotificationsApiAxiosParamCreator = exports.ModuleApi = exports.ModuleApiFactory = exports.ModuleApiFp = exports.ModuleApiAxiosParamCreator = exports.FormsApi = exports.FormsApiFactory = exports.FormsApiFp = exports.FormsApiAxiosParamCreator = exports.FilterApi = exports.FilterApiFactory = exports.FilterApiFp = exports.FilterApiAxiosParamCreator = exports.FileManagementApi = exports.FileManagementApiFactory = exports.FileManagementApiFp = exports.FileManagementApiAxiosParamCreator = exports.FeedsApi = exports.FeedsApiFactory = exports.FeedsApiFp = exports.FeedsApiAxiosParamCreator = exports.DeveloperSandboxesApi = exports.DeveloperSandboxesApiFactory = exports.DeveloperSandboxesApiFp = exports.DeveloperSandboxesApiAxiosParamCreator = exports.DeveloperProjectsApi = exports.DeveloperProjectsApiFactory = exports.DeveloperProjectsApiFp = exports.DeveloperProjectsApiAxiosParamCreator = exports.CompanyApi = exports.CompanyApiFactory = exports.CompanyApiFp = exports.CompanyApiAxiosParamCreator = exports.CalendarsApi = exports.CalendarsApiFactory = exports.CalendarsApiFp = exports.CalendarsApiAxiosParamCreator = exports.CMSWebsiteUpdatesApi = exports.CMSWebsiteUpdatesApiFactory = exports.CMSWebsiteUpdatesApiFp = exports.CMSWebsiteUpdatesApiAxiosParamCreator = exports.CMSV2TransferApi = exports.CMSV2TransferApiFactory = exports.CMSV2TransferApiFp = exports.CMSV2TransferApiAxiosParamCreator = exports.CMSV2PublicApi = exports.CMSV2PublicApiFactory = exports.CMSV2PublicApiFp = void 0;
27
30
  exports.TraitsApi = exports.TraitsApiFactory = exports.TraitsApiFp = exports.TraitsApiAxiosParamCreator = exports.SyncApi = exports.SyncApiFactory = exports.SyncApiFp = exports.SyncApiAxiosParamCreator = exports.ServerlessFunctionsApi = exports.ServerlessFunctionsApiFactory = exports.ServerlessFunctionsApiFp = exports.ServerlessFunctionsApiAxiosParamCreator = exports.RelationsApi = exports.RelationsApiFactory = exports.RelationsApiFp = exports.RelationsApiAxiosParamCreator = exports.UpdateByUuidRecordReturnFormatEnum = exports.UpdateByUuidParseEnum = exports.UpdateRecordReturnFormatEnum = exports.UpdateParseEnum = exports.ShowByObjectParseEnum = exports.ShowByObjectRecordReturnFormatEnum = exports.ShowParseEnum = exports.ShowRecordReturnFormatEnum = exports.SearchCrossObjectParseEnum = exports.SearchRecordReturnFormatEnum = exports.SearchParseEnum = exports.Preview1ParseEnum = exports.IndexFlowParseEnum = exports.IndexRecordReturnFormatEnum = exports.IndexParseEnum = exports.ExtendParseEnum = exports.ExtendRecordReturnFormatEnum = exports.CreateOrUpdateRecordReturnFormatEnum = exports.CreateOrUpdateParseEnum = exports.CreateRecordReturnFormatEnum = exports.CreateParseEnum = exports.RecordsApi = exports.RecordsApiFactory = exports.RecordsApiFp = exports.RecordsApiAxiosParamCreator = exports.PropertyApi = exports.PropertyApiFactory = exports.PropertyApiFp = exports.PropertyApiAxiosParamCreator = exports.ObjectsApi = exports.ObjectsApiFactory = exports.ObjectsApiFp = exports.ObjectsApiAxiosParamCreator = exports.NotificationsApi = void 0;
28
31
  exports.WebpagesApi = exports.WebpagesApiFactory = exports.WebpagesApiFp = exports.WebpagesApiAxiosParamCreator = exports.WebMenusApi = exports.WebMenusApiFactory = exports.WebMenusApiFp = exports.WebMenusApiAxiosParamCreator = exports.ViewsApi = exports.ViewsApiFactory = exports.ViewsApiFp = exports.ViewsApiAxiosParamCreator = void 0;
29
- const axios_1 = require("axios");
32
+ const axios_1 = __importDefault(require("axios"));
30
33
  // Some imports not used depending on template conditions
31
34
  // @ts-ignore
32
35
  const common_1 = require("./common");
@@ -16878,6 +16881,35 @@ const RecordsApiAxiosParamCreator = function (configuration) {
16878
16881
  options: localVarRequestOptions,
16879
16882
  };
16880
16883
  }),
16884
+ /**
16885
+ * 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.
16886
+ * @summary List objects with visible archived records
16887
+ * @param {*} [options] Override http request option.
16888
+ * @throws {RequiredError}
16889
+ */
16890
+ archivedObjects: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
16891
+ const localVarPath = `/api/v2/records/archived/objects`;
16892
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16893
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
16894
+ let baseOptions;
16895
+ if (configuration) {
16896
+ baseOptions = configuration.baseOptions;
16897
+ }
16898
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
16899
+ const localVarHeaderParameter = {};
16900
+ const localVarQueryParameter = {};
16901
+ // authentication bearerAuth required
16902
+ // http bearer authentication required
16903
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
16904
+ localVarHeaderParameter['Accept'] = 'application/json';
16905
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
16906
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16907
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
16908
+ return {
16909
+ url: (0, common_1.toPathString)(localVarUrlObj),
16910
+ options: localVarRequestOptions,
16911
+ };
16912
+ }),
16881
16913
  /**
16882
16914
  * 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.
16883
16915
  * @summary Bulk delete records
@@ -17919,6 +17951,21 @@ const RecordsApiFp = function (configuration) {
17919
17951
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17920
17952
  });
17921
17953
  },
17954
+ /**
17955
+ * 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.
17956
+ * @summary List objects with visible archived records
17957
+ * @param {*} [options] Override http request option.
17958
+ * @throws {RequiredError}
17959
+ */
17960
+ archivedObjects(options) {
17961
+ return __awaiter(this, void 0, void 0, function* () {
17962
+ var _a, _b, _c;
17963
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.archivedObjects(options);
17964
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
17965
+ 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;
17966
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17967
+ });
17968
+ },
17922
17969
  /**
17923
17970
  * 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.
17924
17971
  * @summary Bulk delete records
@@ -18371,6 +18418,15 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18371
18418
  aggregateBatch(aggregateBatchRequest, options) {
18372
18419
  return localVarFp.aggregateBatch(aggregateBatchRequest, options).then((request) => request(axios, basePath));
18373
18420
  },
18421
+ /**
18422
+ * 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.
18423
+ * @summary List objects with visible archived records
18424
+ * @param {*} [options] Override http request option.
18425
+ * @throws {RequiredError}
18426
+ */
18427
+ archivedObjects(options) {
18428
+ return localVarFp.archivedObjects(options).then((request) => request(axios, basePath));
18429
+ },
18374
18430
  /**
18375
18431
  * 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.
18376
18432
  * @summary Bulk delete records
@@ -18689,6 +18745,15 @@ class RecordsApi extends base_1.BaseAPI {
18689
18745
  aggregateBatch(aggregateBatchRequest, options) {
18690
18746
  return (0, exports.RecordsApiFp)(this.configuration).aggregateBatch(aggregateBatchRequest, options).then((request) => request(this.axios, this.basePath));
18691
18747
  }
18748
+ /**
18749
+ * 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.
18750
+ * @summary List objects with visible archived records
18751
+ * @param {*} [options] Override http request option.
18752
+ * @throws {RequiredError}
18753
+ */
18754
+ archivedObjects(options) {
18755
+ return (0, exports.RecordsApiFp)(this.configuration).archivedObjects(options).then((request) => request(this.axios, this.basePath));
18756
+ }
18692
18757
  /**
18693
18758
  * 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.
18694
18759
  * @summary Bulk delete records
package/dist/base.js CHANGED
@@ -12,9 +12,12 @@
12
12
  * https://openapi-generator.tech
13
13
  * Do not edit the class manually.
14
14
  */
15
+ var __importDefault = (this && this.__importDefault) || function (mod) {
16
+ return (mod && mod.__esModule) ? mod : { "default": mod };
17
+ };
15
18
  Object.defineProperty(exports, "__esModule", { value: true });
16
19
  exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
17
- const axios_1 = require("axios");
20
+ const axios_1 = __importDefault(require("axios"));
18
21
  exports.BASE_PATH = "https://v2.api.caraer.com".replace(/\/+$/, "");
19
22
  exports.COLLECTION_FORMATS = {
20
23
  csv: ",",
package/dist/esm/api.d.ts CHANGED
@@ -1016,8 +1016,8 @@ export interface AppSettingFieldSchema {
1016
1016
  'clearValue'?: boolean;
1017
1017
  'mappingValue'?: AppSettingFieldMappingStructure;
1018
1018
  'valueScope'?: string;
1019
- 'settingsGroup'?: boolean;
1020
1019
  'action'?: boolean;
1020
+ 'settingsGroup'?: boolean;
1021
1021
  'filterPropertyTypes'?: Array<string>;
1022
1022
  'filterPropertyFormats'?: Array<string>;
1023
1023
  }
@@ -1047,6 +1047,13 @@ export interface AppSubcategoryDTO {
1047
1047
  */
1048
1048
  'label'?: string;
1049
1049
  }
1050
+ export interface ArchivedRecordObjectDTO {
1051
+ 'uuid'?: string;
1052
+ 'name'?: string;
1053
+ 'label'?: string;
1054
+ 'icon'?: string;
1055
+ 'index'?: number;
1056
+ }
1050
1057
  /**
1051
1058
  * The billing settings of the company.
1052
1059
  */
@@ -3740,11 +3747,11 @@ export interface ModelRecord {
3740
3747
  'complete'?: boolean;
3741
3748
  'deleted'?: boolean;
3742
3749
  'uuid': string;
3743
- 'user'?: PublicUserDTO;
3744
3750
  'properties'?: Array<FilledProperty>;
3745
3751
  'objects'?: {
3746
3752
  [key: string]: any | null;
3747
3753
  };
3754
+ 'user'?: PublicUserDTO;
3748
3755
  }
3749
3756
  export interface MultiFile extends PropertyFormat {
3750
3757
  }
@@ -5424,7 +5431,7 @@ export interface RecordRelationRequestDTO {
5424
5431
  */
5425
5432
  'uuid'?: string;
5426
5433
  /**
5427
- * Properties to update on the existing record referenced by uuid before linking
5434
+ * 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.
5428
5435
  */
5429
5436
  'properties'?: {
5430
5437
  [key: string]: any | null;
@@ -7352,6 +7359,19 @@ export interface SuccessResponseListAppScheduleDTO {
7352
7359
  */
7353
7360
  'data'?: Array<AppScheduleDTO>;
7354
7361
  }
7362
+ /**
7363
+ * Represents a standard successful response with a message and optional data.
7364
+ */
7365
+ export interface SuccessResponseListArchivedRecordObjectDTO {
7366
+ /**
7367
+ * A message detailing the result of the operation.
7368
+ */
7369
+ 'message'?: string;
7370
+ /**
7371
+ * The data payload of the response, if any.
7372
+ */
7373
+ 'data'?: Array<ArchivedRecordObjectDTO>;
7374
+ }
7355
7375
  /**
7356
7376
  * Represents a standard successful response with a message and optional data.
7357
7377
  */
@@ -16742,6 +16762,13 @@ export declare const RecordsApiAxiosParamCreator: (configuration?: Configuration
16742
16762
  * @throws {RequiredError}
16743
16763
  */
16744
16764
  aggregateBatch: (aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
16765
+ /**
16766
+ * 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.
16767
+ * @summary List objects with visible archived records
16768
+ * @param {*} [options] Override http request option.
16769
+ * @throws {RequiredError}
16770
+ */
16771
+ archivedObjects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
16745
16772
  /**
16746
16773
  * 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.
16747
16774
  * @summary Bulk delete records
@@ -17008,6 +17035,13 @@ export declare const RecordsApiFp: (configuration?: Configuration) => {
17008
17035
  * @throws {RequiredError}
17009
17036
  */
17010
17037
  aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListAggregateResponse>>;
17038
+ /**
17039
+ * 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.
17040
+ * @summary List objects with visible archived records
17041
+ * @param {*} [options] Override http request option.
17042
+ * @throws {RequiredError}
17043
+ */
17044
+ archivedObjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseListArchivedRecordObjectDTO>>;
17011
17045
  /**
17012
17046
  * 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.
17013
17047
  * @summary Bulk delete records
@@ -17274,6 +17308,13 @@ export declare const RecordsApiFactory: (configuration?: Configuration, basePath
17274
17308
  * @throws {RequiredError}
17275
17309
  */
17276
17310
  aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListAggregateResponse>;
17311
+ /**
17312
+ * 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.
17313
+ * @summary List objects with visible archived records
17314
+ * @param {*} [options] Override http request option.
17315
+ * @throws {RequiredError}
17316
+ */
17317
+ archivedObjects(options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseListArchivedRecordObjectDTO>;
17277
17318
  /**
17278
17319
  * 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.
17279
17320
  * @summary Bulk delete records
@@ -17540,6 +17581,13 @@ export declare class RecordsApi extends BaseAPI {
17540
17581
  * @throws {RequiredError}
17541
17582
  */
17542
17583
  aggregateBatch(aggregateBatchRequest: AggregateBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListAggregateResponse, any, {}>>;
17584
+ /**
17585
+ * 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.
17586
+ * @summary List objects with visible archived records
17587
+ * @param {*} [options] Override http request option.
17588
+ * @throws {RequiredError}
17589
+ */
17590
+ archivedObjects(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseListArchivedRecordObjectDTO, any, {}>>;
17543
17591
  /**
17544
17592
  * 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.
17545
17593
  * @summary Bulk delete records
package/dist/esm/api.js CHANGED
@@ -16776,6 +16776,35 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
16776
16776
  options: localVarRequestOptions,
16777
16777
  };
16778
16778
  }),
16779
+ /**
16780
+ * 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.
16781
+ * @summary List objects with visible archived records
16782
+ * @param {*} [options] Override http request option.
16783
+ * @throws {RequiredError}
16784
+ */
16785
+ archivedObjects: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
16786
+ const localVarPath = `/api/v2/records/archived/objects`;
16787
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16788
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16789
+ let baseOptions;
16790
+ if (configuration) {
16791
+ baseOptions = configuration.baseOptions;
16792
+ }
16793
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
16794
+ const localVarHeaderParameter = {};
16795
+ const localVarQueryParameter = {};
16796
+ // authentication bearerAuth required
16797
+ // http bearer authentication required
16798
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
16799
+ localVarHeaderParameter['Accept'] = 'application/json';
16800
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
16801
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16802
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
16803
+ return {
16804
+ url: toPathString(localVarUrlObj),
16805
+ options: localVarRequestOptions,
16806
+ };
16807
+ }),
16779
16808
  /**
16780
16809
  * 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.
16781
16810
  * @summary Bulk delete records
@@ -17816,6 +17845,21 @@ export const RecordsApiFp = function (configuration) {
17816
17845
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17817
17846
  });
17818
17847
  },
17848
+ /**
17849
+ * 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.
17850
+ * @summary List objects with visible archived records
17851
+ * @param {*} [options] Override http request option.
17852
+ * @throws {RequiredError}
17853
+ */
17854
+ archivedObjects(options) {
17855
+ return __awaiter(this, void 0, void 0, function* () {
17856
+ var _a, _b, _c;
17857
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.archivedObjects(options);
17858
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
17859
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['RecordsApi.archivedObjects']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
17860
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17861
+ });
17862
+ },
17819
17863
  /**
17820
17864
  * 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.
17821
17865
  * @summary Bulk delete records
@@ -18267,6 +18311,15 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
18267
18311
  aggregateBatch(aggregateBatchRequest, options) {
18268
18312
  return localVarFp.aggregateBatch(aggregateBatchRequest, options).then((request) => request(axios, basePath));
18269
18313
  },
18314
+ /**
18315
+ * 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.
18316
+ * @summary List objects with visible archived records
18317
+ * @param {*} [options] Override http request option.
18318
+ * @throws {RequiredError}
18319
+ */
18320
+ archivedObjects(options) {
18321
+ return localVarFp.archivedObjects(options).then((request) => request(axios, basePath));
18322
+ },
18270
18323
  /**
18271
18324
  * 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.
18272
18325
  * @summary Bulk delete records
@@ -18584,6 +18637,15 @@ export class RecordsApi extends BaseAPI {
18584
18637
  aggregateBatch(aggregateBatchRequest, options) {
18585
18638
  return RecordsApiFp(this.configuration).aggregateBatch(aggregateBatchRequest, options).then((request) => request(this.axios, this.basePath));
18586
18639
  }
18640
+ /**
18641
+ * 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.
18642
+ * @summary List objects with visible archived records
18643
+ * @param {*} [options] Override http request option.
18644
+ * @throws {RequiredError}
18645
+ */
18646
+ archivedObjects(options) {
18647
+ return RecordsApiFp(this.configuration).archivedObjects(options).then((request) => request(this.axios, this.basePath));
18648
+ }
18587
18649
  /**
18588
18650
  * 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.
18589
18651
  * @summary Bulk delete records
@@ -33,8 +33,8 @@ Name | Type | Description | Notes
33
33
  **clearValue** | **boolean** | | [optional] [default to undefined]
34
34
  **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) | | [optional] [default to undefined]
35
35
  **valueScope** | **string** | | [optional] [default to undefined]
36
- **settingsGroup** | **boolean** | | [optional] [default to undefined]
37
36
  **action** | **boolean** | | [optional] [default to undefined]
37
+ **settingsGroup** | **boolean** | | [optional] [default to undefined]
38
38
  **filterPropertyTypes** | **Array&lt;string&gt;** | | [optional] [default to undefined]
39
39
  **filterPropertyFormats** | **Array&lt;string&gt;** | | [optional] [default to undefined]
40
40
 
@@ -72,8 +72,8 @@ const instance: AppSettingFieldSchema = {
72
72
  clearValue,
73
73
  mappingValue,
74
74
  valueScope,
75
- settingsGroup,
76
75
  action,
76
+ settingsGroup,
77
77
  filterPropertyTypes,
78
78
  filterPropertyFormats,
79
79
  };
@@ -0,0 +1,28 @@
1
+ # ArchivedRecordObjectDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **uuid** | **string** | | [optional] [default to undefined]
9
+ **name** | **string** | | [optional] [default to undefined]
10
+ **label** | **string** | | [optional] [default to undefined]
11
+ **icon** | **string** | | [optional] [default to undefined]
12
+ **index** | **number** | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { ArchivedRecordObjectDTO } from '@caraer/client';
18
+
19
+ const instance: ArchivedRecordObjectDTO = {
20
+ uuid,
21
+ name,
22
+ label,
23
+ icon,
24
+ index,
25
+ };
26
+ ```
27
+
28
+ [[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/Record.md CHANGED
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
17
17
  **complete** | **boolean** | | [optional] [default to undefined]
18
18
  **deleted** | **boolean** | | [optional] [default to undefined]
19
19
  **uuid** | **string** | | [default to undefined]
20
- **user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
21
20
  **properties** | [**Array&lt;FilledProperty&gt;**](FilledProperty.md) | | [optional] [default to undefined]
22
21
  **objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
22
+ **user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
23
23
 
24
24
  ## Example
25
25
 
@@ -39,9 +39,9 @@ const instance: ModelRecord = {
39
39
  complete,
40
40
  deleted,
41
41
  uuid,
42
- user,
43
42
  properties,
44
43
  objects,
44
+ user,
45
45
  };
46
46
  ```
47
47
 
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **relationName** | **string** | Name of the relation type | [default to undefined]
10
10
  **uuid** | **string** | UUID of an existing record to link to | [optional] [default to undefined]
11
- **properties** | **{ [key: string]: any | null; }** | Properties to update on the existing record referenced by uuid before linking | [optional] [default to undefined]
11
+ **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]
12
12
  **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]
13
13
  **record** | [**RecordDTO**](RecordDTO.md) | Nested record to create or update (by uuid or unique properties) before linking | [optional] [default to undefined]
14
14
  **objectName** | **string** | Object name for nested record create when relation allows multiple target types | [optional] [default to undefined]
@@ -7,6 +7,7 @@ All URIs are relative to *https://v2.api.caraer.com*
7
7
  |[**_delete**](#_delete) | **DELETE** /api/v2/records/{uuid} | Delete a record|
8
8
  |[**aggregate**](#aggregate) | **POST** /api/v2/records/aggregate | Aggregate records for analytics charts|
9
9
  |[**aggregateBatch**](#aggregatebatch) | **POST** /api/v2/records/aggregate/batch | Batch aggregate records for analytics dashboards|
10
+ |[**archivedObjects**](#archivedobjects) | **GET** /api/v2/records/archived/objects | List objects with visible archived records|
10
11
  |[**bulkDelete**](#bulkdelete) | **POST** /api/v2/records/{objectName}/bulk-delete | Bulk delete records|
11
12
  |[**bulkEdit**](#bulkedit) | **PUT** /api/v2/records/{objectName}/bulk | Bulk create or update records|
12
13
  |[**create**](#create) | **POST** /api/v2/records/{objectName} | Create a new record|
@@ -202,6 +203,54 @@ const { status, data } = await apiInstance.aggregateBatch(
202
203
 
203
204
  [[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)
204
205
 
206
+ # **archivedObjects**
207
+ > SuccessResponseListArchivedRecordObjectDTO archivedObjects()
208
+
209
+ 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.
210
+
211
+ ### Example
212
+
213
+ ```typescript
214
+ import {
215
+ RecordsApi,
216
+ Configuration
217
+ } from '@caraer/client';
218
+
219
+ const configuration = new Configuration();
220
+ const apiInstance = new RecordsApi(configuration);
221
+
222
+ const { status, data } = await apiInstance.archivedObjects();
223
+ ```
224
+
225
+ ### Parameters
226
+ This endpoint does not have any parameters.
227
+
228
+
229
+ ### Return type
230
+
231
+ **SuccessResponseListArchivedRecordObjectDTO**
232
+
233
+ ### Authorization
234
+
235
+ [bearerAuth](../README.md#bearerAuth)
236
+
237
+ ### HTTP request headers
238
+
239
+ - **Content-Type**: Not defined
240
+ - **Accept**: application/json
241
+
242
+
243
+ ### HTTP response details
244
+ | Status code | Description | Response headers |
245
+ |-------------|-------------|------------------|
246
+ |**200** | OK | - |
247
+ |**401** | Authentication is required or the token is invalid. | - |
248
+ |**403** | The caller is missing a required role or scope. | - |
249
+ |**404** | The requested resource was not found. | - |
250
+ |**500** | An internal server error occurred. | - |
251
+
252
+ [[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)
253
+
205
254
  # **bulkDelete**
206
255
  > BulkDeleteRecordsResponse bulkDelete(bulkDeleteRecordsRequest)
207
256
 
@@ -0,0 +1,23 @@
1
+ # SuccessResponseListArchivedRecordObjectDTO
2
+
3
+ Represents a standard successful response with a message and optional data.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
10
+ **data** | [**Array&lt;ArchivedRecordObjectDTO&gt;**](ArchivedRecordObjectDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { SuccessResponseListArchivedRecordObjectDTO } from '@caraer/client';
16
+
17
+ const instance: SuccessResponseListArchivedRecordObjectDTO = {
18
+ message,
19
+ data,
20
+ };
21
+ ```
22
+
23
+ [[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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.640",
3
+ "version": "2.0.655",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -28,7 +28,7 @@
28
28
  },
29
29
  "devDependencies": {
30
30
  "@types/node": "12.11.5 - 12.20.42",
31
- "typescript": "^4.0 || ^5.0"
31
+ "typescript": "^4.0 || ^5.0 || ^6.0"
32
32
  },
33
33
  "homepage": "https://developer.caraer.com",
34
34
  "bugs": {
package/tsconfig.json CHANGED
@@ -6,9 +6,12 @@
6
6
  "noImplicitAny": true,
7
7
  "outDir": "dist",
8
8
  "rootDir": ".",
9
- "moduleResolution": "node",
10
9
  "typeRoots": [
11
10
  "node_modules/@types"
11
+ ],
12
+ "lib": [
13
+ "es2017",
14
+ "dom"
12
15
  ]
13
16
  },
14
17
  "exclude": [