@caraer/client 2.0.701 → 2.0.703
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 +260 -5
- package/dist/api.d.ts +130 -5
- package/dist/api.js +243 -0
- package/dist/esm/api.d.ts +130 -5
- package/dist/esm/api.js +243 -0
- package/docs/AppSettingFieldSchema.md +2 -2
- package/docs/CMSV2PagesApi.md +180 -0
- package/docs/CmsPagePatch.md +2 -0
- package/docs/Record.md +4 -4
- package/docs/SettingField.md +2 -2
- package/docs/Team.md +2 -2
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -6177,6 +6177,84 @@ export const CMSV2PagesApiAxiosParamCreator = function (configuration) {
|
|
|
6177
6177
|
options: localVarRequestOptions,
|
|
6178
6178
|
};
|
|
6179
6179
|
}),
|
|
6180
|
+
/**
|
|
6181
|
+
*
|
|
6182
|
+
* @summary Cancel or retry a module replacement
|
|
6183
|
+
* @param {string} recordUuid
|
|
6184
|
+
* @param {string} replacementId
|
|
6185
|
+
* @param {string} action
|
|
6186
|
+
* @param {*} [options] Override http request option.
|
|
6187
|
+
* @throws {RequiredError}
|
|
6188
|
+
*/
|
|
6189
|
+
moduleReplacementAction: (recordUuid_1, replacementId_1, action_1, ...args_1) => __awaiter(this, [recordUuid_1, replacementId_1, action_1, ...args_1], void 0, function* (recordUuid, replacementId, action, options = {}) {
|
|
6190
|
+
// verify required parameter 'recordUuid' is not null or undefined
|
|
6191
|
+
assertParamExists('moduleReplacementAction', 'recordUuid', recordUuid);
|
|
6192
|
+
// verify required parameter 'replacementId' is not null or undefined
|
|
6193
|
+
assertParamExists('moduleReplacementAction', 'replacementId', replacementId);
|
|
6194
|
+
// verify required parameter 'action' is not null or undefined
|
|
6195
|
+
assertParamExists('moduleReplacementAction', 'action', action);
|
|
6196
|
+
const localVarPath = `/api/v2/webpages/v2/pages/{recordUuid}/module-replacements/{replacementId}/{action}`
|
|
6197
|
+
.replace('{recordUuid}', encodeURIComponent(String(recordUuid)))
|
|
6198
|
+
.replace('{replacementId}', encodeURIComponent(String(replacementId)))
|
|
6199
|
+
.replace('{action}', encodeURIComponent(String(action)));
|
|
6200
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6201
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6202
|
+
let baseOptions;
|
|
6203
|
+
if (configuration) {
|
|
6204
|
+
baseOptions = configuration.baseOptions;
|
|
6205
|
+
}
|
|
6206
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
6207
|
+
const localVarHeaderParameter = {};
|
|
6208
|
+
const localVarQueryParameter = {};
|
|
6209
|
+
// authentication bearerAuth required
|
|
6210
|
+
// http bearer authentication required
|
|
6211
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6212
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
6213
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6214
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6215
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6216
|
+
return {
|
|
6217
|
+
url: toPathString(localVarUrlObj),
|
|
6218
|
+
options: localVarRequestOptions,
|
|
6219
|
+
};
|
|
6220
|
+
}),
|
|
6221
|
+
/**
|
|
6222
|
+
*
|
|
6223
|
+
* @summary Check durable module replacements and apply ready builds to the draft
|
|
6224
|
+
* @param {string} recordUuid
|
|
6225
|
+
* @param {string} [locale]
|
|
6226
|
+
* @param {*} [options] Override http request option.
|
|
6227
|
+
* @throws {RequiredError}
|
|
6228
|
+
*/
|
|
6229
|
+
moduleReplacements: (recordUuid_1, locale_1, ...args_1) => __awaiter(this, [recordUuid_1, locale_1, ...args_1], void 0, function* (recordUuid, locale, options = {}) {
|
|
6230
|
+
// verify required parameter 'recordUuid' is not null or undefined
|
|
6231
|
+
assertParamExists('moduleReplacements', 'recordUuid', recordUuid);
|
|
6232
|
+
const localVarPath = `/api/v2/webpages/v2/pages/{recordUuid}/module-replacements`
|
|
6233
|
+
.replace('{recordUuid}', encodeURIComponent(String(recordUuid)));
|
|
6234
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6235
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6236
|
+
let baseOptions;
|
|
6237
|
+
if (configuration) {
|
|
6238
|
+
baseOptions = configuration.baseOptions;
|
|
6239
|
+
}
|
|
6240
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
6241
|
+
const localVarHeaderParameter = {};
|
|
6242
|
+
const localVarQueryParameter = {};
|
|
6243
|
+
// authentication bearerAuth required
|
|
6244
|
+
// http bearer authentication required
|
|
6245
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6246
|
+
if (locale !== undefined) {
|
|
6247
|
+
localVarQueryParameter['locale'] = locale;
|
|
6248
|
+
}
|
|
6249
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
6250
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6251
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6252
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6253
|
+
return {
|
|
6254
|
+
url: toPathString(localVarUrlObj),
|
|
6255
|
+
options: localVarRequestOptions,
|
|
6256
|
+
};
|
|
6257
|
+
}),
|
|
6180
6258
|
/**
|
|
6181
6259
|
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
6182
6260
|
* @summary Apply patches to a page draft
|
|
@@ -6339,6 +6417,48 @@ export const CMSV2PagesApiAxiosParamCreator = function (configuration) {
|
|
|
6339
6417
|
options: localVarRequestOptions,
|
|
6340
6418
|
};
|
|
6341
6419
|
}),
|
|
6420
|
+
/**
|
|
6421
|
+
*
|
|
6422
|
+
* @summary Publish a template draft and update linked live pages
|
|
6423
|
+
* @param {string} objectUuid
|
|
6424
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
6425
|
+
* @param {string} [locale]
|
|
6426
|
+
* @param {*} [options] Override http request option.
|
|
6427
|
+
* @throws {RequiredError}
|
|
6428
|
+
*/
|
|
6429
|
+
publishTemplate: (objectUuid_1, requestBody_1, locale_1, ...args_1) => __awaiter(this, [objectUuid_1, requestBody_1, locale_1, ...args_1], void 0, function* (objectUuid, requestBody, locale, options = {}) {
|
|
6430
|
+
// verify required parameter 'objectUuid' is not null or undefined
|
|
6431
|
+
assertParamExists('publishTemplate', 'objectUuid', objectUuid);
|
|
6432
|
+
// verify required parameter 'requestBody' is not null or undefined
|
|
6433
|
+
assertParamExists('publishTemplate', 'requestBody', requestBody);
|
|
6434
|
+
const localVarPath = `/api/v2/webpages/v2/pages/templates/{objectUuid}/publish`
|
|
6435
|
+
.replace('{objectUuid}', encodeURIComponent(String(objectUuid)));
|
|
6436
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6437
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6438
|
+
let baseOptions;
|
|
6439
|
+
if (configuration) {
|
|
6440
|
+
baseOptions = configuration.baseOptions;
|
|
6441
|
+
}
|
|
6442
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
6443
|
+
const localVarHeaderParameter = {};
|
|
6444
|
+
const localVarQueryParameter = {};
|
|
6445
|
+
// authentication bearerAuth required
|
|
6446
|
+
// http bearer authentication required
|
|
6447
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6448
|
+
if (locale !== undefined) {
|
|
6449
|
+
localVarQueryParameter['locale'] = locale;
|
|
6450
|
+
}
|
|
6451
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6452
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
6453
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6454
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6455
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6456
|
+
localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration);
|
|
6457
|
+
return {
|
|
6458
|
+
url: toPathString(localVarUrlObj),
|
|
6459
|
+
options: localVarRequestOptions,
|
|
6460
|
+
};
|
|
6461
|
+
}),
|
|
6342
6462
|
/**
|
|
6343
6463
|
*
|
|
6344
6464
|
* @summary Restore a draft snapshot
|
|
@@ -6922,6 +7042,41 @@ export const CMSV2PagesApiFp = function (configuration) {
|
|
|
6922
7042
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6923
7043
|
});
|
|
6924
7044
|
},
|
|
7045
|
+
/**
|
|
7046
|
+
*
|
|
7047
|
+
* @summary Cancel or retry a module replacement
|
|
7048
|
+
* @param {string} recordUuid
|
|
7049
|
+
* @param {string} replacementId
|
|
7050
|
+
* @param {string} action
|
|
7051
|
+
* @param {*} [options] Override http request option.
|
|
7052
|
+
* @throws {RequiredError}
|
|
7053
|
+
*/
|
|
7054
|
+
moduleReplacementAction(recordUuid, replacementId, action, options) {
|
|
7055
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
7056
|
+
var _a, _b, _c;
|
|
7057
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.moduleReplacementAction(recordUuid, replacementId, action, options);
|
|
7058
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7059
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSV2PagesApi.moduleReplacementAction']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7060
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7061
|
+
});
|
|
7062
|
+
},
|
|
7063
|
+
/**
|
|
7064
|
+
*
|
|
7065
|
+
* @summary Check durable module replacements and apply ready builds to the draft
|
|
7066
|
+
* @param {string} recordUuid
|
|
7067
|
+
* @param {string} [locale]
|
|
7068
|
+
* @param {*} [options] Override http request option.
|
|
7069
|
+
* @throws {RequiredError}
|
|
7070
|
+
*/
|
|
7071
|
+
moduleReplacements(recordUuid, locale, options) {
|
|
7072
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
7073
|
+
var _a, _b, _c;
|
|
7074
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.moduleReplacements(recordUuid, locale, options);
|
|
7075
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7076
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSV2PagesApi.moduleReplacements']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7077
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7078
|
+
});
|
|
7079
|
+
},
|
|
6925
7080
|
/**
|
|
6926
7081
|
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
6927
7082
|
* @summary Apply patches to a page draft
|
|
@@ -6993,6 +7148,24 @@ export const CMSV2PagesApiFp = function (configuration) {
|
|
|
6993
7148
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6994
7149
|
});
|
|
6995
7150
|
},
|
|
7151
|
+
/**
|
|
7152
|
+
*
|
|
7153
|
+
* @summary Publish a template draft and update linked live pages
|
|
7154
|
+
* @param {string} objectUuid
|
|
7155
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
7156
|
+
* @param {string} [locale]
|
|
7157
|
+
* @param {*} [options] Override http request option.
|
|
7158
|
+
* @throws {RequiredError}
|
|
7159
|
+
*/
|
|
7160
|
+
publishTemplate(objectUuid, requestBody, locale, options) {
|
|
7161
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
7162
|
+
var _a, _b, _c;
|
|
7163
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.publishTemplate(objectUuid, requestBody, locale, options);
|
|
7164
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7165
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSV2PagesApi.publishTemplate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7166
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7167
|
+
});
|
|
7168
|
+
},
|
|
6996
7169
|
/**
|
|
6997
7170
|
*
|
|
6998
7171
|
* @summary Restore a draft snapshot
|
|
@@ -7285,6 +7458,29 @@ export const CMSV2PagesApiFactory = function (configuration, basePath, axios) {
|
|
|
7285
7458
|
library(options) {
|
|
7286
7459
|
return localVarFp.library(options).then((request) => request(axios, basePath));
|
|
7287
7460
|
},
|
|
7461
|
+
/**
|
|
7462
|
+
*
|
|
7463
|
+
* @summary Cancel or retry a module replacement
|
|
7464
|
+
* @param {string} recordUuid
|
|
7465
|
+
* @param {string} replacementId
|
|
7466
|
+
* @param {string} action
|
|
7467
|
+
* @param {*} [options] Override http request option.
|
|
7468
|
+
* @throws {RequiredError}
|
|
7469
|
+
*/
|
|
7470
|
+
moduleReplacementAction(recordUuid, replacementId, action, options) {
|
|
7471
|
+
return localVarFp.moduleReplacementAction(recordUuid, replacementId, action, options).then((request) => request(axios, basePath));
|
|
7472
|
+
},
|
|
7473
|
+
/**
|
|
7474
|
+
*
|
|
7475
|
+
* @summary Check durable module replacements and apply ready builds to the draft
|
|
7476
|
+
* @param {string} recordUuid
|
|
7477
|
+
* @param {string} [locale]
|
|
7478
|
+
* @param {*} [options] Override http request option.
|
|
7479
|
+
* @throws {RequiredError}
|
|
7480
|
+
*/
|
|
7481
|
+
moduleReplacements(recordUuid, locale, options) {
|
|
7482
|
+
return localVarFp.moduleReplacements(recordUuid, locale, options).then((request) => request(axios, basePath));
|
|
7483
|
+
},
|
|
7288
7484
|
/**
|
|
7289
7485
|
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
7290
7486
|
* @summary Apply patches to a page draft
|
|
@@ -7332,6 +7528,18 @@ export const CMSV2PagesApiFactory = function (configuration, basePath, axios) {
|
|
|
7332
7528
|
publish(recordUuid, locale, allLocales, options) {
|
|
7333
7529
|
return localVarFp.publish(recordUuid, locale, allLocales, options).then((request) => request(axios, basePath));
|
|
7334
7530
|
},
|
|
7531
|
+
/**
|
|
7532
|
+
*
|
|
7533
|
+
* @summary Publish a template draft and update linked live pages
|
|
7534
|
+
* @param {string} objectUuid
|
|
7535
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
7536
|
+
* @param {string} [locale]
|
|
7537
|
+
* @param {*} [options] Override http request option.
|
|
7538
|
+
* @throws {RequiredError}
|
|
7539
|
+
*/
|
|
7540
|
+
publishTemplate(objectUuid, requestBody, locale, options) {
|
|
7541
|
+
return localVarFp.publishTemplate(objectUuid, requestBody, locale, options).then((request) => request(axios, basePath));
|
|
7542
|
+
},
|
|
7335
7543
|
/**
|
|
7336
7544
|
*
|
|
7337
7545
|
* @summary Restore a draft snapshot
|
|
@@ -7562,6 +7770,29 @@ export class CMSV2PagesApi extends BaseAPI {
|
|
|
7562
7770
|
library(options) {
|
|
7563
7771
|
return CMSV2PagesApiFp(this.configuration).library(options).then((request) => request(this.axios, this.basePath));
|
|
7564
7772
|
}
|
|
7773
|
+
/**
|
|
7774
|
+
*
|
|
7775
|
+
* @summary Cancel or retry a module replacement
|
|
7776
|
+
* @param {string} recordUuid
|
|
7777
|
+
* @param {string} replacementId
|
|
7778
|
+
* @param {string} action
|
|
7779
|
+
* @param {*} [options] Override http request option.
|
|
7780
|
+
* @throws {RequiredError}
|
|
7781
|
+
*/
|
|
7782
|
+
moduleReplacementAction(recordUuid, replacementId, action, options) {
|
|
7783
|
+
return CMSV2PagesApiFp(this.configuration).moduleReplacementAction(recordUuid, replacementId, action, options).then((request) => request(this.axios, this.basePath));
|
|
7784
|
+
}
|
|
7785
|
+
/**
|
|
7786
|
+
*
|
|
7787
|
+
* @summary Check durable module replacements and apply ready builds to the draft
|
|
7788
|
+
* @param {string} recordUuid
|
|
7789
|
+
* @param {string} [locale]
|
|
7790
|
+
* @param {*} [options] Override http request option.
|
|
7791
|
+
* @throws {RequiredError}
|
|
7792
|
+
*/
|
|
7793
|
+
moduleReplacements(recordUuid, locale, options) {
|
|
7794
|
+
return CMSV2PagesApiFp(this.configuration).moduleReplacements(recordUuid, locale, options).then((request) => request(this.axios, this.basePath));
|
|
7795
|
+
}
|
|
7565
7796
|
/**
|
|
7566
7797
|
* Rejected with 409 when expectedRevision does not match, so a stale client cannot overwrite another editor\'s work.
|
|
7567
7798
|
* @summary Apply patches to a page draft
|
|
@@ -7609,6 +7840,18 @@ export class CMSV2PagesApi extends BaseAPI {
|
|
|
7609
7840
|
publish(recordUuid, locale, allLocales, options) {
|
|
7610
7841
|
return CMSV2PagesApiFp(this.configuration).publish(recordUuid, locale, allLocales, options).then((request) => request(this.axios, this.basePath));
|
|
7611
7842
|
}
|
|
7843
|
+
/**
|
|
7844
|
+
*
|
|
7845
|
+
* @summary Publish a template draft and update linked live pages
|
|
7846
|
+
* @param {string} objectUuid
|
|
7847
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
7848
|
+
* @param {string} [locale]
|
|
7849
|
+
* @param {*} [options] Override http request option.
|
|
7850
|
+
* @throws {RequiredError}
|
|
7851
|
+
*/
|
|
7852
|
+
publishTemplate(objectUuid, requestBody, locale, options) {
|
|
7853
|
+
return CMSV2PagesApiFp(this.configuration).publishTemplate(objectUuid, requestBody, locale, options).then((request) => request(this.axios, this.basePath));
|
|
7854
|
+
}
|
|
7612
7855
|
/**
|
|
7613
7856
|
*
|
|
7614
7857
|
* @summary Restore a draft snapshot
|
|
@@ -33,8 +33,8 @@ Name | Type | Description | Notes
|
|
|
33
33
|
**clearValue** | **boolean** | | [optional] [default to undefined]
|
|
34
34
|
**mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) | | [optional] [default to undefined]
|
|
35
35
|
**valueScope** | **string** | | [optional] [default to undefined]
|
|
36
|
-
**settingsGroup** | **boolean** | | [optional] [default to undefined]
|
|
37
36
|
**action** | **boolean** | | [optional] [default to undefined]
|
|
37
|
+
**settingsGroup** | **boolean** | | [optional] [default to undefined]
|
|
38
38
|
**filterPropertyTypes** | **Array<string>** | | [optional] [default to undefined]
|
|
39
39
|
**filterPropertyFormats** | **Array<string>** | | [optional] [default to undefined]
|
|
40
40
|
|
|
@@ -72,8 +72,8 @@ const instance: AppSettingFieldSchema = {
|
|
|
72
72
|
clearValue,
|
|
73
73
|
mappingValue,
|
|
74
74
|
valueScope,
|
|
75
|
-
settingsGroup,
|
|
76
75
|
action,
|
|
76
|
+
settingsGroup,
|
|
77
77
|
filterPropertyTypes,
|
|
78
78
|
filterPropertyFormats,
|
|
79
79
|
};
|
package/docs/CMSV2PagesApi.md
CHANGED
|
@@ -14,10 +14,13 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
14
14
|
|[**history**](#history) | **GET** /api/v2/webpages/v2/pages/{recordUuid}/history | Draft snapshots for one locale|
|
|
15
15
|
|[**hostOnEnvironment**](#hostonenvironment) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/environments/{key}/host | Host this page on another environment|
|
|
16
16
|
|[**library**](#library) | **GET** /api/v2/webpages/v2/pages/library/modules | Modules available to this company|
|
|
17
|
+
|[**moduleReplacementAction**](#modulereplacementaction) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/module-replacements/{replacementId}/{action} | Cancel or retry a module replacement|
|
|
18
|
+
|[**moduleReplacements**](#modulereplacements) | **GET** /api/v2/webpages/v2/pages/{recordUuid}/module-replacements | Check durable module replacements and apply ready builds to the draft|
|
|
17
19
|
|[**patch**](#patch) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/patch | Apply patches to a page draft|
|
|
18
20
|
|[**previewLink**](#previewlink) | **GET** /api/v2/webpages/v2/pages/{recordUuid}/preview-link | Signed preview URL for the builder iframe|
|
|
19
21
|
|[**promptModuleFork**](#promptmodulefork) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/ai/module-fork/sessions/{sessionId}/prompt | Rewrite forked module source from a prompt|
|
|
20
22
|
|[**publish**](#publish) | **PUT** /api/v2/webpages/v2/pages/{recordUuid}/publish | Publish one locale, or all of them|
|
|
23
|
+
|[**publishTemplate**](#publishtemplate) | **PUT** /api/v2/webpages/v2/pages/templates/{objectUuid}/publish | Publish a template draft and update linked live pages|
|
|
21
24
|
|[**restoreHistory**](#restorehistory) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/history/{index}/restore | Restore a draft snapshot|
|
|
22
25
|
|[**save**](#save) | **PUT** /api/v2/webpages/v2/pages/{recordUuid} | Replace a page draft|
|
|
23
26
|
|[**saveMeta**](#savemeta) | **PUT** /api/v2/webpages/v2/pages/{recordUuid}/meta | Update slug, title, excerpt, SEO and page scripts|
|
|
@@ -571,6 +574,123 @@ This endpoint does not have any parameters.
|
|
|
571
574
|
- **Accept**: application/json
|
|
572
575
|
|
|
573
576
|
|
|
577
|
+
### HTTP response details
|
|
578
|
+
| Status code | Description | Response headers |
|
|
579
|
+
|-------------|-------------|------------------|
|
|
580
|
+
|**200** | OK | - |
|
|
581
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
582
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
583
|
+
|**404** | The requested resource was not found. | - |
|
|
584
|
+
|**500** | An internal server error occurred. | - |
|
|
585
|
+
|
|
586
|
+
[[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)
|
|
587
|
+
|
|
588
|
+
# **moduleReplacementAction**
|
|
589
|
+
> ShowResponseMapStringObject moduleReplacementAction()
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
### Example
|
|
593
|
+
|
|
594
|
+
```typescript
|
|
595
|
+
import {
|
|
596
|
+
CMSV2PagesApi,
|
|
597
|
+
Configuration
|
|
598
|
+
} from '@caraer/client';
|
|
599
|
+
|
|
600
|
+
const configuration = new Configuration();
|
|
601
|
+
const apiInstance = new CMSV2PagesApi(configuration);
|
|
602
|
+
|
|
603
|
+
let recordUuid: string; // (default to undefined)
|
|
604
|
+
let replacementId: string; // (default to undefined)
|
|
605
|
+
let action: string; // (default to undefined)
|
|
606
|
+
|
|
607
|
+
const { status, data } = await apiInstance.moduleReplacementAction(
|
|
608
|
+
recordUuid,
|
|
609
|
+
replacementId,
|
|
610
|
+
action
|
|
611
|
+
);
|
|
612
|
+
```
|
|
613
|
+
|
|
614
|
+
### Parameters
|
|
615
|
+
|
|
616
|
+
|Name | Type | Description | Notes|
|
|
617
|
+
|------------- | ------------- | ------------- | -------------|
|
|
618
|
+
| **recordUuid** | [**string**] | | defaults to undefined|
|
|
619
|
+
| **replacementId** | [**string**] | | defaults to undefined|
|
|
620
|
+
| **action** | [**string**] | | defaults to undefined|
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
### Return type
|
|
624
|
+
|
|
625
|
+
**ShowResponseMapStringObject**
|
|
626
|
+
|
|
627
|
+
### Authorization
|
|
628
|
+
|
|
629
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
630
|
+
|
|
631
|
+
### HTTP request headers
|
|
632
|
+
|
|
633
|
+
- **Content-Type**: Not defined
|
|
634
|
+
- **Accept**: application/json
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
### HTTP response details
|
|
638
|
+
| Status code | Description | Response headers |
|
|
639
|
+
|-------------|-------------|------------------|
|
|
640
|
+
|**200** | OK | - |
|
|
641
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
642
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
643
|
+
|**404** | The requested resource was not found. | - |
|
|
644
|
+
|**500** | An internal server error occurred. | - |
|
|
645
|
+
|
|
646
|
+
[[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)
|
|
647
|
+
|
|
648
|
+
# **moduleReplacements**
|
|
649
|
+
> ShowResponseMapStringObject moduleReplacements()
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
### Example
|
|
653
|
+
|
|
654
|
+
```typescript
|
|
655
|
+
import {
|
|
656
|
+
CMSV2PagesApi,
|
|
657
|
+
Configuration
|
|
658
|
+
} from '@caraer/client';
|
|
659
|
+
|
|
660
|
+
const configuration = new Configuration();
|
|
661
|
+
const apiInstance = new CMSV2PagesApi(configuration);
|
|
662
|
+
|
|
663
|
+
let recordUuid: string; // (default to undefined)
|
|
664
|
+
let locale: string; // (optional) (default to undefined)
|
|
665
|
+
|
|
666
|
+
const { status, data } = await apiInstance.moduleReplacements(
|
|
667
|
+
recordUuid,
|
|
668
|
+
locale
|
|
669
|
+
);
|
|
670
|
+
```
|
|
671
|
+
|
|
672
|
+
### Parameters
|
|
673
|
+
|
|
674
|
+
|Name | Type | Description | Notes|
|
|
675
|
+
|------------- | ------------- | ------------- | -------------|
|
|
676
|
+
| **recordUuid** | [**string**] | | defaults to undefined|
|
|
677
|
+
| **locale** | [**string**] | | (optional) defaults to undefined|
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
### Return type
|
|
681
|
+
|
|
682
|
+
**ShowResponseMapStringObject**
|
|
683
|
+
|
|
684
|
+
### Authorization
|
|
685
|
+
|
|
686
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
687
|
+
|
|
688
|
+
### HTTP request headers
|
|
689
|
+
|
|
690
|
+
- **Content-Type**: Not defined
|
|
691
|
+
- **Accept**: application/json
|
|
692
|
+
|
|
693
|
+
|
|
574
694
|
### HTTP response details
|
|
575
695
|
| Status code | Description | Response headers |
|
|
576
696
|
|-------------|-------------|------------------|
|
|
@@ -812,6 +932,66 @@ const { status, data } = await apiInstance.publish(
|
|
|
812
932
|
- **Accept**: application/json
|
|
813
933
|
|
|
814
934
|
|
|
935
|
+
### HTTP response details
|
|
936
|
+
| Status code | Description | Response headers |
|
|
937
|
+
|-------------|-------------|------------------|
|
|
938
|
+
|**200** | OK | - |
|
|
939
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
940
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
941
|
+
|**404** | The requested resource was not found. | - |
|
|
942
|
+
|**500** | An internal server error occurred. | - |
|
|
943
|
+
|
|
944
|
+
[[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)
|
|
945
|
+
|
|
946
|
+
# **publishTemplate**
|
|
947
|
+
> ShowResponseCmsPageDTO publishTemplate(requestBody)
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
### Example
|
|
951
|
+
|
|
952
|
+
```typescript
|
|
953
|
+
import {
|
|
954
|
+
CMSV2PagesApi,
|
|
955
|
+
Configuration
|
|
956
|
+
} from '@caraer/client';
|
|
957
|
+
|
|
958
|
+
const configuration = new Configuration();
|
|
959
|
+
const apiInstance = new CMSV2PagesApi(configuration);
|
|
960
|
+
|
|
961
|
+
let objectUuid: string; // (default to undefined)
|
|
962
|
+
let requestBody: { [key: string]: any | null; }; //
|
|
963
|
+
let locale: string; // (optional) (default to undefined)
|
|
964
|
+
|
|
965
|
+
const { status, data } = await apiInstance.publishTemplate(
|
|
966
|
+
objectUuid,
|
|
967
|
+
requestBody,
|
|
968
|
+
locale
|
|
969
|
+
);
|
|
970
|
+
```
|
|
971
|
+
|
|
972
|
+
### Parameters
|
|
973
|
+
|
|
974
|
+
|Name | Type | Description | Notes|
|
|
975
|
+
|------------- | ------------- | ------------- | -------------|
|
|
976
|
+
| **requestBody** | **{ [key: string]: any | null; }**| | |
|
|
977
|
+
| **objectUuid** | [**string**] | | defaults to undefined|
|
|
978
|
+
| **locale** | [**string**] | | (optional) defaults to undefined|
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
### Return type
|
|
982
|
+
|
|
983
|
+
**ShowResponseCmsPageDTO**
|
|
984
|
+
|
|
985
|
+
### Authorization
|
|
986
|
+
|
|
987
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
988
|
+
|
|
989
|
+
### HTTP request headers
|
|
990
|
+
|
|
991
|
+
- **Content-Type**: application/json
|
|
992
|
+
- **Accept**: application/json
|
|
993
|
+
|
|
994
|
+
|
|
815
995
|
### HTTP response details
|
|
816
996
|
| Status code | Description | Response headers |
|
|
817
997
|
|-------------|-------------|------------------|
|
package/docs/CmsPagePatch.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**op** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**moduleId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**expectedModule** | **string** | | [optional] [default to undefined]
|
|
10
11
|
**ref** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**field** | **string** | | [optional] [default to undefined]
|
|
12
13
|
**value** | **any** | | [optional] [default to undefined]
|
|
@@ -26,6 +27,7 @@ import { CmsPagePatch } from '@caraer/client';
|
|
|
26
27
|
const instance: CmsPagePatch = {
|
|
27
28
|
op,
|
|
28
29
|
moduleId,
|
|
30
|
+
expectedModule,
|
|
29
31
|
ref,
|
|
30
32
|
field,
|
|
31
33
|
value,
|
package/docs/Record.md
CHANGED
|
@@ -14,12 +14,12 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**updatedByUuid** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**deletedByUuid** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**index** | **number** | | [optional] [default to undefined]
|
|
17
|
-
**complete** | **boolean** | | [optional] [default to undefined]
|
|
18
17
|
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
18
|
+
**complete** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**uuid** | **string** | | [default to undefined]
|
|
20
|
+
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
20
21
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
|
|
21
22
|
**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
|
|
|
@@ -36,12 +36,12 @@ const instance: ModelRecord = {
|
|
|
36
36
|
updatedByUuid,
|
|
37
37
|
deletedByUuid,
|
|
38
38
|
index,
|
|
39
|
-
complete,
|
|
40
39
|
deleted,
|
|
40
|
+
complete,
|
|
41
41
|
uuid,
|
|
42
|
+
user,
|
|
42
43
|
properties,
|
|
43
44
|
objects,
|
|
44
|
-
user,
|
|
45
45
|
};
|
|
46
46
|
```
|
|
47
47
|
|
package/docs/SettingField.md
CHANGED
|
@@ -14,8 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**hidden** | **boolean** | | [optional] [default to undefined]
|
|
15
15
|
**disabled** | **boolean** | | [optional] [default to undefined]
|
|
16
16
|
**_options** | [**Array<SettingOption>**](SettingOption.md) | | [optional] [default to undefined]
|
|
17
|
-
**value** | **any** | | [optional] [default to undefined]
|
|
18
17
|
**defaultValue** | **any** | | [optional] [default to undefined]
|
|
18
|
+
**value** | **any** | | [optional] [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -32,8 +32,8 @@ const instance: SettingField = {
|
|
|
32
32
|
hidden,
|
|
33
33
|
disabled,
|
|
34
34
|
_options,
|
|
35
|
-
value,
|
|
36
35
|
defaultValue,
|
|
36
|
+
value,
|
|
37
37
|
};
|
|
38
38
|
```
|
|
39
39
|
|
package/docs/Team.md
CHANGED
|
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**filtersString** | **string** | | [optional] [default to undefined]
|
|
20
20
|
**filters** | [**{ [key: string]: Filter; }**](Filter.md) | | [optional] [default to undefined]
|
|
21
21
|
**memberCount** | **number** | | [optional] [default to undefined]
|
|
22
|
-
**complete** | **boolean** | | [optional] [default to undefined]
|
|
23
22
|
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
23
|
+
**complete** | **boolean** | | [optional] [default to undefined]
|
|
24
24
|
**uuid** | **string** | | [default to undefined]
|
|
25
25
|
|
|
26
26
|
## Example
|
|
@@ -43,8 +43,8 @@ const instance: Team = {
|
|
|
43
43
|
filtersString,
|
|
44
44
|
filters,
|
|
45
45
|
memberCount,
|
|
46
|
-
complete,
|
|
47
46
|
deleted,
|
|
47
|
+
complete,
|
|
48
48
|
uuid,
|
|
49
49
|
};
|
|
50
50
|
```
|