@caraer/client 2.0.610 → 2.0.618

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
@@ -7795,6 +7795,51 @@ const CMSV2PublicApiAxiosParamCreator = function (configuration) {
7795
7795
  options: localVarRequestOptions,
7796
7796
  };
7797
7797
  }),
7798
+ /**
7799
+ * Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
7800
+ * @summary Resolve a historical CMS v2 path to its latest published route
7801
+ * @param {string} xCaraerSubdomain
7802
+ * @param {string} path
7803
+ * @param {string} [environment]
7804
+ * @param {*} [options] Override http request option.
7805
+ * @throws {RequiredError}
7806
+ */
7807
+ redirect: (xCaraerSubdomain_1, path_1, environment_1, ...args_1) => __awaiter(this, [xCaraerSubdomain_1, path_1, environment_1, ...args_1], void 0, function* (xCaraerSubdomain, path, environment, options = {}) {
7808
+ // verify required parameter 'xCaraerSubdomain' is not null or undefined
7809
+ (0, common_1.assertParamExists)('redirect', 'xCaraerSubdomain', xCaraerSubdomain);
7810
+ // verify required parameter 'path' is not null or undefined
7811
+ (0, common_1.assertParamExists)('redirect', 'path', path);
7812
+ const localVarPath = `/api/v2/webpages/v2/public/redirect`;
7813
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7814
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
7815
+ let baseOptions;
7816
+ if (configuration) {
7817
+ baseOptions = configuration.baseOptions;
7818
+ }
7819
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
7820
+ const localVarHeaderParameter = {};
7821
+ const localVarQueryParameter = {};
7822
+ // authentication bearerAuth required
7823
+ // http bearer authentication required
7824
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
7825
+ if (environment !== undefined) {
7826
+ localVarQueryParameter['environment'] = environment;
7827
+ }
7828
+ if (path !== undefined) {
7829
+ localVarQueryParameter['path'] = path;
7830
+ }
7831
+ localVarHeaderParameter['Accept'] = 'application/json';
7832
+ if (xCaraerSubdomain != null) {
7833
+ localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
7834
+ }
7835
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
7836
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7837
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
7838
+ return {
7839
+ url: (0, common_1.toPathString)(localVarUrlObj),
7840
+ options: localVarRequestOptions,
7841
+ };
7842
+ }),
7798
7843
  /**
7799
7844
  *
7800
7845
  * @summary Company settings, branding and locales
@@ -8074,6 +8119,24 @@ const CMSV2PublicApiFp = function (configuration) {
8074
8119
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8075
8120
  });
8076
8121
  },
8122
+ /**
8123
+ * Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
8124
+ * @summary Resolve a historical CMS v2 path to its latest published route
8125
+ * @param {string} xCaraerSubdomain
8126
+ * @param {string} path
8127
+ * @param {string} [environment]
8128
+ * @param {*} [options] Override http request option.
8129
+ * @throws {RequiredError}
8130
+ */
8131
+ redirect(xCaraerSubdomain, path, environment, options) {
8132
+ return __awaiter(this, void 0, void 0, function* () {
8133
+ var _a, _b, _c;
8134
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.redirect(xCaraerSubdomain, path, environment, options);
8135
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8136
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CMSV2PublicApi.redirect']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
8137
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8138
+ });
8139
+ },
8077
8140
  /**
8078
8141
  *
8079
8142
  * @summary Company settings, branding and locales
@@ -8248,6 +8311,18 @@ const CMSV2PublicApiFactory = function (configuration, basePath, axios) {
8248
8311
  records(xCaraerSubdomain, requestBody, environment, locale, options) {
8249
8312
  return localVarFp.records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(axios, basePath));
8250
8313
  },
8314
+ /**
8315
+ * Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
8316
+ * @summary Resolve a historical CMS v2 path to its latest published route
8317
+ * @param {string} xCaraerSubdomain
8318
+ * @param {string} path
8319
+ * @param {string} [environment]
8320
+ * @param {*} [options] Override http request option.
8321
+ * @throws {RequiredError}
8322
+ */
8323
+ redirect(xCaraerSubdomain, path, environment, options) {
8324
+ return localVarFp.redirect(xCaraerSubdomain, path, environment, options).then((request) => request(axios, basePath));
8325
+ },
8251
8326
  /**
8252
8327
  *
8253
8328
  * @summary Company settings, branding and locales
@@ -8408,6 +8483,18 @@ class CMSV2PublicApi extends base_1.BaseAPI {
8408
8483
  records(xCaraerSubdomain, requestBody, environment, locale, options) {
8409
8484
  return (0, exports.CMSV2PublicApiFp)(this.configuration).records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(this.axios, this.basePath));
8410
8485
  }
8486
+ /**
8487
+ * Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
8488
+ * @summary Resolve a historical CMS v2 path to its latest published route
8489
+ * @param {string} xCaraerSubdomain
8490
+ * @param {string} path
8491
+ * @param {string} [environment]
8492
+ * @param {*} [options] Override http request option.
8493
+ * @throws {RequiredError}
8494
+ */
8495
+ redirect(xCaraerSubdomain, path, environment, options) {
8496
+ return (0, exports.CMSV2PublicApiFp)(this.configuration).redirect(xCaraerSubdomain, path, environment, options).then((request) => request(this.axios, this.basePath));
8497
+ }
8411
8498
  /**
8412
8499
  *
8413
8500
  * @summary Company settings, branding and locales
@@ -16802,7 +16889,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
16802
16889
  * @param {RecordDTO} recordDTO Record data to create
16803
16890
  * @param {CreateParseEnum} [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).
16804
16891
  * @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
16805
- * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16892
+ * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16806
16893
  * @param {*} [options] Override http request option.
16807
16894
  * @throws {RequiredError}
16808
16895
  */
