@caraer/client 2.0.511 → 2.0.513
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 +248 -4
- package/dist/api.d.ts +120 -4
- package/dist/api.js +233 -0
- package/dist/esm/api.d.ts +120 -4
- package/dist/esm/api.js +233 -0
- package/docs/CMSV2PagesApi.md +62 -0
- package/docs/ExistingWidgetSummary.md +4 -4
- package/docs/Record.md +2 -2
- package/docs/Team.md +2 -2
- package/docs/WebpagesApi.md +115 -0
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -5809,6 +5809,48 @@ export const CMSV2PagesApiAxiosParamCreator = function (configuration) {
|
|
|
5809
5809
|
options: localVarRequestOptions,
|
|
5810
5810
|
};
|
|
5811
5811
|
}),
|
|
5812
|
+
/**
|
|
5813
|
+
* Writes test values into the playground session without changing the live page.
|
|
5814
|
+
* @summary Preview field values on the forked module
|
|
5815
|
+
* @param {string} recordUuid
|
|
5816
|
+
* @param {string} sessionId
|
|
5817
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
5818
|
+
* @param {*} [options] Override http request option.
|
|
5819
|
+
* @throws {RequiredError}
|
|
5820
|
+
*/
|
|
5821
|
+
updateModuleForkFields: (recordUuid_1, sessionId_1, requestBody_1, ...args_1) => __awaiter(this, [recordUuid_1, sessionId_1, requestBody_1, ...args_1], void 0, function* (recordUuid, sessionId, requestBody, options = {}) {
|
|
5822
|
+
// verify required parameter 'recordUuid' is not null or undefined
|
|
5823
|
+
assertParamExists('updateModuleForkFields', 'recordUuid', recordUuid);
|
|
5824
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
5825
|
+
assertParamExists('updateModuleForkFields', 'sessionId', sessionId);
|
|
5826
|
+
// verify required parameter 'requestBody' is not null or undefined
|
|
5827
|
+
assertParamExists('updateModuleForkFields', 'requestBody', requestBody);
|
|
5828
|
+
const localVarPath = `/api/v2/webpages/v2/pages/{recordUuid}/ai/module-fork/sessions/{sessionId}/fields`
|
|
5829
|
+
.replace('{recordUuid}', encodeURIComponent(String(recordUuid)))
|
|
5830
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
5831
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5832
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5833
|
+
let baseOptions;
|
|
5834
|
+
if (configuration) {
|
|
5835
|
+
baseOptions = configuration.baseOptions;
|
|
5836
|
+
}
|
|
5837
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
5838
|
+
const localVarHeaderParameter = {};
|
|
5839
|
+
const localVarQueryParameter = {};
|
|
5840
|
+
// authentication bearerAuth required
|
|
5841
|
+
// http bearer authentication required
|
|
5842
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5843
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5844
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
5845
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5846
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5847
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5848
|
+
localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration);
|
|
5849
|
+
return {
|
|
5850
|
+
url: toPathString(localVarUrlObj),
|
|
5851
|
+
options: localVarRequestOptions,
|
|
5852
|
+
};
|
|
5853
|
+
}),
|
|
5812
5854
|
};
|
|
5813
5855
|
};
|
|
5814
5856
|
/**
|
|
@@ -6195,6 +6237,24 @@ export const CMSV2PagesApiFp = function (configuration) {
|
|
|
6195
6237
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6196
6238
|
});
|
|
6197
6239
|
},
|
|
6240
|
+
/**
|
|
6241
|
+
* Writes test values into the playground session without changing the live page.
|
|
6242
|
+
* @summary Preview field values on the forked module
|
|
6243
|
+
* @param {string} recordUuid
|
|
6244
|
+
* @param {string} sessionId
|
|
6245
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
6246
|
+
* @param {*} [options] Override http request option.
|
|
6247
|
+
* @throws {RequiredError}
|
|
6248
|
+
*/
|
|
6249
|
+
updateModuleForkFields(recordUuid, sessionId, requestBody, options) {
|
|
6250
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
6251
|
+
var _a, _b, _c;
|
|
6252
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateModuleForkFields(recordUuid, sessionId, requestBody, options);
|
|
6253
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
6254
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSV2PagesApi.updateModuleForkFields']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
6255
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6256
|
+
});
|
|
6257
|
+
},
|
|
6198
6258
|
};
|
|
6199
6259
|
};
|
|
6200
6260
|
/**
|
|
@@ -6449,6 +6509,18 @@ export const CMSV2PagesApiFactory = function (configuration, basePath, axios) {
|
|
|
6449
6509
|
unselectEnvironment(recordUuid, key, options) {
|
|
6450
6510
|
return localVarFp.unselectEnvironment(recordUuid, key, options).then((request) => request(axios, basePath));
|
|
6451
6511
|
},
|
|
6512
|
+
/**
|
|
6513
|
+
* Writes test values into the playground session without changing the live page.
|
|
6514
|
+
* @summary Preview field values on the forked module
|
|
6515
|
+
* @param {string} recordUuid
|
|
6516
|
+
* @param {string} sessionId
|
|
6517
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
6518
|
+
* @param {*} [options] Override http request option.
|
|
6519
|
+
* @throws {RequiredError}
|
|
6520
|
+
*/
|
|
6521
|
+
updateModuleForkFields(recordUuid, sessionId, requestBody, options) {
|
|
6522
|
+
return localVarFp.updateModuleForkFields(recordUuid, sessionId, requestBody, options).then((request) => request(axios, basePath));
|
|
6523
|
+
},
|
|
6452
6524
|
};
|
|
6453
6525
|
};
|
|
6454
6526
|
/**
|
|
@@ -6701,6 +6773,18 @@ export class CMSV2PagesApi extends BaseAPI {
|
|
|
6701
6773
|
unselectEnvironment(recordUuid, key, options) {
|
|
6702
6774
|
return CMSV2PagesApiFp(this.configuration).unselectEnvironment(recordUuid, key, options).then((request) => request(this.axios, this.basePath));
|
|
6703
6775
|
}
|
|
6776
|
+
/**
|
|
6777
|
+
* Writes test values into the playground session without changing the live page.
|
|
6778
|
+
* @summary Preview field values on the forked module
|
|
6779
|
+
* @param {string} recordUuid
|
|
6780
|
+
* @param {string} sessionId
|
|
6781
|
+
* @param {{ [key: string]: any | null; }} requestBody
|
|
6782
|
+
* @param {*} [options] Override http request option.
|
|
6783
|
+
* @throws {RequiredError}
|
|
6784
|
+
*/
|
|
6785
|
+
updateModuleForkFields(recordUuid, sessionId, requestBody, options) {
|
|
6786
|
+
return CMSV2PagesApiFp(this.configuration).updateModuleForkFields(recordUuid, sessionId, requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
6787
|
+
}
|
|
6704
6788
|
}
|
|
6705
6789
|
/**
|
|
6706
6790
|
* CMSV2PublicApi - axios parameter creator
|
|
@@ -22978,6 +23062,80 @@ export const WebpagesApiAxiosParamCreator = function (configuration) {
|
|
|
22978
23062
|
options: localVarRequestOptions,
|
|
22979
23063
|
};
|
|
22980
23064
|
}),
|
|
23065
|
+
/**
|
|
23066
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
23067
|
+
* @summary Publish a library file for a webpage
|
|
23068
|
+
* @param {string} uuid
|
|
23069
|
+
* @param {string} key
|
|
23070
|
+
* @param {*} [options] Override http request option.
|
|
23071
|
+
* @throws {RequiredError}
|
|
23072
|
+
*/
|
|
23073
|
+
publishFile: (uuid_1, key_1, ...args_1) => __awaiter(this, [uuid_1, key_1, ...args_1], void 0, function* (uuid, key, options = {}) {
|
|
23074
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
23075
|
+
assertParamExists('publishFile', 'uuid', uuid);
|
|
23076
|
+
// verify required parameter 'key' is not null or undefined
|
|
23077
|
+
assertParamExists('publishFile', 'key', key);
|
|
23078
|
+
const localVarPath = `/api/v2/webpages/{uuid}/publishFile`
|
|
23079
|
+
.replace('{uuid}', encodeURIComponent(String(uuid)));
|
|
23080
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23081
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23082
|
+
let baseOptions;
|
|
23083
|
+
if (configuration) {
|
|
23084
|
+
baseOptions = configuration.baseOptions;
|
|
23085
|
+
}
|
|
23086
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23087
|
+
const localVarHeaderParameter = {};
|
|
23088
|
+
const localVarQueryParameter = {};
|
|
23089
|
+
// authentication bearerAuth required
|
|
23090
|
+
// http bearer authentication required
|
|
23091
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
23092
|
+
if (key !== undefined) {
|
|
23093
|
+
localVarQueryParameter['key'] = key;
|
|
23094
|
+
}
|
|
23095
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
23096
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23097
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23098
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23099
|
+
return {
|
|
23100
|
+
url: toPathString(localVarUrlObj),
|
|
23101
|
+
options: localVarRequestOptions,
|
|
23102
|
+
};
|
|
23103
|
+
}),
|
|
23104
|
+
/**
|
|
23105
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
23106
|
+
* @summary Publish a library file for a webpage
|
|
23107
|
+
* @param {string} key
|
|
23108
|
+
* @param {*} [options] Override http request option.
|
|
23109
|
+
* @throws {RequiredError}
|
|
23110
|
+
*/
|
|
23111
|
+
publishFile1: (key_1, ...args_1) => __awaiter(this, [key_1, ...args_1], void 0, function* (key, options = {}) {
|
|
23112
|
+
// verify required parameter 'key' is not null or undefined
|
|
23113
|
+
assertParamExists('publishFile1', 'key', key);
|
|
23114
|
+
const localVarPath = `/api/v2/webpages/publishFile`;
|
|
23115
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23116
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23117
|
+
let baseOptions;
|
|
23118
|
+
if (configuration) {
|
|
23119
|
+
baseOptions = configuration.baseOptions;
|
|
23120
|
+
}
|
|
23121
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23122
|
+
const localVarHeaderParameter = {};
|
|
23123
|
+
const localVarQueryParameter = {};
|
|
23124
|
+
// authentication bearerAuth required
|
|
23125
|
+
// http bearer authentication required
|
|
23126
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
23127
|
+
if (key !== undefined) {
|
|
23128
|
+
localVarQueryParameter['key'] = key;
|
|
23129
|
+
}
|
|
23130
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
23131
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23132
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23133
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23134
|
+
return {
|
|
23135
|
+
url: toPathString(localVarUrlObj),
|
|
23136
|
+
options: localVarRequestOptions,
|
|
23137
|
+
};
|
|
23138
|
+
}),
|
|
22981
23139
|
/**
|
|
22982
23140
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
22983
23141
|
* @summary Publish a webpage
|
|
@@ -23846,6 +24004,39 @@ export const WebpagesApiFp = function (configuration) {
|
|
|
23846
24004
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23847
24005
|
});
|
|
23848
24006
|
},
|
|
24007
|
+
/**
|
|
24008
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
24009
|
+
* @summary Publish a library file for a webpage
|
|
24010
|
+
* @param {string} uuid
|
|
24011
|
+
* @param {string} key
|
|
24012
|
+
* @param {*} [options] Override http request option.
|
|
24013
|
+
* @throws {RequiredError}
|
|
24014
|
+
*/
|
|
24015
|
+
publishFile(uuid, key, options) {
|
|
24016
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24017
|
+
var _a, _b, _c;
|
|
24018
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.publishFile(uuid, key, options);
|
|
24019
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24020
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['WebpagesApi.publishFile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24021
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24022
|
+
});
|
|
24023
|
+
},
|
|
24024
|
+
/**
|
|
24025
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
24026
|
+
* @summary Publish a library file for a webpage
|
|
24027
|
+
* @param {string} key
|
|
24028
|
+
* @param {*} [options] Override http request option.
|
|
24029
|
+
* @throws {RequiredError}
|
|
24030
|
+
*/
|
|
24031
|
+
publishFile1(key, options) {
|
|
24032
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24033
|
+
var _a, _b, _c;
|
|
24034
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.publishFile1(key, options);
|
|
24035
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24036
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['WebpagesApi.publishFile1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24037
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24038
|
+
});
|
|
24039
|
+
},
|
|
23849
24040
|
/**
|
|
23850
24041
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
23851
24042
|
* @summary Publish a webpage
|
|
@@ -24351,6 +24542,27 @@ export const WebpagesApiFactory = function (configuration, basePath, axios) {
|
|
|
24351
24542
|
listProtectionGrants(uuid, environment, options) {
|
|
24352
24543
|
return localVarFp.listProtectionGrants(uuid, environment, options).then((request) => request(axios, basePath));
|
|
24353
24544
|
},
|
|
24545
|
+
/**
|
|
24546
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
24547
|
+
* @summary Publish a library file for a webpage
|
|
24548
|
+
* @param {string} uuid
|
|
24549
|
+
* @param {string} key
|
|
24550
|
+
* @param {*} [options] Override http request option.
|
|
24551
|
+
* @throws {RequiredError}
|
|
24552
|
+
*/
|
|
24553
|
+
publishFile(uuid, key, options) {
|
|
24554
|
+
return localVarFp.publishFile(uuid, key, options).then((request) => request(axios, basePath));
|
|
24555
|
+
},
|
|
24556
|
+
/**
|
|
24557
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
24558
|
+
* @summary Publish a library file for a webpage
|
|
24559
|
+
* @param {string} key
|
|
24560
|
+
* @param {*} [options] Override http request option.
|
|
24561
|
+
* @throws {RequiredError}
|
|
24562
|
+
*/
|
|
24563
|
+
publishFile1(key, options) {
|
|
24564
|
+
return localVarFp.publishFile1(key, options).then((request) => request(axios, basePath));
|
|
24565
|
+
},
|
|
24354
24566
|
/**
|
|
24355
24567
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
24356
24568
|
* @summary Publish a webpage
|
|
@@ -24800,6 +25012,27 @@ export class WebpagesApi extends BaseAPI {
|
|
|
24800
25012
|
listProtectionGrants(uuid, environment, options) {
|
|
24801
25013
|
return WebpagesApiFp(this.configuration).listProtectionGrants(uuid, environment, options).then((request) => request(this.axios, this.basePath));
|
|
24802
25014
|
}
|
|
25015
|
+
/**
|
|
25016
|
+
* Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
25017
|
+
* @summary Publish a library file for a webpage
|
|
25018
|
+
* @param {string} uuid
|
|
25019
|
+
* @param {string} key
|
|
25020
|
+
* @param {*} [options] Override http request option.
|
|
25021
|
+
* @throws {RequiredError}
|
|
25022
|
+
*/
|
|
25023
|
+
publishFile(uuid, key, options) {
|
|
25024
|
+
return WebpagesApiFp(this.configuration).publishFile(uuid, key, options).then((request) => request(this.axios, this.basePath));
|
|
25025
|
+
}
|
|
25026
|
+
/**
|
|
25027
|
+
* Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
25028
|
+
* @summary Publish a library file for a webpage
|
|
25029
|
+
* @param {string} key
|
|
25030
|
+
* @param {*} [options] Override http request option.
|
|
25031
|
+
* @throws {RequiredError}
|
|
25032
|
+
*/
|
|
25033
|
+
publishFile1(key, options) {
|
|
25034
|
+
return WebpagesApiFp(this.configuration).publishFile1(key, options).then((request) => request(this.axios, this.basePath));
|
|
25035
|
+
}
|
|
24803
25036
|
/**
|
|
24804
25037
|
* Publishes a webpage by its UUID. Optionally, a publish_at timestamp (in seconds) may be provided. Returns an UpdateResponse containing the published webpage details.
|
|
24805
25038
|
* @summary Publish a webpage
|
package/docs/CMSV2PagesApi.md
CHANGED
|
@@ -26,6 +26,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
26
26
|
|[**startModuleFork**](#startmodulefork) | **POST** /api/v2/webpages/v2/pages/{recordUuid}/ai/module-fork/sessions | Start a Modify-this-module playground session|
|
|
27
27
|
|[**unpublish**](#unpublish) | **PUT** /api/v2/webpages/v2/pages/{recordUuid}/unpublish | Take one locale offline|
|
|
28
28
|
|[**unselectEnvironment**](#unselectenvironment) | **DELETE** /api/v2/webpages/v2/pages/{recordUuid}/environments/{key} | Remove an environment from this page only|
|
|
29
|
+
|[**updateModuleForkFields**](#updatemoduleforkfields) | **PUT** /api/v2/webpages/v2/pages/{recordUuid}/ai/module-fork/sessions/{sessionId}/fields | Preview field values on the forked module|
|
|
29
30
|
|
|
30
31
|
# **aiRewrite**
|
|
31
32
|
> ShowResponseMapStringObject aiRewrite(requestBody)
|
|
@@ -1296,3 +1297,64 @@ const { status, data } = await apiInstance.unselectEnvironment(
|
|
|
1296
1297
|
|
|
1297
1298
|
[[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)
|
|
1298
1299
|
|
|
1300
|
+
# **updateModuleForkFields**
|
|
1301
|
+
> ShowResponseMapStringObject updateModuleForkFields(requestBody)
|
|
1302
|
+
|
|
1303
|
+
Writes test values into the playground session without changing the live page.
|
|
1304
|
+
|
|
1305
|
+
### Example
|
|
1306
|
+
|
|
1307
|
+
```typescript
|
|
1308
|
+
import {
|
|
1309
|
+
CMSV2PagesApi,
|
|
1310
|
+
Configuration
|
|
1311
|
+
} from '@caraer/client';
|
|
1312
|
+
|
|
1313
|
+
const configuration = new Configuration();
|
|
1314
|
+
const apiInstance = new CMSV2PagesApi(configuration);
|
|
1315
|
+
|
|
1316
|
+
let recordUuid: string; // (default to undefined)
|
|
1317
|
+
let sessionId: string; // (default to undefined)
|
|
1318
|
+
let requestBody: { [key: string]: any | null; }; //
|
|
1319
|
+
|
|
1320
|
+
const { status, data } = await apiInstance.updateModuleForkFields(
|
|
1321
|
+
recordUuid,
|
|
1322
|
+
sessionId,
|
|
1323
|
+
requestBody
|
|
1324
|
+
);
|
|
1325
|
+
```
|
|
1326
|
+
|
|
1327
|
+
### Parameters
|
|
1328
|
+
|
|
1329
|
+
|Name | Type | Description | Notes|
|
|
1330
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1331
|
+
| **requestBody** | **{ [key: string]: any | null; }**| | |
|
|
1332
|
+
| **recordUuid** | [**string**] | | defaults to undefined|
|
|
1333
|
+
| **sessionId** | [**string**] | | defaults to undefined|
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
### Return type
|
|
1337
|
+
|
|
1338
|
+
**ShowResponseMapStringObject**
|
|
1339
|
+
|
|
1340
|
+
### Authorization
|
|
1341
|
+
|
|
1342
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1343
|
+
|
|
1344
|
+
### HTTP request headers
|
|
1345
|
+
|
|
1346
|
+
- **Content-Type**: application/json
|
|
1347
|
+
- **Accept**: application/json
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
### HTTP response details
|
|
1351
|
+
| Status code | Description | Response headers |
|
|
1352
|
+
|-------------|-------------|------------------|
|
|
1353
|
+
|**200** | OK | - |
|
|
1354
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1355
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1356
|
+
|**404** | The requested resource was not found. | - |
|
|
1357
|
+
|**500** | An internal server error occurred. | - |
|
|
1358
|
+
|
|
1359
|
+
[[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)
|
|
1360
|
+
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**xproperty** | **string** | | [optional] [default to undefined]
|
|
9
|
-
**yproperty** | **string** | | [optional] [default to undefined]
|
|
10
8
|
**ymetric** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**yproperty** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**xproperty** | **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
|
-
xproperty,
|
|
24
|
-
yproperty,
|
|
25
23
|
ymetric,
|
|
24
|
+
yproperty,
|
|
25
|
+
xproperty,
|
|
26
26
|
title,
|
|
27
27
|
chartType,
|
|
28
28
|
xProperty,
|
package/docs/Record.md
CHANGED
|
@@ -14,8 +14,8 @@ 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
|
-
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
18
17
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
18
|
+
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**uuid** | **string** | | [default to undefined]
|
|
20
20
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
|
|
21
21
|
**objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
@@ -36,8 +36,8 @@ const instance: ModelRecord = {
|
|
|
36
36
|
updatedByUuid,
|
|
37
37
|
deletedByUuid,
|
|
38
38
|
index,
|
|
39
|
-
deleted,
|
|
40
39
|
complete,
|
|
40
|
+
deleted,
|
|
41
41
|
uuid,
|
|
42
42
|
properties,
|
|
43
43
|
objects,
|
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
|
-
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
23
22
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
23
|
+
**deleted** | **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
|
-
deleted,
|
|
47
46
|
complete,
|
|
47
|
+
deleted,
|
|
48
48
|
uuid,
|
|
49
49
|
};
|
|
50
50
|
```
|
package/docs/WebpagesApi.md
CHANGED
|
@@ -31,6 +31,8 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
31
31
|
|[**getWebpageEditingStatus**](#getwebpageeditingstatus) | **GET** /api/v2/webpages/{uuid}/editing-status | Check if a webpage is being edited|
|
|
32
32
|
|[**getWebpagePickerPages**](#getwebpagepickerpages) | **GET** /api/v2/webpages/picker/pages | List webpages for picker dropdowns|
|
|
33
33
|
|[**listProtectionGrants**](#listprotectiongrants) | **GET** /api/v2/webpages/{uuid}/protection/grants | List signed URL grants for a webpage|
|
|
34
|
+
|[**publishFile**](#publishfile) | **POST** /api/v2/webpages/{uuid}/publishFile | Publish a library file for a webpage|
|
|
35
|
+
|[**publishFile1**](#publishfile1) | **POST** /api/v2/webpages/publishFile | Publish a library file for a webpage|
|
|
34
36
|
|[**publishWebpage**](#publishwebpage) | **PUT** /api/v2/webpages/{uuid}/publish | Publish a webpage|
|
|
35
37
|
|[**releaseTemplateWebpageEditingSession**](#releasetemplatewebpageeditingsession) | **DELETE** /api/v2/webpages/template/{objectName}/{environment}/editing-session | Release a template webpage editing session|
|
|
36
38
|
|[**releaseWebpageEditingSession**](#releasewebpageeditingsession) | **DELETE** /api/v2/webpages/{uuid}/editing-session | Release a webpage editing session|
|
|
@@ -1729,6 +1731,119 @@ const { status, data } = await apiInstance.listProtectionGrants(
|
|
|
1729
1731
|
- **Accept**: application/json
|
|
1730
1732
|
|
|
1731
1733
|
|
|
1734
|
+
### HTTP response details
|
|
1735
|
+
| Status code | Description | Response headers |
|
|
1736
|
+
|-------------|-------------|------------------|
|
|
1737
|
+
|**200** | OK | - |
|
|
1738
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1739
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1740
|
+
|**404** | The requested resource was not found. | - |
|
|
1741
|
+
|**500** | An internal server error occurred. | - |
|
|
1742
|
+
|
|
1743
|
+
[[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)
|
|
1744
|
+
|
|
1745
|
+
# **publishFile**
|
|
1746
|
+
> SuccessResponseString publishFile()
|
|
1747
|
+
|
|
1748
|
+
Copies an existing company file into this webpage\'s public attachments folder and returns its public URL.
|
|
1749
|
+
|
|
1750
|
+
### Example
|
|
1751
|
+
|
|
1752
|
+
```typescript
|
|
1753
|
+
import {
|
|
1754
|
+
WebpagesApi,
|
|
1755
|
+
Configuration
|
|
1756
|
+
} from '@caraer/client';
|
|
1757
|
+
|
|
1758
|
+
const configuration = new Configuration();
|
|
1759
|
+
const apiInstance = new WebpagesApi(configuration);
|
|
1760
|
+
|
|
1761
|
+
let uuid: string; // (default to undefined)
|
|
1762
|
+
let key: string; // (default to undefined)
|
|
1763
|
+
|
|
1764
|
+
const { status, data } = await apiInstance.publishFile(
|
|
1765
|
+
uuid,
|
|
1766
|
+
key
|
|
1767
|
+
);
|
|
1768
|
+
```
|
|
1769
|
+
|
|
1770
|
+
### Parameters
|
|
1771
|
+
|
|
1772
|
+
|Name | Type | Description | Notes|
|
|
1773
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1774
|
+
| **uuid** | [**string**] | | defaults to undefined|
|
|
1775
|
+
| **key** | [**string**] | | defaults to undefined|
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
### Return type
|
|
1779
|
+
|
|
1780
|
+
**SuccessResponseString**
|
|
1781
|
+
|
|
1782
|
+
### Authorization
|
|
1783
|
+
|
|
1784
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1785
|
+
|
|
1786
|
+
### HTTP request headers
|
|
1787
|
+
|
|
1788
|
+
- **Content-Type**: Not defined
|
|
1789
|
+
- **Accept**: application/json
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
### HTTP response details
|
|
1793
|
+
| Status code | Description | Response headers |
|
|
1794
|
+
|-------------|-------------|------------------|
|
|
1795
|
+
|**200** | OK | - |
|
|
1796
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
1797
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
1798
|
+
|**404** | The requested resource was not found. | - |
|
|
1799
|
+
|**500** | An internal server error occurred. | - |
|
|
1800
|
+
|
|
1801
|
+
[[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)
|
|
1802
|
+
|
|
1803
|
+
# **publishFile1**
|
|
1804
|
+
> SuccessResponseString publishFile1()
|
|
1805
|
+
|
|
1806
|
+
Copies an existing company file into the public webpage attachments folder and returns its public URL.
|
|
1807
|
+
|
|
1808
|
+
### Example
|
|
1809
|
+
|
|
1810
|
+
```typescript
|
|
1811
|
+
import {
|
|
1812
|
+
WebpagesApi,
|
|
1813
|
+
Configuration
|
|
1814
|
+
} from '@caraer/client';
|
|
1815
|
+
|
|
1816
|
+
const configuration = new Configuration();
|
|
1817
|
+
const apiInstance = new WebpagesApi(configuration);
|
|
1818
|
+
|
|
1819
|
+
let key: string; // (default to undefined)
|
|
1820
|
+
|
|
1821
|
+
const { status, data } = await apiInstance.publishFile1(
|
|
1822
|
+
key
|
|
1823
|
+
);
|
|
1824
|
+
```
|
|
1825
|
+
|
|
1826
|
+
### Parameters
|
|
1827
|
+
|
|
1828
|
+
|Name | Type | Description | Notes|
|
|
1829
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1830
|
+
| **key** | [**string**] | | defaults to undefined|
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
### Return type
|
|
1834
|
+
|
|
1835
|
+
**SuccessResponseString**
|
|
1836
|
+
|
|
1837
|
+
### Authorization
|
|
1838
|
+
|
|
1839
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1840
|
+
|
|
1841
|
+
### HTTP request headers
|
|
1842
|
+
|
|
1843
|
+
- **Content-Type**: Not defined
|
|
1844
|
+
- **Accept**: application/json
|
|
1845
|
+
|
|
1846
|
+
|
|
1732
1847
|
### HTTP response details
|
|
1733
1848
|
| Status code | Description | Response headers |
|
|
1734
1849
|
|-------------|-------------|------------------|
|