@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/api.ts +145 -40
- package/dist/api.d.ts +93 -40
- package/dist/api.js +132 -36
- package/dist/esm/api.d.ts +93 -40
- package/dist/esm/api.js +132 -36
- package/docs/CMSV2PublicApi.md +62 -0
- package/docs/ExistingWidgetSummary.md +4 -4
- package/docs/Record.md +2 -2
- package/docs/RecordsApi.md +18 -18
- package/docs/SubscribeWebhookDTO.md +3 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -7753,6 +7753,51 @@ export const CMSV2PublicApiAxiosParamCreator = function (configuration) {
|
|
|
7753
7753
|
options: localVarRequestOptions,
|
|
7754
7754
|
};
|
|
7755
7755
|
}),
|
|
7756
|
+
/**
|
|
7757
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
7758
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
7759
|
+
* @param {string} xCaraerSubdomain
|
|
7760
|
+
* @param {string} path
|
|
7761
|
+
* @param {string} [environment]
|
|
7762
|
+
* @param {*} [options] Override http request option.
|
|
7763
|
+
* @throws {RequiredError}
|
|
7764
|
+
*/
|
|
7765
|
+
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 = {}) {
|
|
7766
|
+
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
7767
|
+
assertParamExists('redirect', 'xCaraerSubdomain', xCaraerSubdomain);
|
|
7768
|
+
// verify required parameter 'path' is not null or undefined
|
|
7769
|
+
assertParamExists('redirect', 'path', path);
|
|
7770
|
+
const localVarPath = `/api/v2/webpages/v2/public/redirect`;
|
|
7771
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7772
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7773
|
+
let baseOptions;
|
|
7774
|
+
if (configuration) {
|
|
7775
|
+
baseOptions = configuration.baseOptions;
|
|
7776
|
+
}
|
|
7777
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
7778
|
+
const localVarHeaderParameter = {};
|
|
7779
|
+
const localVarQueryParameter = {};
|
|
7780
|
+
// authentication bearerAuth required
|
|
7781
|
+
// http bearer authentication required
|
|
7782
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7783
|
+
if (environment !== undefined) {
|
|
7784
|
+
localVarQueryParameter['environment'] = environment;
|
|
7785
|
+
}
|
|
7786
|
+
if (path !== undefined) {
|
|
7787
|
+
localVarQueryParameter['path'] = path;
|
|
7788
|
+
}
|
|
7789
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7790
|
+
if (xCaraerSubdomain != null) {
|
|
7791
|
+
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
7792
|
+
}
|
|
7793
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7794
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7795
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7796
|
+
return {
|
|
7797
|
+
url: toPathString(localVarUrlObj),
|
|
7798
|
+
options: localVarRequestOptions,
|
|
7799
|
+
};
|
|
7800
|
+
}),
|
|
7756
7801
|
/**
|
|
7757
7802
|
*
|
|
7758
7803
|
* @summary Company settings, branding and locales
|
|
@@ -8031,6 +8076,24 @@ export const CMSV2PublicApiFp = function (configuration) {
|
|
|
8031
8076
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8032
8077
|
});
|
|
8033
8078
|
},
|
|
8079
|
+
/**
|
|
8080
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
8081
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
8082
|
+
* @param {string} xCaraerSubdomain
|
|
8083
|
+
* @param {string} path
|
|
8084
|
+
* @param {string} [environment]
|
|
8085
|
+
* @param {*} [options] Override http request option.
|
|
8086
|
+
* @throws {RequiredError}
|
|
8087
|
+
*/
|
|
8088
|
+
redirect(xCaraerSubdomain, path, environment, options) {
|
|
8089
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8090
|
+
var _a, _b, _c;
|
|
8091
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.redirect(xCaraerSubdomain, path, environment, options);
|
|
8092
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8093
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSV2PublicApi.redirect']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8094
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8095
|
+
});
|
|
8096
|
+
},
|
|
8034
8097
|
/**
|
|
8035
8098
|
*
|
|
8036
8099
|
* @summary Company settings, branding and locales
|
|
@@ -8204,6 +8267,18 @@ export const CMSV2PublicApiFactory = function (configuration, basePath, axios) {
|
|
|
8204
8267
|
records(xCaraerSubdomain, requestBody, environment, locale, options) {
|
|
8205
8268
|
return localVarFp.records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(axios, basePath));
|
|
8206
8269
|
},
|
|
8270
|
+
/**
|
|
8271
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
8272
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
8273
|
+
* @param {string} xCaraerSubdomain
|
|
8274
|
+
* @param {string} path
|
|
8275
|
+
* @param {string} [environment]
|
|
8276
|
+
* @param {*} [options] Override http request option.
|
|
8277
|
+
* @throws {RequiredError}
|
|
8278
|
+
*/
|
|
8279
|
+
redirect(xCaraerSubdomain, path, environment, options) {
|
|
8280
|
+
return localVarFp.redirect(xCaraerSubdomain, path, environment, options).then((request) => request(axios, basePath));
|
|
8281
|
+
},
|
|
8207
8282
|
/**
|
|
8208
8283
|
*
|
|
8209
8284
|
* @summary Company settings, branding and locales
|
|
@@ -8363,6 +8438,18 @@ export class CMSV2PublicApi extends BaseAPI {
|
|
|
8363
8438
|
records(xCaraerSubdomain, requestBody, environment, locale, options) {
|
|
8364
8439
|
return CMSV2PublicApiFp(this.configuration).records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(this.axios, this.basePath));
|
|
8365
8440
|
}
|
|
8441
|
+
/**
|
|
8442
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
8443
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
8444
|
+
* @param {string} xCaraerSubdomain
|
|
8445
|
+
* @param {string} path
|
|
8446
|
+
* @param {string} [environment]
|
|
8447
|
+
* @param {*} [options] Override http request option.
|
|
8448
|
+
* @throws {RequiredError}
|
|
8449
|
+
*/
|
|
8450
|
+
redirect(xCaraerSubdomain, path, environment, options) {
|
|
8451
|
+
return CMSV2PublicApiFp(this.configuration).redirect(xCaraerSubdomain, path, environment, options).then((request) => request(this.axios, this.basePath));
|
|
8452
|
+
}
|
|
8366
8453
|
/**
|
|
8367
8454
|
*
|
|
8368
8455
|
* @summary Company settings, branding and locales
|
|
@@ -16700,7 +16787,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
16700
16787
|
* @param {RecordDTO} recordDTO Record data to create
|
|
16701
16788
|
* @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).
|
|
16702
16789
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
16703
|
-
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
16790
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
16704
16791
|
* @param {*} [options] Override http request option.
|
|
16705
16792
|
* @throws {RequiredError}
|
|
16706
16793
|
*/
|
|
@@ -16750,7 +16837,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
16750
16837
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
16751
16838
|
* @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).
|
|
16752
16839
|
* @param {boolean} [ignoreErrors]
|
|
16753
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
16840
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
16754
16841
|
* @param {*} [options] Override http request option.
|
|
16755
16842
|
* @throws {RequiredError}
|
|
16756
16843
|
*/
|
|
@@ -16889,7 +16976,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
16889
16976
|
* @summary Extend a record
|
|
16890
16977
|
* @param {string} uuid
|
|
16891
16978
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
16892
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
16979
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
16893
16980
|
* @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).
|
|
16894
16981
|
* @param {*} [options] Override http request option.
|
|
16895
16982
|
* @throws {RequiredError}
|
|
@@ -16937,7 +17024,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
16937
17024
|
* @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).
|
|
16938
17025
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
16939
17026
|
* @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.
|
|
16940
|
-
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17027
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
16941
17028
|
* @param {*} [options] Override http request option.
|
|
16942
17029
|
* @throws {RequiredError}
|
|
16943
17030
|
*/
|
|
@@ -17232,7 +17319,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
17232
17319
|
* @param {SearchRequest} searchRequest Search criteria
|
|
17233
17320
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
17234
17321
|
* @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).
|
|
17235
|
-
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17322
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17236
17323
|
* @param {*} [options] Override http request option.
|
|
17237
17324
|
* @throws {RequiredError}
|
|
17238
17325
|
*/
|
|
@@ -17319,7 +17406,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
17319
17406
|
* @summary Get record details
|
|
17320
17407
|
* @param {string} uuid
|
|
17321
17408
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
17322
|
-
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17409
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17323
17410
|
* @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).
|
|
17324
17411
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
17325
17412
|
* @param {*} [options] Override http request option.
|
|
@@ -17368,7 +17455,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
17368
17455
|
* @summary Get record details by object
|
|
17369
17456
|
* @param {string} objectName
|
|
17370
17457
|
* @param {string} uuid
|
|
17371
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17458
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17372
17459
|
* @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).
|
|
17373
17460
|
* @param {*} [options] Override http request option.
|
|
17374
17461
|
* @throws {RequiredError}
|
|
@@ -17450,7 +17537,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
17450
17537
|
* @param {RecordDTO} recordDTO Record data to update
|
|
17451
17538
|
* @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).
|
|
17452
17539
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17453
|
-
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17540
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17454
17541
|
* @param {*} [options] Override http request option.
|
|
17455
17542
|
* @throws {RequiredError}
|
|
17456
17543
|
*/
|
|
@@ -17504,7 +17591,7 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
17504
17591
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
17505
17592
|
* @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).
|
|
17506
17593
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17507
|
-
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17594
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17508
17595
|
* @param {*} [options] Override http request option.
|
|
17509
17596
|
* @throws {RequiredError}
|
|
17510
17597
|
*/
|
|
@@ -17695,7 +17782,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17695
17782
|
* @param {RecordDTO} recordDTO Record data to create
|
|
17696
17783
|
* @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).
|
|
17697
17784
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
17698
|
-
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17785
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17699
17786
|
* @param {*} [options] Override http request option.
|
|
17700
17787
|
* @throws {RequiredError}
|
|
17701
17788
|
*/
|
|
@@ -17715,7 +17802,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17715
17802
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
17716
17803
|
* @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).
|
|
17717
17804
|
* @param {boolean} [ignoreErrors]
|
|
17718
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17805
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17719
17806
|
* @param {*} [options] Override http request option.
|
|
17720
17807
|
* @throws {RequiredError}
|
|
17721
17808
|
*/
|
|
@@ -17771,7 +17858,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17771
17858
|
* @summary Extend a record
|
|
17772
17859
|
* @param {string} uuid
|
|
17773
17860
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
17774
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17861
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17775
17862
|
* @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).
|
|
17776
17863
|
* @param {*} [options] Override http request option.
|
|
17777
17864
|
* @throws {RequiredError}
|
|
@@ -17792,7 +17879,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17792
17879
|
* @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).
|
|
17793
17880
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
17794
17881
|
* @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.
|
|
17795
|
-
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
17882
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17796
17883
|
* @param {*} [options] Override http request option.
|
|
17797
17884
|
* @throws {RequiredError}
|
|
17798
17885
|
*/
|
|
@@ -17918,7 +18005,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17918
18005
|
* @param {SearchRequest} searchRequest Search criteria
|
|
17919
18006
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
17920
18007
|
* @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).
|
|
17921
|
-
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18008
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17922
18009
|
* @param {*} [options] Override http request option.
|
|
17923
18010
|
* @throws {RequiredError}
|
|
17924
18011
|
*/
|
|
@@ -17954,7 +18041,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17954
18041
|
* @summary Get record details
|
|
17955
18042
|
* @param {string} uuid
|
|
17956
18043
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
17957
|
-
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18044
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17958
18045
|
* @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).
|
|
17959
18046
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
17960
18047
|
* @param {*} [options] Override http request option.
|
|
@@ -17974,7 +18061,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17974
18061
|
* @summary Get record details by object
|
|
17975
18062
|
* @param {string} objectName
|
|
17976
18063
|
* @param {string} uuid
|
|
17977
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18064
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
17978
18065
|
* @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).
|
|
17979
18066
|
* @param {*} [options] Override http request option.
|
|
17980
18067
|
* @throws {RequiredError}
|
|
@@ -18012,7 +18099,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
18012
18099
|
* @param {RecordDTO} recordDTO Record data to update
|
|
18013
18100
|
* @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).
|
|
18014
18101
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18015
|
-
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18102
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18016
18103
|
* @param {*} [options] Override http request option.
|
|
18017
18104
|
* @throws {RequiredError}
|
|
18018
18105
|
*/
|
|
@@ -18033,7 +18120,7 @@ export const RecordsApiFp = function (configuration) {
|
|
|
18033
18120
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
18034
18121
|
* @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).
|
|
18035
18122
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18036
|
-
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18123
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18037
18124
|
* @param {*} [options] Override http request option.
|
|
18038
18125
|
* @throws {RequiredError}
|
|
18039
18126
|
*/
|
|
@@ -18134,7 +18221,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18134
18221
|
* @param {RecordDTO} recordDTO Record data to create
|
|
18135
18222
|
* @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).
|
|
18136
18223
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18137
|
-
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18224
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18138
18225
|
* @param {*} [options] Override http request option.
|
|
18139
18226
|
* @throws {RequiredError}
|
|
18140
18227
|
*/
|
|
@@ -18148,7 +18235,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18148
18235
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
18149
18236
|
* @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).
|
|
18150
18237
|
* @param {boolean} [ignoreErrors]
|
|
18151
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18238
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18152
18239
|
* @param {*} [options] Override http request option.
|
|
18153
18240
|
* @throws {RequiredError}
|
|
18154
18241
|
*/
|
|
@@ -18186,7 +18273,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18186
18273
|
* @summary Extend a record
|
|
18187
18274
|
* @param {string} uuid
|
|
18188
18275
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
18189
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18276
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18190
18277
|
* @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).
|
|
18191
18278
|
* @param {*} [options] Override http request option.
|
|
18192
18279
|
* @throws {RequiredError}
|
|
@@ -18201,7 +18288,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18201
18288
|
* @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).
|
|
18202
18289
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
18203
18290
|
* @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.
|
|
18204
|
-
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18291
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18205
18292
|
* @param {*} [options] Override http request option.
|
|
18206
18293
|
* @throws {RequiredError}
|
|
18207
18294
|
*/
|
|
@@ -18285,7 +18372,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18285
18372
|
* @param {SearchRequest} searchRequest Search criteria
|
|
18286
18373
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
18287
18374
|
* @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).
|
|
18288
|
-
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18375
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18289
18376
|
* @param {*} [options] Override http request option.
|
|
18290
18377
|
* @throws {RequiredError}
|
|
18291
18378
|
*/
|
|
@@ -18309,7 +18396,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18309
18396
|
* @summary Get record details
|
|
18310
18397
|
* @param {string} uuid
|
|
18311
18398
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
18312
|
-
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18399
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18313
18400
|
* @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).
|
|
18314
18401
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
18315
18402
|
* @param {*} [options] Override http request option.
|
|
@@ -18323,7 +18410,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18323
18410
|
* @summary Get record details by object
|
|
18324
18411
|
* @param {string} objectName
|
|
18325
18412
|
* @param {string} uuid
|
|
18326
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18413
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18327
18414
|
* @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).
|
|
18328
18415
|
* @param {*} [options] Override http request option.
|
|
18329
18416
|
* @throws {RequiredError}
|
|
@@ -18349,7 +18436,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18349
18436
|
* @param {RecordDTO} recordDTO Record data to update
|
|
18350
18437
|
* @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).
|
|
18351
18438
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18352
|
-
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18439
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18353
18440
|
* @param {*} [options] Override http request option.
|
|
18354
18441
|
* @throws {RequiredError}
|
|
18355
18442
|
*/
|
|
@@ -18364,7 +18451,7 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
18364
18451
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
18365
18452
|
* @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).
|
|
18366
18453
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18367
|
-
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18454
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18368
18455
|
* @param {*} [options] Override http request option.
|
|
18369
18456
|
* @throws {RequiredError}
|
|
18370
18457
|
*/
|
|
@@ -18451,7 +18538,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18451
18538
|
* @param {RecordDTO} recordDTO Record data to create
|
|
18452
18539
|
* @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).
|
|
18453
18540
|
* @param {boolean} [ignoreErrors] If \'true\', allows the creation to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18454
|
-
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18541
|
+
* @param {CreateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18455
18542
|
* @param {*} [options] Override http request option.
|
|
18456
18543
|
* @throws {RequiredError}
|
|
18457
18544
|
*/
|
|
@@ -18465,7 +18552,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18465
18552
|
* @param {RecordDTO} recordDTO Record data to create or update. Top-level uuid updates that record when it already exists.
|
|
18466
18553
|
* @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).
|
|
18467
18554
|
* @param {boolean} [ignoreErrors]
|
|
18468
|
-
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18555
|
+
* @param {CreateOrUpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18469
18556
|
* @param {*} [options] Override http request option.
|
|
18470
18557
|
* @throws {RequiredError}
|
|
18471
18558
|
*/
|
|
@@ -18503,7 +18590,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18503
18590
|
* @summary Extend a record
|
|
18504
18591
|
* @param {string} uuid
|
|
18505
18592
|
* @param {ExtendRecordRequest} extendRecordRequest
|
|
18506
|
-
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18593
|
+
* @param {ExtendRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18507
18594
|
* @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).
|
|
18508
18595
|
* @param {*} [options] Override http request option.
|
|
18509
18596
|
* @throws {RequiredError}
|
|
@@ -18518,7 +18605,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18518
18605
|
* @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).
|
|
18519
18606
|
* @param {boolean} [archived] When \'true\', archived records are returned instead of active records. Defaults to \'false\'.
|
|
18520
18607
|
* @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.
|
|
18521
|
-
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18608
|
+
* @param {IndexRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18522
18609
|
* @param {*} [options] Override http request option.
|
|
18523
18610
|
* @throws {RequiredError}
|
|
18524
18611
|
*/
|
|
@@ -18602,7 +18689,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18602
18689
|
* @param {SearchRequest} searchRequest Search criteria
|
|
18603
18690
|
* @param {boolean} [archived] When set to \'true\', includes soft-deleted records in the search results.
|
|
18604
18691
|
* @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).
|
|
18605
|
-
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18692
|
+
* @param {SearchRecordReturnFormatEnum} [recordReturnFormat] Format of the records to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18606
18693
|
* @param {*} [options] Override http request option.
|
|
18607
18694
|
* @throws {RequiredError}
|
|
18608
18695
|
*/
|
|
@@ -18626,7 +18713,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18626
18713
|
* @summary Get record details
|
|
18627
18714
|
* @param {string} uuid
|
|
18628
18715
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
18629
|
-
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18716
|
+
* @param {ShowRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18630
18717
|
* @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).
|
|
18631
18718
|
* @param {string} [fields] Comma-separated property names to include (for example: name,status). When omitted, all properties are returned.
|
|
18632
18719
|
* @param {*} [options] Override http request option.
|
|
@@ -18640,7 +18727,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18640
18727
|
* @summary Get record details by object
|
|
18641
18728
|
* @param {string} objectName
|
|
18642
18729
|
* @param {string} uuid
|
|
18643
|
-
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18730
|
+
* @param {ShowByObjectRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18644
18731
|
* @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).
|
|
18645
18732
|
* @param {*} [options] Override http request option.
|
|
18646
18733
|
* @throws {RequiredError}
|
|
@@ -18666,7 +18753,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18666
18753
|
* @param {RecordDTO} recordDTO Record data to update
|
|
18667
18754
|
* @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).
|
|
18668
18755
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18669
|
-
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18756
|
+
* @param {UpdateRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18670
18757
|
* @param {*} [options] Override http request option.
|
|
18671
18758
|
* @throws {RequiredError}
|
|
18672
18759
|
*/
|
|
@@ -18681,7 +18768,7 @@ export class RecordsApi extends BaseAPI {
|
|
|
18681
18768
|
* @param {string} [object] Optional object name to resolve the record in a specific object context.
|
|
18682
18769
|
* @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).
|
|
18683
18770
|
* @param {boolean} [ignoreErrors] If \'true\', allows the update to proceed while ignoring certain non-critical validation errors, when supported.
|
|
18684
|
-
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED.
|
|
18771
|
+
* @param {UpdateByUuidRecordReturnFormatEnum} [recordReturnFormat] Format of the record to return. LEGACY, USER_FRIENDLY, EXPANDED, MINIMAL.
|
|
18685
18772
|
* @param {*} [options] Override http request option.
|
|
18686
18773
|
* @throws {RequiredError}
|
|
18687
18774
|
*/
|
|
@@ -18711,6 +18798,7 @@ export const CreateRecordReturnFormatEnum = {
|
|
|
18711
18798
|
Legacy: 'LEGACY',
|
|
18712
18799
|
UserFriendly: 'USER_FRIENDLY',
|
|
18713
18800
|
Expanded: 'EXPANDED',
|
|
18801
|
+
Minimal: 'MINIMAL',
|
|
18714
18802
|
};
|
|
18715
18803
|
export const CreateOrUpdateParseEnum = {
|
|
18716
18804
|
Db: 'DB',
|
|
@@ -18721,11 +18809,13 @@ export const CreateOrUpdateRecordReturnFormatEnum = {
|
|
|
18721
18809
|
Legacy: 'LEGACY',
|
|
18722
18810
|
UserFriendly: 'USER_FRIENDLY',
|
|
18723
18811
|
Expanded: 'EXPANDED',
|
|
18812
|
+
Minimal: 'MINIMAL',
|
|
18724
18813
|
};
|
|
18725
18814
|
export const ExtendRecordReturnFormatEnum = {
|
|
18726
18815
|
Legacy: 'LEGACY',
|
|
18727
18816
|
UserFriendly: 'USER_FRIENDLY',
|
|
18728
18817
|
Expanded: 'EXPANDED',
|
|
18818
|
+
Minimal: 'MINIMAL',
|
|
18729
18819
|
};
|
|
18730
18820
|
export const ExtendParseEnum = {
|
|
18731
18821
|
Db: 'DB',
|
|
@@ -18741,6 +18831,7 @@ export const IndexRecordReturnFormatEnum = {
|
|
|
18741
18831
|
Legacy: 'LEGACY',
|
|
18742
18832
|
UserFriendly: 'USER_FRIENDLY',
|
|
18743
18833
|
Expanded: 'EXPANDED',
|
|
18834
|
+
Minimal: 'MINIMAL',
|
|
18744
18835
|
};
|
|
18745
18836
|
export const IndexFlowParseEnum = {
|
|
18746
18837
|
Db: 'DB',
|
|
@@ -18761,6 +18852,7 @@ export const SearchRecordReturnFormatEnum = {
|
|
|
18761
18852
|
Legacy: 'LEGACY',
|
|
18762
18853
|
UserFriendly: 'USER_FRIENDLY',
|
|
18763
18854
|
Expanded: 'EXPANDED',
|
|
18855
|
+
Minimal: 'MINIMAL',
|
|
18764
18856
|
};
|
|
18765
18857
|
export const SearchCrossObjectParseEnum = {
|
|
18766
18858
|
Db: 'DB',
|
|
@@ -18771,6 +18863,7 @@ export const ShowRecordReturnFormatEnum = {
|
|
|
18771
18863
|
Legacy: 'LEGACY',
|
|
18772
18864
|
UserFriendly: 'USER_FRIENDLY',
|
|
18773
18865
|
Expanded: 'EXPANDED',
|
|
18866
|
+
Minimal: 'MINIMAL',
|
|
18774
18867
|
};
|
|
18775
18868
|
export const ShowParseEnum = {
|
|
18776
18869
|
Db: 'DB',
|
|
@@ -18781,6 +18874,7 @@ export const ShowByObjectRecordReturnFormatEnum = {
|
|
|
18781
18874
|
Legacy: 'LEGACY',
|
|
18782
18875
|
UserFriendly: 'USER_FRIENDLY',
|
|
18783
18876
|
Expanded: 'EXPANDED',
|
|
18877
|
+
Minimal: 'MINIMAL',
|
|
18784
18878
|
};
|
|
18785
18879
|
export const ShowByObjectParseEnum = {
|
|
18786
18880
|
Db: 'DB',
|
|
@@ -18796,6 +18890,7 @@ export const UpdateRecordReturnFormatEnum = {
|
|
|
18796
18890
|
Legacy: 'LEGACY',
|
|
18797
18891
|
UserFriendly: 'USER_FRIENDLY',
|
|
18798
18892
|
Expanded: 'EXPANDED',
|
|
18893
|
+
Minimal: 'MINIMAL',
|
|
18799
18894
|
};
|
|
18800
18895
|
export const UpdateByUuidParseEnum = {
|
|
18801
18896
|
Db: 'DB',
|
|
@@ -18806,6 +18901,7 @@ export const UpdateByUuidRecordReturnFormatEnum = {
|
|
|
18806
18901
|
Legacy: 'LEGACY',
|
|
18807
18902
|
UserFriendly: 'USER_FRIENDLY',
|
|
18808
18903
|
Expanded: 'EXPANDED',
|
|
18904
|
+
Minimal: 'MINIMAL',
|
|
18809
18905
|
};
|
|
18810
18906
|
/**
|
|
18811
18907
|
* RelationsApi - axios parameter creator
|
package/docs/CMSV2PublicApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
13
13
|
|[**pageGate**](#pagegate) | **GET** /api/v2/webpages/v2/public/page/gate | Protection info for a path, without the page document|
|
|
14
14
|
|[**paths**](#paths) | **GET** /api/v2/webpages/v2/public/paths | Published paths per environment, for sitemaps and cache warming|
|
|
15
15
|
|[**records**](#records) | **POST** /api/v2/webpages/v2/public/records | Public records visible in an environment|
|
|
16
|
+
|[**redirect**](#redirect) | **GET** /api/v2/webpages/v2/public/redirect | Resolve a historical CMS v2 path to its latest published route|
|
|
16
17
|
|[**settings**](#settings) | **GET** /api/v2/webpages/v2/public/settings | Company settings, branding and locales|
|
|
17
18
|
|[**unlock**](#unlock) | **POST** /api/v2/webpages/v2/public/page/{uuid}/unlock | Unlock a password-protected CMS v2 page|
|
|
18
19
|
|
|
@@ -609,6 +610,67 @@ const { status, data } = await apiInstance.records(
|
|
|
609
610
|
- **Accept**: application/json
|
|
610
611
|
|
|
611
612
|
|
|
613
|
+
### HTTP response details
|
|
614
|
+
| Status code | Description | Response headers |
|
|
615
|
+
|-------------|-------------|------------------|
|
|
616
|
+
|**200** | OK | - |
|
|
617
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
618
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
619
|
+
|**404** | The requested resource was not found. | - |
|
|
620
|
+
|**500** | An internal server error occurred. | - |
|
|
621
|
+
|
|
622
|
+
[[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)
|
|
623
|
+
|
|
624
|
+
# **redirect**
|
|
625
|
+
> ShowResponseMapStringString redirect()
|
|
626
|
+
|
|
627
|
+
Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
628
|
+
|
|
629
|
+
### Example
|
|
630
|
+
|
|
631
|
+
```typescript
|
|
632
|
+
import {
|
|
633
|
+
CMSV2PublicApi,
|
|
634
|
+
Configuration
|
|
635
|
+
} from '@caraer/client';
|
|
636
|
+
|
|
637
|
+
const configuration = new Configuration();
|
|
638
|
+
const apiInstance = new CMSV2PublicApi(configuration);
|
|
639
|
+
|
|
640
|
+
let xCaraerSubdomain: string; // (default to undefined)
|
|
641
|
+
let path: string; // (default to undefined)
|
|
642
|
+
let environment: string; // (optional) (default to 'main')
|
|
643
|
+
|
|
644
|
+
const { status, data } = await apiInstance.redirect(
|
|
645
|
+
xCaraerSubdomain,
|
|
646
|
+
path,
|
|
647
|
+
environment
|
|
648
|
+
);
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### Parameters
|
|
652
|
+
|
|
653
|
+
|Name | Type | Description | Notes|
|
|
654
|
+
|------------- | ------------- | ------------- | -------------|
|
|
655
|
+
| **xCaraerSubdomain** | [**string**] | | defaults to undefined|
|
|
656
|
+
| **path** | [**string**] | | defaults to undefined|
|
|
657
|
+
| **environment** | [**string**] | | (optional) defaults to 'main'|
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
### Return type
|
|
661
|
+
|
|
662
|
+
**ShowResponseMapStringString**
|
|
663
|
+
|
|
664
|
+
### Authorization
|
|
665
|
+
|
|
666
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
667
|
+
|
|
668
|
+
### HTTP request headers
|
|
669
|
+
|
|
670
|
+
- **Content-Type**: Not defined
|
|
671
|
+
- **Accept**: application/json
|
|
672
|
+
|
|
673
|
+
|
|
612
674
|
### HTTP response details
|
|
613
675
|
| Status code | Description | Response headers |
|
|
614
676
|
|-------------|-------------|------------------|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**yproperty** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**xproperty** | **string** | | [optional] [default to undefined]
|
|
10
8
|
**ymetric** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**xproperty** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**yproperty** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**chartType** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**xProperty** | **string** | | [optional] [default to undefined]
|
|
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
|
|
|
20
20
|
import { ExistingWidgetSummary } from '@caraer/client';
|
|
21
21
|
|
|
22
22
|
const instance: ExistingWidgetSummary = {
|
|
23
|
-
yproperty,
|
|
24
|
-
xproperty,
|
|
25
23
|
ymetric,
|
|
24
|
+
xproperty,
|
|
25
|
+
yproperty,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|
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<FilledProperty>**](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
|
|