@@ -16852,7 +16939,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
16852
16939
  * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
16853
16940
  * @param {CreateOrUpdateParseEnum} [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).
16854
16941
  * @param {boolean} [ignoreErrors]
16855
- * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
16942
+ * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16856
16943
  * @param {*} [options] Override http request option.
16857
16944
  * @throws {RequiredError}
16858
16945
  */
@@ -16991,7 +17078,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
16991
17078
  * @summary Extend a record
16992
17079
  * @param {string} uuid
16993
17080
  * @param {ExtendRecordRequest} extendRecordRequest
16994
- * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17081
+ * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
16995
17082
  * @param {ExtendParseEnum} [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).
16996
17083
  * @param {*} [options] Override http request option.
16997
17084
  * @throws {RequiredError}
@@ -17039,7 +17126,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
17039
17126
  * @param {IndexParseEnum} [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).
17040
17127
  * @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
17041
17128
  * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record.
17042
- * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
17129
+ * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17043
17130
  * @param {*} [options] Override http request option.
17044
17131
  * @throws {RequiredError}
17045
17132
  */
@@ -17334,7 +17421,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
17334
17421
  * @param {SearchRequest} searchRequest Search criteria
17335
17422
  * @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
17336
17423
  * @param {SearchParseEnum} [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).
17337
- * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
17424
+ * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17338
17425
  * @param {*} [options] Override http request option.
17339
17426
  * @throws {RequiredError}
17340
17427
  */
@@ -17421,7 +17508,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
17421
17508
  * @summary Get record details
17422
17509
  * @param {string} uuid
17423
17510
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
17424
- * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17511
+ * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17425
17512
  * @param {ShowParseEnum} [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).
17426
17513
  * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
17427
17514
  * @param {*} [options] Override http request option.
@@ -17470,7 +17557,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
17470
17557
  * @summary Get record details by object
17471
17558
  * @param {string} objectName
17472
17559
  * @param {string} uuid
17473
- * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17560
+ * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17474
17561
  * @param {ShowByObjectParseEnum} [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).
