@caraer/client 2.0.576 → 2.0.583
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/.openapi-generator/FILES +1 -0
- package/.openapi-generator-ignore +2 -0
- package/README.md +33 -1
- package/api.ts +279 -33
- package/dist/api.d.ts +148 -24
- package/dist/api.js +264 -33
- package/dist/esm/api.d.ts +148 -24
- package/dist/esm/api.js +257 -30
- package/docs/AppSettingFieldSchema.md +2 -0
- package/docs/ApplicationsApi.md +1 -1
- package/docs/CMSV2PublicApi.md +4 -1
- package/docs/CMSWebsiteUpdatesApi.md +159 -0
- package/docs/ExistingWidgetSummary.md +2 -2
- package/docs/PropertyApi.md +1 -1
- package/docs/RecordDTO.md +1 -1
- package/docs/RecordsApi.md +4 -4
- package/docs/WebpageDTO.md +4 -0
- package/docs/WebsiteSettingsDTO.md +2 -0
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -2164,7 +2164,7 @@ export const ApplicationsApiAxiosParamCreator = function (configuration) {
|
|
|
2164
2164
|
};
|
|
2165
2165
|
}),
|
|
2166
2166
|
/**
|
|
2167
|
-
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
2167
|
+
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
2168
2168
|
* @summary Retrieve a paginated list of applications
|
|
2169
2169
|
* @param {PaginationRequest} paginationRequest
|
|
2170
2170
|
* @param {string} [type]
|
|
@@ -3127,7 +3127,7 @@ export const ApplicationsApiFp = function (configuration) {
|
|
|
3127
3127
|
});
|
|
3128
3128
|
},
|
|
3129
3129
|
/**
|
|
3130
|
-
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
3130
|
+
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
3131
3131
|
* @summary Retrieve a paginated list of applications
|
|
3132
3132
|
* @param {PaginationRequest} paginationRequest
|
|
3133
3133
|
* @param {string} [type]
|
|
@@ -3600,7 +3600,7 @@ export const ApplicationsApiFactory = function (configuration, basePath, axios)
|
|
|
3600
3600
|
return localVarFp.getAppWebhooks(appUuid, paginationRequest, options).then((request) => request(axios, basePath));
|
|
3601
3601
|
},
|
|
3602
3602
|
/**
|
|
3603
|
-
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
3603
|
+
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
3604
3604
|
* @summary Retrieve a paginated list of applications
|
|
3605
3605
|
* @param {PaginationRequest} paginationRequest
|
|
3606
3606
|
* @param {string} [type]
|
|
@@ -3939,7 +3939,7 @@ export class ApplicationsApi extends BaseAPI {
|
|
|
3939
3939
|
return ApplicationsApiFp(this.configuration).getAppWebhooks(appUuid, paginationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3940
3940
|
}
|
|
3941
3941
|
/**
|
|
3942
|
-
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
3942
|
+
* Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
3943
3943
|
* @summary Retrieve a paginated list of applications
|
|
3944
3944
|
* @param {PaginationRequest} paginationRequest
|
|
3945
3945
|
* @param {string} [type]
|
|
@@ -7142,10 +7142,11 @@ export const CMSV2PublicApiAxiosParamCreator = function (configuration) {
|
|
|
7142
7142
|
*
|
|
7143
7143
|
* @summary Installed apps and modules for a company\'s website build
|
|
7144
7144
|
* @param {string} xCaraerSubdomain
|
|
7145
|
+
* @param {string} [channel]
|
|
7145
7146
|
* @param {*} [options] Override http request option.
|
|
7146
7147
|
* @throws {RequiredError}
|
|
7147
7148
|
*/
|
|
7148
|
-
buildManifest: (xCaraerSubdomain_1, ...args_1) => __awaiter(this, [xCaraerSubdomain_1, ...args_1], void 0, function* (xCaraerSubdomain, options = {}) {
|
|
7149
|
+
buildManifest: (xCaraerSubdomain_1, channel_1, ...args_1) => __awaiter(this, [xCaraerSubdomain_1, channel_1, ...args_1], void 0, function* (xCaraerSubdomain, channel, options = {}) {
|
|
7149
7150
|
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
7150
7151
|
assertParamExists('buildManifest', 'xCaraerSubdomain', xCaraerSubdomain);
|
|
7151
7152
|
const localVarPath = `/api/v2/webpages/v2/build/manifest`;
|
|
@@ -7161,6 +7162,9 @@ export const CMSV2PublicApiAxiosParamCreator = function (configuration) {
|
|
|
7161
7162
|
// authentication bearerAuth required
|
|
7162
7163
|
// http bearer authentication required
|
|
7163
7164
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7165
|
+
if (channel !== undefined) {
|
|
7166
|
+
localVarQueryParameter['channel'] = channel;
|
|
7167
|
+
}
|
|
7164
7168
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7165
7169
|
if (xCaraerSubdomain != null) {
|
|
7166
7170
|
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
@@ -7638,13 +7642,14 @@ export const CMSV2PublicApiFp = function (configuration) {
|
|
|
7638
7642
|
*
|
|
7639
7643
|
* @summary Installed apps and modules for a company\'s website build
|
|
7640
7644
|
* @param {string} xCaraerSubdomain
|
|
7645
|
+
* @param {string} [channel]
|
|
7641
7646
|
* @param {*} [options] Override http request option.
|
|
7642
7647
|
* @throws {RequiredError}
|
|
7643
7648
|
*/
|
|
7644
|
-
buildManifest(xCaraerSubdomain, options) {
|
|
7649
|
+
buildManifest(xCaraerSubdomain, channel, options) {
|
|
7645
7650
|
return __awaiter(this, void 0, void 0, function* () {
|
|
7646
7651
|
var _a, _b, _c;
|
|
7647
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.buildManifest(xCaraerSubdomain, options);
|
|
7652
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.buildManifest(xCaraerSubdomain, channel, options);
|
|
7648
7653
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7649
7654
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSV2PublicApi.buildManifest']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7650
7655
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -7852,11 +7857,12 @@ export const CMSV2PublicApiFactory = function (configuration, basePath, axios) {
|
|
|
7852
7857
|
*
|
|
7853
7858
|
* @summary Installed apps and modules for a company\'s website build
|
|
7854
7859
|
* @param {string} xCaraerSubdomain
|
|
7860
|
+
* @param {string} [channel]
|
|
7855
7861
|
* @param {*} [options] Override http request option.
|
|
7856
7862
|
* @throws {RequiredError}
|
|
7857
7863
|
*/
|
|
7858
|
-
buildManifest(xCaraerSubdomain, options) {
|
|
7859
|
-
return localVarFp.buildManifest(xCaraerSubdomain, options).then((request) => request(axios, basePath));
|
|
7864
|
+
buildManifest(xCaraerSubdomain, channel, options) {
|
|
7865
|
+
return localVarFp.buildManifest(xCaraerSubdomain, channel, options).then((request) => request(axios, basePath));
|
|
7860
7866
|
},
|
|
7861
7867
|
/**
|
|
7862
7868
|
*
|
|
@@ -8010,11 +8016,12 @@ export class CMSV2PublicApi extends BaseAPI {
|
|
|
8010
8016
|
*
|
|
8011
8017
|
* @summary Installed apps and modules for a company\'s website build
|
|
8012
8018
|
* @param {string} xCaraerSubdomain
|
|
8019
|
+
* @param {string} [channel]
|
|
8013
8020
|
* @param {*} [options] Override http request option.
|
|
8014
8021
|
* @throws {RequiredError}
|
|
8015
8022
|
*/
|
|
8016
|
-
buildManifest(xCaraerSubdomain, options) {
|
|
8017
|
-
return CMSV2PublicApiFp(this.configuration).buildManifest(xCaraerSubdomain, options).then((request) => request(this.axios, this.basePath));
|
|
8023
|
+
buildManifest(xCaraerSubdomain, channel, options) {
|
|
8024
|
+
return CMSV2PublicApiFp(this.configuration).buildManifest(xCaraerSubdomain, channel, options).then((request) => request(this.axios, this.basePath));
|
|
8018
8025
|
}
|
|
8019
8026
|
/**
|
|
8020
8027
|
*
|
|
@@ -8440,6 +8447,226 @@ export class CMSV2TransferApi extends BaseAPI {
|
|
|
8440
8447
|
return CMSV2TransferApiFp(this.configuration).status(companyUuid, options).then((request) => request(this.axios, this.basePath));
|
|
8441
8448
|
}
|
|
8442
8449
|
}
|
|
8450
|
+
/**
|
|
8451
|
+
* CMSWebsiteUpdatesApi - axios parameter creator
|
|
8452
|
+
*/
|
|
8453
|
+
export const CMSWebsiteUpdatesApiAxiosParamCreator = function (configuration) {
|
|
8454
|
+
return {
|
|
8455
|
+
/**
|
|
8456
|
+
*
|
|
8457
|
+
* @summary Pending module updates for this website
|
|
8458
|
+
* @param {*} [options] Override http request option.
|
|
8459
|
+
* @throws {RequiredError}
|
|
8460
|
+
*/
|
|
8461
|
+
pending: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
8462
|
+
const localVarPath = `/api/v2/webpages/v2/updates`;
|
|
8463
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8464
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8465
|
+
let baseOptions;
|
|
8466
|
+
if (configuration) {
|
|
8467
|
+
baseOptions = configuration.baseOptions;
|
|
8468
|
+
}
|
|
8469
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
8470
|
+
const localVarHeaderParameter = {};
|
|
8471
|
+
const localVarQueryParameter = {};
|
|
8472
|
+
// authentication bearerAuth required
|
|
8473
|
+
// http bearer authentication required
|
|
8474
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8475
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
8476
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8477
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8478
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8479
|
+
return {
|
|
8480
|
+
url: toPathString(localVarUrlObj),
|
|
8481
|
+
options: localVarRequestOptions,
|
|
8482
|
+
};
|
|
8483
|
+
}),
|
|
8484
|
+
/**
|
|
8485
|
+
*
|
|
8486
|
+
* @summary Build a preview site with every pending module update
|
|
8487
|
+
* @param {*} [options] Override http request option.
|
|
8488
|
+
* @throws {RequiredError}
|
|
8489
|
+
*/
|
|
8490
|
+
preview: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
8491
|
+
const localVarPath = `/api/v2/webpages/v2/updates/preview`;
|
|
8492
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8493
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8494
|
+
let baseOptions;
|
|
8495
|
+
if (configuration) {
|
|
8496
|
+
baseOptions = configuration.baseOptions;
|
|
8497
|
+
}
|
|
8498
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
8499
|
+
const localVarHeaderParameter = {};
|
|
8500
|
+
const localVarQueryParameter = {};
|
|
8501
|
+
// authentication bearerAuth required
|
|
8502
|
+
// http bearer authentication required
|
|
8503
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8504
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
8505
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8506
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8507
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8508
|
+
return {
|
|
8509
|
+
url: toPathString(localVarUrlObj),
|
|
8510
|
+
options: localVarRequestOptions,
|
|
8511
|
+
};
|
|
8512
|
+
}),
|
|
8513
|
+
/**
|
|
8514
|
+
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
8515
|
+
* @summary Promote a previewed module set to production
|
|
8516
|
+
* @param {{ [key: string]: any | null; }} [requestBody]
|
|
8517
|
+
* @param {*} [options] Override http request option.
|
|
8518
|
+
* @throws {RequiredError}
|
|
8519
|
+
*/
|
|
8520
|
+
promote: (requestBody_1, ...args_1) => __awaiter(this, [requestBody_1, ...args_1], void 0, function* (requestBody, options = {}) {
|
|
8521
|
+
const localVarPath = `/api/v2/webpages/v2/updates/promote`;
|
|
8522
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8523
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
8524
|
+
let baseOptions;
|
|
8525
|
+
if (configuration) {
|
|
8526
|
+
baseOptions = configuration.baseOptions;
|
|
8527
|
+
}
|
|
8528
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
8529
|
+
const localVarHeaderParameter = {};
|
|
8530
|
+
const localVarQueryParameter = {};
|
|
8531
|
+
// authentication bearerAuth required
|
|
8532
|
+
// http bearer authentication required
|
|
8533
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
8534
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8535
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
8536
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8537
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8538
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8539
|
+
localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration);
|
|
8540
|
+
return {
|
|
8541
|
+
url: toPathString(localVarUrlObj),
|
|
8542
|
+
options: localVarRequestOptions,
|
|
8543
|
+
};
|
|
8544
|
+
}),
|
|
8545
|
+
};
|
|
8546
|
+
};
|
|
8547
|
+
/**
|
|
8548
|
+
* CMSWebsiteUpdatesApi - functional programming interface
|
|
8549
|
+
*/
|
|
8550
|
+
export const CMSWebsiteUpdatesApiFp = function (configuration) {
|
|
8551
|
+
const localVarAxiosParamCreator = CMSWebsiteUpdatesApiAxiosParamCreator(configuration);
|
|
8552
|
+
return {
|
|
8553
|
+
/**
|
|
8554
|
+
*
|
|
8555
|
+
* @summary Pending module updates for this website
|
|
8556
|
+
* @param {*} [options] Override http request option.
|
|
8557
|
+
* @throws {RequiredError}
|
|
8558
|
+
*/
|
|
8559
|
+
pending(options) {
|
|
8560
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8561
|
+
var _a, _b, _c;
|
|
8562
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.pending(options);
|
|
8563
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8564
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSWebsiteUpdatesApi.pending']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8565
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8566
|
+
});
|
|
8567
|
+
},
|
|
8568
|
+
/**
|
|
8569
|
+
*
|
|
8570
|
+
* @summary Build a preview site with every pending module update
|
|
8571
|
+
* @param {*} [options] Override http request option.
|
|
8572
|
+
* @throws {RequiredError}
|
|
8573
|
+
*/
|
|
8574
|
+
preview(options) {
|
|
8575
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8576
|
+
var _a, _b, _c;
|
|
8577
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.preview(options);
|
|
8578
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8579
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSWebsiteUpdatesApi.preview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8580
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8581
|
+
});
|
|
8582
|
+
},
|
|
8583
|
+
/**
|
|
8584
|
+
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
8585
|
+
* @summary Promote a previewed module set to production
|
|
8586
|
+
* @param {{ [key: string]: any | null; }} [requestBody]
|
|
8587
|
+
* @param {*} [options] Override http request option.
|
|
8588
|
+
* @throws {RequiredError}
|
|
8589
|
+
*/
|
|
8590
|
+
promote(requestBody, options) {
|
|
8591
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8592
|
+
var _a, _b, _c;
|
|
8593
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.promote(requestBody, options);
|
|
8594
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8595
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSWebsiteUpdatesApi.promote']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8596
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8597
|
+
});
|
|
8598
|
+
},
|
|
8599
|
+
};
|
|
8600
|
+
};
|
|
8601
|
+
/**
|
|
8602
|
+
* CMSWebsiteUpdatesApi - factory interface
|
|
8603
|
+
*/
|
|
8604
|
+
export const CMSWebsiteUpdatesApiFactory = function (configuration, basePath, axios) {
|
|
8605
|
+
const localVarFp = CMSWebsiteUpdatesApiFp(configuration);
|
|
8606
|
+
return {
|
|
8607
|
+
/**
|
|
8608
|
+
*
|
|
8609
|
+
* @summary Pending module updates for this website
|
|
8610
|
+
* @param {*} [options] Override http request option.
|
|
8611
|
+
* @throws {RequiredError}
|
|
8612
|
+
*/
|
|
8613
|
+
pending(options) {
|
|
8614
|
+
return localVarFp.pending(options).then((request) => request(axios, basePath));
|
|
8615
|
+
},
|
|
8616
|
+
/**
|
|
8617
|
+
*
|
|
8618
|
+
* @summary Build a preview site with every pending module update
|
|
8619
|
+
* @param {*} [options] Override http request option.
|
|
8620
|
+
* @throws {RequiredError}
|
|
8621
|
+
*/
|
|
8622
|
+
preview(options) {
|
|
8623
|
+
return localVarFp.preview(options).then((request) => request(axios, basePath));
|
|
8624
|
+
},
|
|
8625
|
+
/**
|
|
8626
|
+
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
8627
|
+
* @summary Promote a previewed module set to production
|
|
8628
|
+
* @param {{ [key: string]: any | null; }} [requestBody]
|
|
8629
|
+
* @param {*} [options] Override http request option.
|
|
8630
|
+
* @throws {RequiredError}
|
|
8631
|
+
*/
|
|
8632
|
+
promote(requestBody, options) {
|
|
8633
|
+
return localVarFp.promote(requestBody, options).then((request) => request(axios, basePath));
|
|
8634
|
+
},
|
|
8635
|
+
};
|
|
8636
|
+
};
|
|
8637
|
+
/**
|
|
8638
|
+
* CMSWebsiteUpdatesApi - object-oriented interface
|
|
8639
|
+
*/
|
|
8640
|
+
export class CMSWebsiteUpdatesApi extends BaseAPI {
|
|
8641
|
+
/**
|
|
8642
|
+
*
|
|
8643
|
+
* @summary Pending module updates for this website
|
|
8644
|
+
* @param {*} [options] Override http request option.
|
|
8645
|
+
* @throws {RequiredError}
|
|
8646
|
+
*/
|
|
8647
|
+
pending(options) {
|
|
8648
|
+
return CMSWebsiteUpdatesApiFp(this.configuration).pending(options).then((request) => request(this.axios, this.basePath));
|
|
8649
|
+
}
|
|
8650
|
+
/**
|
|
8651
|
+
*
|
|
8652
|
+
* @summary Build a preview site with every pending module update
|
|
8653
|
+
* @param {*} [options] Override http request option.
|
|
8654
|
+
* @throws {RequiredError}
|
|
8655
|
+
*/
|
|
8656
|
+
preview(options) {
|
|
8657
|
+
return CMSWebsiteUpdatesApiFp(this.configuration).preview(options).then((request) => request(this.axios, this.basePath));
|
|
8658
|
+
}
|
|
8659
|
+
/**
|
|
8660
|
+
* Rejected with 409 when the preview revision is no longer the current pending set.
|
|
8661
|
+
* @summary Promote a previewed module set to production
|
|
8662
|
+
* @param {{ [key: string]: any | null; }} [requestBody]
|
|
8663
|
+
* @param {*} [options] Override http request option.
|
|
8664
|
+
* @throws {RequiredError}
|
|
8665
|
+
*/
|
|
8666
|
+
promote(requestBody, options) {
|
|
8667
|
+
return CMSWebsiteUpdatesApiFp(this.configuration).promote(requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
8668
|
+
}
|
|
8669
|
+
}
|
|
8443
8670
|
/**
|
|
8444
8671
|
* CalendarsApi - axios parameter creator
|
|
8445
8672
|
*/
|
|
@@ -15230,7 +15457,7 @@ export const PropertyApiAxiosParamCreator = function (configuration) {
|
|
|
15230
15457
|
};
|
|
15231
15458
|
}),
|
|
15232
15459
|
/**
|
|
15233
|
-
* Deletes the soft-deleted HAS_PROPERTY link to this object.
|
|
15460
|
+
* Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
15234
15461
|
* @summary Permanently remove archived property
|
|
15235
15462
|
* @param {string} objectUuid
|
|
15236
15463
|
* @param {string} propertyUuid
|
|
@@ -15600,7 +15827,7 @@ export const PropertyApiFp = function (configuration) {
|
|
|
15600
15827
|
});
|
|
15601
15828
|
},
|
|
15602
15829
|
/**
|
|
15603
|
-
* Deletes the soft-deleted HAS_PROPERTY link to this object.
|
|
15830
|
+
* Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
15604
15831
|
* @summary Permanently remove archived property
|
|
15605
15832
|
* @param {string} objectUuid
|
|
15606
15833
|
* @param {string} propertyUuid
|
|
@@ -15797,7 +16024,7 @@ export const PropertyApiFactory = function (configuration, basePath, axios) {
|
|
|
15797
16024
|
return localVarFp.getPropertyCalculationTypes(objectUuid, propertyUuid, options).then((request) => request(axios, basePath));
|
|
15798
16025
|
},
|
|
15799
16026
|
/**
|
|
15800
|
-
* Deletes the soft-deleted HAS_PROPERTY link to this object.
|
|
16027
|
+
* Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
15801
16028
|
* @summary Permanently remove archived property
|
|
15802
16029
|
* @param {string} objectUuid
|
|
15803
16030
|
* @param {string} propertyUuid
|
|
@@ -15956,7 +16183,7 @@ export class PropertyApi extends BaseAPI {
|
|
|
15956
16183
|
return PropertyApiFp(this.configuration).getPropertyCalculationTypes(objectUuid, propertyUuid, options).then((request) => request(this.axios, this.basePath));
|
|
15957
16184
|
}
|
|
15958
16185
|
/**
|
|
15959
|
-
* Deletes the soft-deleted HAS_PROPERTY link to this object.
|
|
16186
|
+
* Deletes only the soft-deleted HAS_PROPERTY link to this object. Other object links and their stored values are preserved. If no object links remain, the property node and this object\'s stored field values are permanently deleted.
|
|
15960
16187
|
* @summary Permanently remove archived property
|
|
15961
16188
|
* @param {string} objectUuid
|
|
15962
16189
|
* @param {string} propertyUuid
|
|
@@ -16640,15 +16867,15 @@ export const RecordsApiAxiosParamCreator = function (configuration) {
|
|
|
16640
16867
|
* @param {string} uuid
|
|
16641
16868
|
* @param {string} name
|
|
16642
16869
|
* @param {string} [object] Optional object name used to resolve the record before building the preview.
|
|
16643
|
-
* @param {
|
|
16870
|
+
* @param {Preview1ParseEnum} [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).
|
|
16644
16871
|
* @param {*} [options] Override http request option.
|
|
16645
16872
|
* @throws {RequiredError}
|
|
16646
16873
|
*/
|
|
16647
|
-
|
|
16874
|
+
preview1: (uuid_1, name_1, object_1, parse_1, ...args_1) => __awaiter(this, [uuid_1, name_1, object_1, parse_1, ...args_1], void 0, function* (uuid, name, object, parse, options = {}) {
|
|
16648
16875
|
// verify required parameter 'uuid' is not null or undefined
|
|
16649
|
-
assertParamExists('
|
|
16876
|
+
assertParamExists('preview1', 'uuid', uuid);
|
|
16650
16877
|
// verify required parameter 'name' is not null or undefined
|
|
16651
|
-
assertParamExists('
|
|
16878
|
+
assertParamExists('preview1', 'name', name);
|
|
16652
16879
|
const localVarPath = `/api/v2/records/{uuid}/previews/{name}`
|
|
16653
16880
|
.replace('{uuid}', encodeURIComponent(String(uuid)))
|
|
16654
16881
|
.replace('{name}', encodeURIComponent(String(name)));
|
|
@@ -17387,16 +17614,16 @@ export const RecordsApiFp = function (configuration) {
|
|
|
17387
17614
|
* @param {string} uuid
|
|
17388
17615
|
* @param {string} name
|
|
17389
17616
|
* @param {string} [object] Optional object name used to resolve the record before building the preview.
|
|
17390
|
-
* @param {
|
|
17617
|
+
* @param {Preview1ParseEnum} [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).
|
|
17391
17618
|
* @param {*} [options] Override http request option.
|
|
17392
17619
|
* @throws {RequiredError}
|
|
17393
17620
|
*/
|
|
17394
|
-
|
|
17621
|
+
preview1(uuid, name, object, parse, options) {
|
|
17395
17622
|
return __awaiter(this, void 0, void 0, function* () {
|
|
17396
17623
|
var _a, _b, _c;
|
|
17397
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
17624
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.preview1(uuid, name, object, parse, options);
|
|
17398
17625
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17399
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['RecordsApi.
|
|
17626
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['RecordsApi.preview1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17400
17627
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17401
17628
|
});
|
|
17402
17629
|
},
|
|
@@ -17772,12 +17999,12 @@ export const RecordsApiFactory = function (configuration, basePath, axios) {
|
|
|
17772
17999
|
* @param {string} uuid
|
|
17773
18000
|
* @param {string} name
|
|
17774
18001
|
* @param {string} [object] Optional object name used to resolve the record before building the preview.
|
|
17775
|
-
* @param {
|
|
18002
|
+
* @param {Preview1ParseEnum} [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
18003
|
* @param {*} [options] Override http request option.
|
|
17777
18004
|
* @throws {RequiredError}
|
|
17778
18005
|
*/
|
|
17779
|
-
|
|
17780
|
-
return localVarFp.
|
|
18006
|
+
preview1(uuid, name, object, parse, options) {
|
|
18007
|
+
return localVarFp.preview1(uuid, name, object, parse, options).then((request) => request(axios, basePath));
|
|
17781
18008
|
},
|
|
17782
18009
|
/**
|
|
17783
18010
|
* Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
|
|
@@ -18089,12 +18316,12 @@ export class RecordsApi extends BaseAPI {
|
|
|
18089
18316
|
* @param {string} uuid
|
|
18090
18317
|
* @param {string} name
|
|
18091
18318
|
* @param {string} [object] Optional object name used to resolve the record before building the preview.
|
|
18092
|
-
* @param {
|
|
18319
|
+
* @param {Preview1ParseEnum} [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).
|
|
18093
18320
|
* @param {*} [options] Override http request option.
|
|
18094
18321
|
* @throws {RequiredError}
|
|
18095
18322
|
*/
|
|
18096
|
-
|
|
18097
|
-
return RecordsApiFp(this.configuration).
|
|
18323
|
+
preview1(uuid, name, object, parse, options) {
|
|
18324
|
+
return RecordsApiFp(this.configuration).preview1(uuid, name, object, parse, options).then((request) => request(this.axios, this.basePath));
|
|
18098
18325
|
}
|
|
18099
18326
|
/**
|
|
18100
18327
|
* Executes a two-pass GraphRAG query using natural language or a declarative plan. Returns records with scores and graph evidence.
|
|
@@ -18267,7 +18494,7 @@ export const IndexFlowParseEnum = {
|
|
|
18267
18494
|
HumanReadable: 'HUMAN_READABLE',
|
|
18268
18495
|
Structured: 'STRUCTURED',
|
|
18269
18496
|
};
|
|
18270
|
-
export const
|
|
18497
|
+
export const Preview1ParseEnum = {
|
|
18271
18498
|
Db: 'DB',
|
|
18272
18499
|
HumanReadable: 'HUMAN_READABLE',
|
|
18273
18500
|
Structured: 'STRUCTURED',
|
|
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**itemLabel** | **string** | | [optional] [default to undefined]
|
|
29
29
|
**value** | **any** | | [optional] [default to undefined]
|
|
30
30
|
**hasValue** | **boolean** | | [optional] [default to undefined]
|
|
31
|
+
**clearValue** | **boolean** | | [optional] [default to undefined]
|
|
31
32
|
**mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) | | [optional] [default to undefined]
|
|
32
33
|
**valueScope** | **string** | | [optional] [default to undefined]
|
|
33
34
|
**settingsGroup** | **boolean** | | [optional] [default to undefined]
|
|
@@ -64,6 +65,7 @@ const instance: AppSettingFieldSchema = {
|
|
|
64
65
|
itemLabel,
|
|
65
66
|
value,
|
|
66
67
|
hasValue,
|
|
68
|
+
clearValue,
|
|
67
69
|
mappingValue,
|
|
68
70
|
valueScope,
|
|
69
71
|
settingsGroup,
|
package/docs/ApplicationsApi.md
CHANGED
|
@@ -558,7 +558,7 @@ const { status, data } = await apiInstance.getAppWebhooks(
|
|
|
558
558
|
# **getApps**
|
|
559
559
|
> PaginationResponseAppDTO getApps(paginationRequest)
|
|
560
560
|
|
|
561
|
-
Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
561
|
+
Fetches a paginated and optionally filtered list of applications. The list is sorted alphabetically by category and name. Unpublished public apps are visible only when the selected company is their creator. The native tools list includes only published apps. On success, returns a PaginationResponse containing AppSummaryDTO objects.
|
|
562
562
|
|
|
563
563
|
### Example
|
|
564
564
|
|
package/docs/CMSV2PublicApi.md
CHANGED
|
@@ -173,9 +173,11 @@ const configuration = new Configuration();
|
|
|
173
173
|
const apiInstance = new CMSV2PublicApi(configuration);
|
|
174
174
|
|
|
175
175
|
let xCaraerSubdomain: string; // (default to undefined)
|
|
176
|
+
let channel: string; // (optional) (default to undefined)
|
|
176
177
|
|
|
177
178
|
const { status, data } = await apiInstance.buildManifest(
|
|
178
|
-
xCaraerSubdomain
|
|
179
|
+
xCaraerSubdomain,
|
|
180
|
+
channel
|
|
179
181
|
);
|
|
180
182
|
```
|
|
181
183
|
|
|
@@ -184,6 +186,7 @@ const { status, data } = await apiInstance.buildManifest(
|
|
|
184
186
|
|Name | Type | Description | Notes|
|
|
185
187
|
|------------- | ------------- | ------------- | -------------|
|
|
186
188
|
| **xCaraerSubdomain** | [**string**] | | defaults to undefined|
|
|
189
|
+
| **channel** | [**string**] | | (optional) defaults to undefined|
|
|
187
190
|
|
|
188
191
|
|
|
189
192
|
### Return type
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# CMSWebsiteUpdatesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://v2.api.caraer.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**pending**](#pending) | **GET** /api/v2/webpages/v2/updates | Pending module updates for this website|
|
|
8
|
+
|[**preview**](#preview) | **POST** /api/v2/webpages/v2/updates/preview | Build a preview site with every pending module update|
|
|
9
|
+
|[**promote**](#promote) | **POST** /api/v2/webpages/v2/updates/promote | Promote a previewed module set to production|
|
|
10
|
+
|
|
11
|
+
# **pending**
|
|
12
|
+
> ShowResponseMapStringObject pending()
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
CMSWebsiteUpdatesApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@caraer/client';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new CMSWebsiteUpdatesApi(configuration);
|
|
25
|
+
|
|
26
|
+
const { status, data } = await apiInstance.pending();
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Parameters
|
|
30
|
+
This endpoint does not have any parameters.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
### Return type
|
|
34
|
+
|
|
35
|
+
**ShowResponseMapStringObject**
|
|
36
|
+
|
|
37
|
+
### Authorization
|
|
38
|
+
|
|
39
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
40
|
+
|
|
41
|
+
### HTTP request headers
|
|
42
|
+
|
|
43
|
+
- **Content-Type**: Not defined
|
|
44
|
+
- **Accept**: application/json
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### HTTP response details
|
|
48
|
+
| Status code | Description | Response headers |
|
|
49
|
+
|-------------|-------------|------------------|
|
|
50
|
+
|**200** | OK | - |
|
|
51
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
52
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
53
|
+
|**404** | The requested resource was not found. | - |
|
|
54
|
+
|**500** | An internal server error occurred. | - |
|
|
55
|
+
|
|
56
|
+
[[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)
|
|
57
|
+
|
|
58
|
+
# **preview**
|
|
59
|
+
> ShowResponseMapStringObject preview()
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### Example
|
|
63
|
+
|
|
64
|
+
```typescript
|
|
65
|
+
import {
|
|
66
|
+
CMSWebsiteUpdatesApi,
|
|
67
|
+
Configuration
|
|
68
|
+
} from '@caraer/client';
|
|
69
|
+
|
|
70
|
+
const configuration = new Configuration();
|
|
71
|
+
const apiInstance = new CMSWebsiteUpdatesApi(configuration);
|
|
72
|
+
|
|
73
|
+
const { status, data } = await apiInstance.preview();
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Parameters
|
|
77
|
+
This endpoint does not have any parameters.
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
### Return type
|
|
81
|
+
|
|
82
|
+
**ShowResponseMapStringObject**
|
|
83
|
+
|
|
84
|
+
### Authorization
|
|
85
|
+
|
|
86
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
87
|
+
|
|
88
|
+
### HTTP request headers
|
|
89
|
+
|
|
90
|
+
- **Content-Type**: Not defined
|
|
91
|
+
- **Accept**: application/json
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
### HTTP response details
|
|
95
|
+
| Status code | Description | Response headers |
|
|
96
|
+
|-------------|-------------|------------------|
|
|
97
|
+
|**200** | OK | - |
|
|
98
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
99
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
100
|
+
|**404** | The requested resource was not found. | - |
|
|
101
|
+
|**500** | An internal server error occurred. | - |
|
|
102
|
+
|
|
103
|
+
[[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)
|
|
104
|
+
|
|
105
|
+
# **promote**
|
|
106
|
+
> ShowResponseMapStringObject promote()
|
|
107
|
+
|
|
108
|
+
Rejected with 409 when the preview revision is no longer the current pending set.
|
|
109
|
+
|
|
110
|
+
### Example
|
|
111
|
+
|
|
112
|
+
```typescript
|
|
113
|
+
import {
|
|
114
|
+
CMSWebsiteUpdatesApi,
|
|
115
|
+
Configuration
|
|
116
|
+
} from '@caraer/client';
|
|
117
|
+
|
|
118
|
+
const configuration = new Configuration();
|
|
119
|
+
const apiInstance = new CMSWebsiteUpdatesApi(configuration);
|
|
120
|
+
|
|
121
|
+
let requestBody: { [key: string]: any | null; }; // (optional)
|
|
122
|
+
|
|
123
|
+
const { status, data } = await apiInstance.promote(
|
|
124
|
+
requestBody
|
|
125
|
+
);
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Parameters
|
|
129
|
+
|
|
130
|
+
|Name | Type | Description | Notes|
|
|
131
|
+
|------------- | ------------- | ------------- | -------------|
|
|
132
|
+
| **requestBody** | **{ [key: string]: any | null; }**| | |
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
### Return type
|
|
136
|
+
|
|
137
|
+
**ShowResponseMapStringObject**
|
|
138
|
+
|
|
139
|
+
### Authorization
|
|
140
|
+
|
|
141
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
142
|
+
|
|
143
|
+
### HTTP request headers
|
|
144
|
+
|
|
145
|
+
- **Content-Type**: application/json
|
|
146
|
+
- **Accept**: application/json
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
### HTTP response details
|
|
150
|
+
| Status code | Description | Response headers |
|
|
151
|
+
|-------------|-------------|------------------|
|
|
152
|
+
|**200** | OK | - |
|
|
153
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
154
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
155
|
+
|**404** | The requested resource was not found. | - |
|
|
156
|
+
|**500** | An internal server error occurred. | - |
|
|
157
|
+
|
|
158
|
+
[[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)
|
|
159
|
+
|