17475
17562
  * @param {*} [options] Override http request option.
17476
17563
  * @throws {RequiredError}
@@ -17552,7 +17639,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
17552
17639
  * @param {RecordDTO} recordDTO Record data to update
17553
17640
  * @param {UpdateParseEnum} [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).
17554
17641
  * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
17555
- * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17642
+ * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17556
17643
  * @param {*} [options] Override http request option.
17557
17644
  * @throws {RequiredError}
17558
17645
  */
@@ -17606,7 +17693,7 @@ const RecordsApiAxiosParamCreator = function (configuration) {
17606
17693
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
17607
17694
  * @param {UpdateByUuidParseEnum} [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).
17608
17695
  * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
17609
- * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17696
+ * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17610
17697
  * @param {*} [options] Override http request option.
17611
17698
  * @throws {RequiredError}
17612
17699
  */
@@ -17798,7 +17885,7 @@ const RecordsApiFp = function (configuration) {
17798
17885
  * @param {RecordDTO} recordDTO Record data to create
17799
17886
  * @param {CreateParseEnum} [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).
17800
17887
  * @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
17801
- * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17888
+ * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17802
17889
  * @param {*} [options] Override http request option.
17803
17890
  * @throws {RequiredError}
17804
17891
  */
@@ -17818,7 +17905,7 @@ const RecordsApiFp = function (configuration) {
17818
17905
  * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
17819
17906
  * @param {CreateOrUpdateParseEnum} [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).
17820
17907
  * @param {boolean} [ignoreErrors]
17821
- * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17908
+ * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17822
17909
  * @param {*} [options] Override http request option.
17823
17910
  * @throws {RequiredError}
17824
17911
  */
@@ -17874,7 +17961,7 @@ const RecordsApiFp = function (configuration) {
17874
17961
  * @summary Extend a record
17875
17962
  * @param {string} uuid
17876
17963
  * @param {ExtendRecordRequest} extendRecordRequest
17877
- * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
17964
+ * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17878
17965
  * @param {ExtendParseEnum} [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).
17879
17966
  * @param {*} [options] Override http request option.
17880
17967
  * @throws {RequiredError}
@@ -17895,7 +17982,7 @@ const RecordsApiFp = function (configuration) {
17895
17982
  * @param {IndexParseEnum} [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).
17896
17983
  * @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
17897
17984
  * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record.
17898
- * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
17985
+ * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
17899
17986
  * @param {*} [options] Override http request option.
17900
17987
  * @throws {RequiredError}
17901
17988
  */
@@ -18021,7 +18108,7 @@ const RecordsApiFp = function (configuration) {
18021
18108
  * @param {SearchRequest} searchRequest Search criteria
18022
18109
  * @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
18023
18110
  * @param {SearchParseEnum} [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).
18024
- * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
18111
+ * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18025
18112
  * @param {*} [options] Override http request option.
18026
18113
  * @throws {RequiredError}
18027
18114
  */
@@ -18057,7 +18144,7 @@ const RecordsApiFp = function (configuration) {
18057
18144
  * @summary Get record details
18058
18145
  * @param {string} uuid
18059
18146
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
18060
- * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18147
+ * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18061
18148
  * @param {ShowParseEnum} [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).
18062
18149
  * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
18063
18150
  * @param {*} [options] Override http request option.
@@ -18077,7 +18164,7 @@ const RecordsApiFp = function (configuration) {
18077
18164
  * @summary Get record details by object
18078
18165
  * @param {string} objectName
18079
18166
  * @param {string} uuid
18080
- * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18167
+ * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18081
18168
  * @param {ShowByObjectParseEnum} [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).
18082
18169
  * @param {*} [options] Override http request option.
18083
18170
  * @throws {RequiredError}
@@ -18115,7 +18202,7 @@ const RecordsApiFp = function (configuration) {
18115
18202
  * @param {RecordDTO} recordDTO Record data to update
18116
18203
  * @param {UpdateParseEnum} [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).
18117
18204
  * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
18118
- * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18205
+ * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18119
18206
  * @param {*} [options] Override http request option.
18120
18207
  * @throws {RequiredError}
18121
18208
  */
@@ -18136,7 +18223,7 @@ const RecordsApiFp = function (configuration) {
18136
18223
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
18137
18224
  * @param {UpdateByUuidParseEnum} [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).
18138
18225
  * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
18139
- * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18226
+ * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18140
18227
  * @param {*} [options] Override http request option.
18141
18228
  * @throws {RequiredError}
18142
18229
  */
@@ -18238,7 +18325,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18238
18325
  * @param {RecordDTO} recordDTO Record data to create
18239
18326
  * @param {CreateParseEnum} [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).
18240
18327
  * @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
18241
- * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18328
+ * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18242
18329
  * @param {*} [options] Override http request option.
18243
18330
  * @throws {RequiredError}
18244
18331
  */
@@ -18252,7 +18339,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18252
18339
  * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
18253
18340
  * @param {CreateOrUpdateParseEnum} [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).
18254
18341
  * @param {boolean} [ignoreErrors]
18255
- * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18342
+ * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18256
18343
  * @param {*} [options] Override http request option.
18257
18344
  * @throws {RequiredError}
18258
18345
  */
@@ -18290,7 +18377,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18290
18377
  * @summary Extend a record
18291
18378
  * @param {string} uuid
18292
18379
  * @param {ExtendRecordRequest} extendRecordRequest
18293
- * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18380
+ * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18294
18381
  * @param {ExtendParseEnum} [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).
18295
18382
  * @param {*} [options] Override http request option.
18296
18383
  * @throws {RequiredError}
@@ -18305,7 +18392,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18305
18392
  * @param {IndexParseEnum} [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).
18306
18393
  * @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
18307
18394
  * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record.
18308
- * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
18395
+ * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18309
18396
  * @param {*} [options] Override http request option.
18310
18397
  * @throws {RequiredError}
18311
18398
  */
@@ -18389,7 +18476,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18389
18476
  * @param {SearchRequest} searchRequest Search criteria
18390
18477
  * @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
18391
18478
  * @param {SearchParseEnum} [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).
18392
- * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
18479
+ * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18393
18480
  * @param {*} [options] Override http request option.
18394
18481
  * @throws {RequiredError}
18395
18482
  */
@@ -18413,7 +18500,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18413
18500
  * @summary Get record details
18414
18501
  * @param {string} uuid
18415
18502
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
18416
- * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18503
+ * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18417
18504
  * @param {ShowParseEnum} [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).
18418
18505
  * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
18419
18506
  * @param {*} [options] Override http request option.
@@ -18427,7 +18514,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18427
18514
  * @summary Get record details by object
18428
18515
  * @param {string} objectName
18429
18516
  * @param {string} uuid
18430
- * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18517
+ * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18431
18518
  * @param {ShowByObjectParseEnum} [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).
18432
18519
  * @param {*} [options] Override http request option.
18433
18520
  * @throws {RequiredError}
@@ -18453,7 +18540,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18453
18540
  * @param {RecordDTO} recordDTO Record data to update
18454
18541
  * @param {UpdateParseEnum} [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).
18455
18542
  * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
18456
- * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18543
+ * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18457
18544
  * @param {*} [options] Override http request option.
18458
18545
  * @throws {RequiredError}
18459
18546
  */
@@ -18468,7 +18555,7 @@ const RecordsApiFactory = function (configuration, basePath, axios) {
18468
18555
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
18469
18556
  * @param {UpdateByUuidParseEnum} [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).
18470
18557
  * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
18471
- * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18558
+ * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18472
18559
  * @param {*} [options] Override http request option.
18473
18560
  * @throws {RequiredError}
18474
18561
  */
@@ -18556,7 +18643,7 @@ class RecordsApi extends base_1.BaseAPI {
18556
18643
  * @param {RecordDTO} recordDTO Record data to create
18557
18644
  * @param {CreateParseEnum} [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).
18558
18645
  * @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
18559
- * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18646
+ * @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18560
18647
  * @param {*} [options] Override http request option.
18561
18648
  * @throws {RequiredError}
18562
18649
  */
@@ -18570,7 +18657,7 @@ class RecordsApi extends base_1.BaseAPI {
18570
18657
  * @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
18571
18658
  * @param {CreateOrUpdateParseEnum} [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).
18572
18659
  * @param {boolean} [ignoreErrors]
18573
- * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18660
+ * @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18574
18661
  * @param {*} [options] Override http request option.
18575
18662
  * @throws {RequiredError}
18576
18663
  */
@@ -18608,7 +18695,7 @@ class RecordsApi extends base_1.BaseAPI {
18608
18695
  * @summary Extend a record
18609
18696
  * @param {string} uuid
18610
18697
  * @param {ExtendRecordRequest} extendRecordRequest
18611
- * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18698
+ * @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18612
18699
  * @param {ExtendParseEnum} [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).
18613
18700
  * @param {*} [options] Override http request option.
18614
18701
  * @throws {RequiredError}
@@ -18623,7 +18710,7 @@ class RecordsApi extends base_1.BaseAPI {
18623
18710
  * @param {IndexParseEnum} [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).
18624
18711
  * @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
18625
18712
  * @param {string} [relatedRecordUuid] UUID of a record used for relation-aware filtering. If supplied and the request body contains a filter, that filter will be smartened based on this related record. If no filter is supplied, a default filter will be applied that returns all records related in any way (any relation) to this record.
18626
- * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
18713
+ * @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18627
18714
  * @param {*} [options] Override http request option.
18628
18715
  * @throws {RequiredError}
18629
18716
  */
@@ -18707,7 +18794,7 @@ class RecordsApi extends base_1.BaseAPI {
18707
18794
  * @param {SearchRequest} searchRequest Search criteria
18708
18795
  * @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
18709
18796
  * @param {SearchParseEnum} [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).
18710
- * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
18797
+ * @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18711
18798
  * @param {*} [options] Override http request option.
18712
18799
  * @throws {RequiredError}
18713
18800
  */
@@ -18731,7 +18818,7 @@ class RecordsApi extends base_1.BaseAPI {
18731
18818
  * @summary Get record details
18732
18819
  * @param {string} uuid
18733
18820
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
18734
- * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18821
+ * @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18735
18822
  * @param {ShowParseEnum} [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).
18736
18823
  * @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
18737
18824
  * @param {*} [options] Override http request option.
@@ -18745,7 +18832,7 @@ class RecordsApi extends base_1.BaseAPI {
18745
18832
  * @summary Get record details by object
18746
18833
  * @param {string} objectName
18747
18834
  * @param {string} uuid
18748
- * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18835
+ * @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18749
18836
  * @param {ShowByObjectParseEnum} [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).
18750
18837
  * @param {*} [options] Override http request option.
18751
18838
  * @throws {RequiredError}
@@ -18771,7 +18858,7 @@ class RecordsApi extends base_1.BaseAPI {
18771
18858
  * @param {RecordDTO} recordDTO Record data to update
18772
18859
  * @param {UpdateParseEnum} [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).
18773
18860
  * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
18774
- * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18861
+ * @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18775
18862
  * @param {*} [options] Override http request option.
18776
18863
  * @throws {RequiredError}
18777
18864
  */
@@ -18786,7 +18873,7 @@ class RecordsApi extends base_1.BaseAPI {
18786
18873
  * @param {string} [object] Optional object name to resolve the record in a specific object context.
18787
18874
  * @param {UpdateByUuidParseEnum} [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).
18788
18875
  * @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
18789
- * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
18876
+ * @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
18790
18877
  * @param {*} [options] Override http request option.
18791
18878
  * @throws {RequiredError}
18792
18879
  */
@@ -18817,6 +18904,7 @@ exports.CreateRecordReturnFormatEnum = {
18817
18904
  Legacy: 'LEGACY',
18818
18905
  UserFriendly: 'USER_FRIENDLY',
18819
18906
  Expanded: 'EXPANDED',
18907
+ Minimal: 'MINIMAL',
18820
18908
  };
18821
18909
  exports.CreateOrUpdateParseEnum = {
18822
18910
  Db: 'DB',
@@ -18827,11 +18915,13 @@ exports.CreateOrUpdateRecordReturnFormatEnum = {
18827
18915
  Legacy: 'LEGACY',
18828
18916
  UserFriendly: 'USER_FRIENDLY',
18829
18917
  Expanded: 'EXPANDED',
18918
+ Minimal: 'MINIMAL',
18830
18919
  };
18831
18920
  exports.ExtendRecordReturnFormatEnum = {
18832
18921
  Legacy: 'LEGACY',
18833
18922
  UserFriendly: 'USER_FRIENDLY',
18834
18923
  Expanded: 'EXPANDED',
18924
+ Minimal: 'MINIMAL',
18835
18925
  };
18836
18926
  exports.ExtendParseEnum = {
18837
18927
  Db: 'DB',
@@ -18847,6 +18937,7 @@ exports.IndexRecordReturnFormatEnum = {
18847
18937
  Legacy: 'LEGACY',
18848
18938
  UserFriendly: 'USER_FRIENDLY',
18849
18939
  Expanded: 'EXPANDED',
18940
+ Minimal: 'MINIMAL',
18850
18941
  };
18851
18942
  exports.IndexFlowParseEnum = {
18852
18943
  Db: 'DB',
@@ -18867,6 +18958,7 @@ exports.SearchRecordReturnFormatEnum = {
18867
18958
  Legacy: 'LEGACY',
18868
18959
  UserFriendly: 'USER_FRIENDLY',
18869
18960
  Expanded: 'EXPANDED',
18961
+ Minimal: 'MINIMAL',
18870
18962
  };
18871
18963
  exports.SearchCrossObjectParseEnum = {
18872
18964
  Db: 'DB',
@@ -18877,6 +18969,7 @@ exports.ShowRecordReturnFormatEnum = {
18877
18969
  Legacy: 'LEGACY',
18878
18970
  UserFriendly: 'USER_FRIENDLY',
18879
18971
  Expanded: 'EXPANDED',
18972
+ Minimal: 'MINIMAL',
18880
18973
  };
18881
18974
  exports.ShowParseEnum = {
18882
18975
  Db: 'DB',
@@ -18887,6 +18980,7 @@ exports.ShowByObjectRecordReturnFormatEnum = {
18887
18980
  Legacy: 'LEGACY',
18888
18981
  UserFriendly: 'USER_FRIENDLY',
18889
18982
  Expanded: 'EXPANDED',
18983
+ Minimal: 'MINIMAL',
18890
18984
  };
18891
18985
  exports.ShowByObjectParseEnum = {
18892
18986
  Db: 'DB',
@@ -18902,6 +18996,7 @@ exports.UpdateRecordReturnFormatEnum = {
18902
18996
  Legacy: 'LEGACY',
18903
18997
  UserFriendly: 'USER_FRIENDLY',
18904
18998
  Expanded: 'EXPANDED',
18999
+ Minimal: 'MINIMAL',
18905
19000
  };
18906
19001
  exports.UpdateByUuidParseEnum = {
18907
19002
  Db: 'DB',
@@ -18912,6 +19007,7 @@ exports.UpdateByUuidRecordReturnFormatEnum = {
18912
19007
  Legacy: 'LEGACY',
18913
19008
  UserFriendly: 'USER_FRIENDLY',
18914
19009
  Expanded: 'EXPANDED',
19010
+ Minimal: 'MINIMAL',
18915
19011
  };
18916
19012
  /**
18917
19013
  * RelationsApi - axios parameter creator