@caraer/client 2.0.617 → 2.0.619
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 +92 -0
- package/dist/api.d.ts +40 -0
- package/dist/api.js +87 -0
- package/dist/esm/api.d.ts +40 -0
- package/dist/esm/api.js +87 -0
- package/docs/CMSV2PublicApi.md +62 -0
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -16513,6 +16513,58 @@ export const CMSV2PublicApiAxiosParamCreator = function (configuration?: Configu
|
|
|
16513
16513
|
options: localVarRequestOptions,
|
|
16514
16514
|
};
|
|
16515
16515
|
},
|
|
16516
|
+
/**
|
|
16517
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
16518
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
16519
|
+
* @param {string} xCaraerSubdomain
|
|
16520
|
+
* @param {string} path
|
|
16521
|
+
* @param {string} [environment]
|
|
16522
|
+
* @param {*} [options] Override http request option.
|
|
16523
|
+
* @throws {RequiredError}
|
|
16524
|
+
*/
|
|
16525
|
+
redirect: async (xCaraerSubdomain: string, path: string, environment?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
16526
|
+
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
16527
|
+
assertParamExists('redirect', 'xCaraerSubdomain', xCaraerSubdomain)
|
|
16528
|
+
// verify required parameter 'path' is not null or undefined
|
|
16529
|
+
assertParamExists('redirect', 'path', path)
|
|
16530
|
+
const localVarPath = `/api/v2/webpages/v2/public/redirect`;
|
|
16531
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16532
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16533
|
+
let baseOptions;
|
|
16534
|
+
if (configuration) {
|
|
16535
|
+
baseOptions = configuration.baseOptions;
|
|
16536
|
+
}
|
|
16537
|
+
|
|
16538
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
16539
|
+
const localVarHeaderParameter = {} as any;
|
|
16540
|
+
const localVarQueryParameter = {} as any;
|
|
16541
|
+
|
|
16542
|
+
// authentication bearerAuth required
|
|
16543
|
+
// http bearer authentication required
|
|
16544
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
16545
|
+
|
|
16546
|
+
if (environment !== undefined) {
|
|
16547
|
+
localVarQueryParameter['environment'] = environment;
|
|
16548
|
+
}
|
|
16549
|
+
|
|
16550
|
+
if (path !== undefined) {
|
|
16551
|
+
localVarQueryParameter['path'] = path;
|
|
16552
|
+
}
|
|
16553
|
+
|
|
16554
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16555
|
+
|
|
16556
|
+
if (xCaraerSubdomain != null) {
|
|
16557
|
+
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
16558
|
+
}
|
|
16559
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16560
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16561
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
16562
|
+
|
|
16563
|
+
return {
|
|
16564
|
+
url: toPathString(localVarUrlObj),
|
|
16565
|
+
options: localVarRequestOptions,
|
|
16566
|
+
};
|
|
16567
|
+
},
|
|
16516
16568
|
/**
|
|
16517
16569
|
*
|
|
16518
16570
|
* @summary Company settings, branding and locales
|
|
@@ -16777,6 +16829,21 @@ export const CMSV2PublicApiFp = function(configuration?: Configuration) {
|
|
|
16777
16829
|
const localVarOperationServerBasePath = operationServerMap['CMSV2PublicApi.records']?.[localVarOperationServerIndex]?.url;
|
|
16778
16830
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16779
16831
|
},
|
|
16832
|
+
/**
|
|
16833
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
16834
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
16835
|
+
* @param {string} xCaraerSubdomain
|
|
16836
|
+
* @param {string} path
|
|
16837
|
+
* @param {string} [environment]
|
|
16838
|
+
* @param {*} [options] Override http request option.
|
|
16839
|
+
* @throws {RequiredError}
|
|
16840
|
+
*/
|
|
16841
|
+
async redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>> {
|
|
16842
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.redirect(xCaraerSubdomain, path, environment, options);
|
|
16843
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
16844
|
+
const localVarOperationServerBasePath = operationServerMap['CMSV2PublicApi.redirect']?.[localVarOperationServerIndex]?.url;
|
|
16845
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16846
|
+
},
|
|
16780
16847
|
/**
|
|
16781
16848
|
*
|
|
16782
16849
|
* @summary Company settings, branding and locales
|
|
@@ -16945,6 +17012,18 @@ export const CMSV2PublicApiFactory = function (configuration?: Configuration, ba
|
|
|
16945
17012
|
records(xCaraerSubdomain: string, requestBody: { [key: string]: any | null; }, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
|
|
16946
17013
|
return localVarFp.records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(axios, basePath));
|
|
16947
17014
|
},
|
|
17015
|
+
/**
|
|
17016
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
17017
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
17018
|
+
* @param {string} xCaraerSubdomain
|
|
17019
|
+
* @param {string} path
|
|
17020
|
+
* @param {string} [environment]
|
|
17021
|
+
* @param {*} [options] Override http request option.
|
|
17022
|
+
* @throws {RequiredError}
|
|
17023
|
+
*/
|
|
17024
|
+
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString> {
|
|
17025
|
+
return localVarFp.redirect(xCaraerSubdomain, path, environment, options).then((request) => request(axios, basePath));
|
|
17026
|
+
},
|
|
16948
17027
|
/**
|
|
16949
17028
|
*
|
|
16950
17029
|
* @summary Company settings, branding and locales
|
|
@@ -17114,6 +17193,19 @@ export class CMSV2PublicApi extends BaseAPI {
|
|
|
17114
17193
|
return CMSV2PublicApiFp(this.configuration).records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(this.axios, this.basePath));
|
|
17115
17194
|
}
|
|
17116
17195
|
|
|
17196
|
+
/**
|
|
17197
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
17198
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
17199
|
+
* @param {string} xCaraerSubdomain
|
|
17200
|
+
* @param {string} path
|
|
17201
|
+
* @param {string} [environment]
|
|
17202
|
+
* @param {*} [options] Override http request option.
|
|
17203
|
+
* @throws {RequiredError}
|
|
17204
|
+
*/
|
|
17205
|
+
public redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig) {
|
|
17206
|
+
return CMSV2PublicApiFp(this.configuration).redirect(xCaraerSubdomain, path, environment, options).then((request) => request(this.axios, this.basePath));
|
|
17207
|
+
}
|
|
17208
|
+
|
|
17117
17209
|
/**
|
|
17118
17210
|
*
|
|
17119
17211
|
* @summary Company settings, branding and locales
|
package/dist/api.d.ts
CHANGED
|
@@ -12254,6 +12254,16 @@ export declare const CMSV2PublicApiAxiosParamCreator: (configuration?: Configura
|
|
|
12254
12254
|
records: (xCaraerSubdomain: string, requestBody: {
|
|
12255
12255
|
[key: string]: any | null;
|
|
12256
12256
|
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12257
|
+
/**
|
|
12258
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12259
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
12260
|
+
* @param {string} xCaraerSubdomain
|
|
12261
|
+
* @param {string} path
|
|
12262
|
+
* @param {string} [environment]
|
|
12263
|
+
* @param {*} [options] Override http request option.
|
|
12264
|
+
* @throws {RequiredError}
|
|
12265
|
+
*/
|
|
12266
|
+
redirect: (xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12257
12267
|
/**
|
|
12258
12268
|
*
|
|
12259
12269
|
* @summary Company settings, branding and locales
|
|
@@ -12394,6 +12404,16 @@ export declare const CMSV2PublicApiFp: (configuration?: Configuration) => {
|
|
|
12394
12404
|
records(xCaraerSubdomain: string, requestBody: {
|
|
12395
12405
|
[key: string]: any | null;
|
|
12396
12406
|
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
12407
|
+
/**
|
|
12408
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12409
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
12410
|
+
* @param {string} xCaraerSubdomain
|
|
12411
|
+
* @param {string} path
|
|
12412
|
+
* @param {string} [environment]
|
|
12413
|
+
* @param {*} [options] Override http request option.
|
|
12414
|
+
* @throws {RequiredError}
|
|
12415
|
+
*/
|
|
12416
|
+
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
|
|
12397
12417
|
/**
|
|
12398
12418
|
*
|
|
12399
12419
|
* @summary Company settings, branding and locales
|
|
@@ -12534,6 +12554,16 @@ export declare const CMSV2PublicApiFactory: (configuration?: Configuration, base
|
|
|
12534
12554
|
records(xCaraerSubdomain: string, requestBody: {
|
|
12535
12555
|
[key: string]: any | null;
|
|
12536
12556
|
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
12557
|
+
/**
|
|
12558
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12559
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
12560
|
+
* @param {string} xCaraerSubdomain
|
|
12561
|
+
* @param {string} path
|
|
12562
|
+
* @param {string} [environment]
|
|
12563
|
+
* @param {*} [options] Override http request option.
|
|
12564
|
+
* @throws {RequiredError}
|
|
12565
|
+
*/
|
|
12566
|
+
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
|
|
12537
12567
|
/**
|
|
12538
12568
|
*
|
|
12539
12569
|
* @summary Company settings, branding and locales
|
|
@@ -12674,6 +12704,16 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12674
12704
|
records(xCaraerSubdomain: string, requestBody: {
|
|
12675
12705
|
[key: string]: any | null;
|
|
12676
12706
|
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12707
|
+
/**
|
|
12708
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12709
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
12710
|
+
* @param {string} xCaraerSubdomain
|
|
12711
|
+
* @param {string} path
|
|
12712
|
+
* @param {string} [environment]
|
|
12713
|
+
* @param {*} [options] Override http request option.
|
|
12714
|
+
* @throws {RequiredError}
|
|
12715
|
+
*/
|
|
12716
|
+
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
12677
12717
|
/**
|
|
12678
12718
|
*
|
|
12679
12719
|
* @summary Company settings, branding and locales
|
package/dist/api.js
CHANGED
|
@@ -7795,6 +7795,51 @@ const CMSV2PublicApiAxiosParamCreator = function (configuration) {
|
|
|
7795
7795
|
options: localVarRequestOptions,
|
|
7796
7796
|
};
|
|
7797
7797
|
}),
|
|
7798
|
+
/**
|
|
7799
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
7800
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
7801
|
+
* @param {string} xCaraerSubdomain
|
|
7802
|
+
* @param {string} path
|
|
7803
|
+
* @param {string} [environment]
|
|
7804
|
+
* @param {*} [options] Override http request option.
|
|
7805
|
+
* @throws {RequiredError}
|
|
7806
|
+
*/
|
|
7807
|
+
redirect: (xCaraerSubdomain_1, path_1, environment_1, ...args_1) => __awaiter(this, [xCaraerSubdomain_1, path_1, environment_1, ...args_1], void 0, function* (xCaraerSubdomain, path, environment, options = {}) {
|
|
7808
|
+
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
7809
|
+
(0, common_1.assertParamExists)('redirect', 'xCaraerSubdomain', xCaraerSubdomain);
|
|
7810
|
+
// verify required parameter 'path' is not null or undefined
|
|
7811
|
+
(0, common_1.assertParamExists)('redirect', 'path', path);
|
|
7812
|
+
const localVarPath = `/api/v2/webpages/v2/public/redirect`;
|
|
7813
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7814
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
7815
|
+
let baseOptions;
|
|
7816
|
+
if (configuration) {
|
|
7817
|
+
baseOptions = configuration.baseOptions;
|
|
7818
|
+
}
|
|
7819
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
7820
|
+
const localVarHeaderParameter = {};
|
|
7821
|
+
const localVarQueryParameter = {};
|
|
7822
|
+
// authentication bearerAuth required
|
|
7823
|
+
// http bearer authentication required
|
|
7824
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
7825
|
+
if (environment !== undefined) {
|
|
7826
|
+
localVarQueryParameter['environment'] = environment;
|
|
7827
|
+
}
|
|
7828
|
+
if (path !== undefined) {
|
|
7829
|
+
localVarQueryParameter['path'] = path;
|
|
7830
|
+
}
|
|
7831
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7832
|
+
if (xCaraerSubdomain != null) {
|
|
7833
|
+
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
7834
|
+
}
|
|
7835
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
7836
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7837
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7838
|
+
return {
|
|
7839
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
7840
|
+
options: localVarRequestOptions,
|
|
7841
|
+
};
|
|
7842
|
+
}),
|
|
7798
7843
|
/**
|
|
7799
7844
|
*
|
|
7800
7845
|
* @summary Company settings, branding and locales
|
|
@@ -8074,6 +8119,24 @@ const CMSV2PublicApiFp = function (configuration) {
|
|
|
8074
8119
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8075
8120
|
});
|
|
8076
8121
|
},
|
|
8122
|
+
/**
|
|
8123
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
8124
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
8125
|
+
* @param {string} xCaraerSubdomain
|
|
8126
|
+
* @param {string} path
|
|
8127
|
+
* @param {string} [environment]
|
|
8128
|
+
* @param {*} [options] Override http request option.
|
|
8129
|
+
* @throws {RequiredError}
|
|
8130
|
+
*/
|
|
8131
|
+
redirect(xCaraerSubdomain, path, environment, options) {
|
|
8132
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8133
|
+
var _a, _b, _c;
|
|
8134
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.redirect(xCaraerSubdomain, path, environment, options);
|
|
8135
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8136
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CMSV2PublicApi.redirect']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8137
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8138
|
+
});
|
|
8139
|
+
},
|
|
8077
8140
|
/**
|
|
8078
8141
|
*
|
|
8079
8142
|
* @summary Company settings, branding and locales
|
|
@@ -8248,6 +8311,18 @@ const CMSV2PublicApiFactory = function (configuration, basePath, axios) {
|
|
|
8248
8311
|
records(xCaraerSubdomain, requestBody, environment, locale, options) {
|
|
8249
8312
|
return localVarFp.records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(axios, basePath));
|
|
8250
8313
|
},
|
|
8314
|
+
/**
|
|
8315
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
8316
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
8317
|
+
* @param {string} xCaraerSubdomain
|
|
8318
|
+
* @param {string} path
|
|
8319
|
+
* @param {string} [environment]
|
|
8320
|
+
* @param {*} [options] Override http request option.
|
|
8321
|
+
* @throws {RequiredError}
|
|
8322
|
+
*/
|
|
8323
|
+
redirect(xCaraerSubdomain, path, environment, options) {
|
|
8324
|
+
return localVarFp.redirect(xCaraerSubdomain, path, environment, options).then((request) => request(axios, basePath));
|
|
8325
|
+
},
|
|
8251
8326
|
/**
|
|
8252
8327
|
*
|
|
8253
8328
|
* @summary Company settings, branding and locales
|
|
@@ -8408,6 +8483,18 @@ class CMSV2PublicApi extends base_1.BaseAPI {
|
|
|
8408
8483
|
records(xCaraerSubdomain, requestBody, environment, locale, options) {
|
|
8409
8484
|
return (0, exports.CMSV2PublicApiFp)(this.configuration).records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(this.axios, this.basePath));
|
|
8410
8485
|
}
|
|
8486
|
+
/**
|
|
8487
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
8488
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
8489
|
+
* @param {string} xCaraerSubdomain
|
|
8490
|
+
* @param {string} path
|
|
8491
|
+
* @param {string} [environment]
|
|
8492
|
+
* @param {*} [options] Override http request option.
|
|
8493
|
+
* @throws {RequiredError}
|
|
8494
|
+
*/
|
|
8495
|
+
redirect(xCaraerSubdomain, path, environment, options) {
|
|
8496
|
+
return (0, exports.CMSV2PublicApiFp)(this.configuration).redirect(xCaraerSubdomain, path, environment, options).then((request) => request(this.axios, this.basePath));
|
|
8497
|
+
}
|
|
8411
8498
|
/**
|
|
8412
8499
|
*
|
|
8413
8500
|
* @summary Company settings, branding and locales
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -12254,6 +12254,16 @@ export declare const CMSV2PublicApiAxiosParamCreator: (configuration?: Configura
|
|
|
12254
12254
|
records: (xCaraerSubdomain: string, requestBody: {
|
|
12255
12255
|
[key: string]: any | null;
|
|
12256
12256
|
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12257
|
+
/**
|
|
12258
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12259
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
12260
|
+
* @param {string} xCaraerSubdomain
|
|
12261
|
+
* @param {string} path
|
|
12262
|
+
* @param {string} [environment]
|
|
12263
|
+
* @param {*} [options] Override http request option.
|
|
12264
|
+
* @throws {RequiredError}
|
|
12265
|
+
*/
|
|
12266
|
+
redirect: (xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12257
12267
|
/**
|
|
12258
12268
|
*
|
|
12259
12269
|
* @summary Company settings, branding and locales
|
|
@@ -12394,6 +12404,16 @@ export declare const CMSV2PublicApiFp: (configuration?: Configuration) => {
|
|
|
12394
12404
|
records(xCaraerSubdomain: string, requestBody: {
|
|
12395
12405
|
[key: string]: any | null;
|
|
12396
12406
|
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
|
|
12407
|
+
/**
|
|
12408
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12409
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
12410
|
+
* @param {string} xCaraerSubdomain
|
|
12411
|
+
* @param {string} path
|
|
12412
|
+
* @param {string} [environment]
|
|
12413
|
+
* @param {*} [options] Override http request option.
|
|
12414
|
+
* @throws {RequiredError}
|
|
12415
|
+
*/
|
|
12416
|
+
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
|
|
12397
12417
|
/**
|
|
12398
12418
|
*
|
|
12399
12419
|
* @summary Company settings, branding and locales
|
|
@@ -12534,6 +12554,16 @@ export declare const CMSV2PublicApiFactory: (configuration?: Configuration, base
|
|
|
12534
12554
|
records(xCaraerSubdomain: string, requestBody: {
|
|
12535
12555
|
[key: string]: any | null;
|
|
12536
12556
|
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
|
|
12557
|
+
/**
|
|
12558
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12559
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
12560
|
+
* @param {string} xCaraerSubdomain
|
|
12561
|
+
* @param {string} path
|
|
12562
|
+
* @param {string} [environment]
|
|
12563
|
+
* @param {*} [options] Override http request option.
|
|
12564
|
+
* @throws {RequiredError}
|
|
12565
|
+
*/
|
|
12566
|
+
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
|
|
12537
12567
|
/**
|
|
12538
12568
|
*
|
|
12539
12569
|
* @summary Company settings, branding and locales
|
|
@@ -12674,6 +12704,16 @@ export declare class CMSV2PublicApi extends BaseAPI {
|
|
|
12674
12704
|
records(xCaraerSubdomain: string, requestBody: {
|
|
12675
12705
|
[key: string]: any | null;
|
|
12676
12706
|
}, environment?: string, locale?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
|
|
12707
|
+
/**
|
|
12708
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
12709
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
12710
|
+
* @param {string} xCaraerSubdomain
|
|
12711
|
+
* @param {string} path
|
|
12712
|
+
* @param {string} [environment]
|
|
12713
|
+
* @param {*} [options] Override http request option.
|
|
12714
|
+
* @throws {RequiredError}
|
|
12715
|
+
*/
|
|
12716
|
+
redirect(xCaraerSubdomain: string, path: string, environment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
|
|
12677
12717
|
/**
|
|
12678
12718
|
*
|
|
12679
12719
|
* @summary Company settings, branding and locales
|
package/dist/esm/api.js
CHANGED
|
@@ -7753,6 +7753,51 @@ export const CMSV2PublicApiAxiosParamCreator = function (configuration) {
|
|
|
7753
7753
|
options: localVarRequestOptions,
|
|
7754
7754
|
};
|
|
7755
7755
|
}),
|
|
7756
|
+
/**
|
|
7757
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
7758
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
7759
|
+
* @param {string} xCaraerSubdomain
|
|
7760
|
+
* @param {string} path
|
|
7761
|
+
* @param {string} [environment]
|
|
7762
|
+
* @param {*} [options] Override http request option.
|
|
7763
|
+
* @throws {RequiredError}
|
|
7764
|
+
*/
|
|
7765
|
+
redirect: (xCaraerSubdomain_1, path_1, environment_1, ...args_1) => __awaiter(this, [xCaraerSubdomain_1, path_1, environment_1, ...args_1], void 0, function* (xCaraerSubdomain, path, environment, options = {}) {
|
|
7766
|
+
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
7767
|
+
assertParamExists('redirect', 'xCaraerSubdomain', xCaraerSubdomain);
|
|
7768
|
+
// verify required parameter 'path' is not null or undefined
|
|
7769
|
+
assertParamExists('redirect', 'path', path);
|
|
7770
|
+
const localVarPath = `/api/v2/webpages/v2/public/redirect`;
|
|
7771
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7772
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7773
|
+
let baseOptions;
|
|
7774
|
+
if (configuration) {
|
|
7775
|
+
baseOptions = configuration.baseOptions;
|
|
7776
|
+
}
|
|
7777
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
7778
|
+
const localVarHeaderParameter = {};
|
|
7779
|
+
const localVarQueryParameter = {};
|
|
7780
|
+
// authentication bearerAuth required
|
|
7781
|
+
// http bearer authentication required
|
|
7782
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7783
|
+
if (environment !== undefined) {
|
|
7784
|
+
localVarQueryParameter['environment'] = environment;
|
|
7785
|
+
}
|
|
7786
|
+
if (path !== undefined) {
|
|
7787
|
+
localVarQueryParameter['path'] = path;
|
|
7788
|
+
}
|
|
7789
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7790
|
+
if (xCaraerSubdomain != null) {
|
|
7791
|
+
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
7792
|
+
}
|
|
7793
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7794
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7795
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7796
|
+
return {
|
|
7797
|
+
url: toPathString(localVarUrlObj),
|
|
7798
|
+
options: localVarRequestOptions,
|
|
7799
|
+
};
|
|
7800
|
+
}),
|
|
7756
7801
|
/**
|
|
7757
7802
|
*
|
|
7758
7803
|
* @summary Company settings, branding and locales
|
|
@@ -8031,6 +8076,24 @@ export const CMSV2PublicApiFp = function (configuration) {
|
|
|
8031
8076
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8032
8077
|
});
|
|
8033
8078
|
},
|
|
8079
|
+
/**
|
|
8080
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
8081
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
8082
|
+
* @param {string} xCaraerSubdomain
|
|
8083
|
+
* @param {string} path
|
|
8084
|
+
* @param {string} [environment]
|
|
8085
|
+
* @param {*} [options] Override http request option.
|
|
8086
|
+
* @throws {RequiredError}
|
|
8087
|
+
*/
|
|
8088
|
+
redirect(xCaraerSubdomain, path, environment, options) {
|
|
8089
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8090
|
+
var _a, _b, _c;
|
|
8091
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.redirect(xCaraerSubdomain, path, environment, options);
|
|
8092
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
8093
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CMSV2PublicApi.redirect']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
8094
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8095
|
+
});
|
|
8096
|
+
},
|
|
8034
8097
|
/**
|
|
8035
8098
|
*
|
|
8036
8099
|
* @summary Company settings, branding and locales
|
|
@@ -8204,6 +8267,18 @@ export const CMSV2PublicApiFactory = function (configuration, basePath, axios) {
|
|
|
8204
8267
|
records(xCaraerSubdomain, requestBody, environment, locale, options) {
|
|
8205
8268
|
return localVarFp.records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(axios, basePath));
|
|
8206
8269
|
},
|
|
8270
|
+
/**
|
|
8271
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
8272
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
8273
|
+
* @param {string} xCaraerSubdomain
|
|
8274
|
+
* @param {string} path
|
|
8275
|
+
* @param {string} [environment]
|
|
8276
|
+
* @param {*} [options] Override http request option.
|
|
8277
|
+
* @throws {RequiredError}
|
|
8278
|
+
*/
|
|
8279
|
+
redirect(xCaraerSubdomain, path, environment, options) {
|
|
8280
|
+
return localVarFp.redirect(xCaraerSubdomain, path, environment, options).then((request) => request(axios, basePath));
|
|
8281
|
+
},
|
|
8207
8282
|
/**
|
|
8208
8283
|
*
|
|
8209
8284
|
* @summary Company settings, branding and locales
|
|
@@ -8363,6 +8438,18 @@ export class CMSV2PublicApi extends BaseAPI {
|
|
|
8363
8438
|
records(xCaraerSubdomain, requestBody, environment, locale, options) {
|
|
8364
8439
|
return CMSV2PublicApiFp(this.configuration).records(xCaraerSubdomain, requestBody, environment, locale, options).then((request) => request(this.axios, this.basePath));
|
|
8365
8440
|
}
|
|
8441
|
+
/**
|
|
8442
|
+
* Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
8443
|
+
* @summary Resolve a historical CMS v2 path to its latest published route
|
|
8444
|
+
* @param {string} xCaraerSubdomain
|
|
8445
|
+
* @param {string} path
|
|
8446
|
+
* @param {string} [environment]
|
|
8447
|
+
* @param {*} [options] Override http request option.
|
|
8448
|
+
* @throws {RequiredError}
|
|
8449
|
+
*/
|
|
8450
|
+
redirect(xCaraerSubdomain, path, environment, options) {
|
|
8451
|
+
return CMSV2PublicApiFp(this.configuration).redirect(xCaraerSubdomain, path, environment, options).then((request) => request(this.axios, this.basePath));
|
|
8452
|
+
}
|
|
8366
8453
|
/**
|
|
8367
8454
|
*
|
|
8368
8455
|
* @summary Company settings, branding and locales
|
package/docs/CMSV2PublicApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
13
13
|
|[**pageGate**](#pagegate) | **GET** /api/v2/webpages/v2/public/page/gate | Protection info for a path, without the page document|
|
|
14
14
|
|[**paths**](#paths) | **GET** /api/v2/webpages/v2/public/paths | Published paths per environment, for sitemaps and cache warming|
|
|
15
15
|
|[**records**](#records) | **POST** /api/v2/webpages/v2/public/records | Public records visible in an environment|
|
|
16
|
+
|[**redirect**](#redirect) | **GET** /api/v2/webpages/v2/public/redirect | Resolve a historical CMS v2 path to its latest published route|
|
|
16
17
|
|[**settings**](#settings) | **GET** /api/v2/webpages/v2/public/settings | Company settings, branding and locales|
|
|
17
18
|
|[**unlock**](#unlock) | **POST** /api/v2/webpages/v2/public/page/{uuid}/unlock | Unlock a password-protected CMS v2 page|
|
|
18
19
|
|
|
@@ -609,6 +610,67 @@ const { status, data } = await apiInstance.records(
|
|
|
609
610
|
- **Accept**: application/json
|
|
610
611
|
|
|
611
612
|
|
|
613
|
+
### HTTP response details
|
|
614
|
+
| Status code | Description | Response headers |
|
|
615
|
+
|-------------|-------------|------------------|
|
|
616
|
+
|**200** | OK | - |
|
|
617
|
+
|**401** | Authentication is required or the token is invalid. | - |
|
|
618
|
+
|**403** | The caller is missing a required role or scope. | - |
|
|
619
|
+
|**404** | The requested resource was not found. | - |
|
|
620
|
+
|**500** | An internal server error occurred. | - |
|
|
621
|
+
|
|
622
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
623
|
+
|
|
624
|
+
# **redirect**
|
|
625
|
+
> ShowResponseMapStringString redirect()
|
|
626
|
+
|
|
627
|
+
Tenant and environment scoped. Returns 404 for current paths, unknown aliases or ambiguous aliases. No page content or access grant is returned.
|
|
628
|
+
|
|
629
|
+
### Example
|
|
630
|
+
|
|
631
|
+
```typescript
|
|
632
|
+
import {
|
|
633
|
+
CMSV2PublicApi,
|
|
634
|
+
Configuration
|
|
635
|
+
} from '@caraer/client';
|
|
636
|
+
|
|
637
|
+
const configuration = new Configuration();
|
|
638
|
+
const apiInstance = new CMSV2PublicApi(configuration);
|
|
639
|
+
|
|
640
|
+
let xCaraerSubdomain: string; // (default to undefined)
|
|
641
|
+
let path: string; // (default to undefined)
|
|
642
|
+
let environment: string; // (optional) (default to 'main')
|
|
643
|
+
|
|
644
|
+
const { status, data } = await apiInstance.redirect(
|
|
645
|
+
xCaraerSubdomain,
|
|
646
|
+
path,
|
|
647
|
+
environment
|
|
648
|
+
);
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### Parameters
|
|
652
|
+
|
|
653
|
+
|Name | Type | Description | Notes|
|
|
654
|
+
|------------- | ------------- | ------------- | -------------|
|
|
655
|
+
| **xCaraerSubdomain** | [**string**] | | defaults to undefined|
|
|
656
|
+
| **path** | [**string**] | | defaults to undefined|
|
|
657
|
+
| **environment** | [**string**] | | (optional) defaults to 'main'|
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
### Return type
|
|
661
|
+
|
|
662
|
+
**ShowResponseMapStringString**
|
|
663
|
+
|
|
664
|
+
### Authorization
|
|
665
|
+
|
|
666
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
667
|
+
|
|
668
|
+
### HTTP request headers
|
|
669
|
+
|
|
670
|
+
- **Content-Type**: Not defined
|
|
671
|
+
- **Accept**: application/json
|
|
672
|
+
|
|
673
|
+
|
|
612
674
|
### HTTP response details
|
|
613
675
|
| Status code | Description | Response headers |
|
|
614
676
|
|-------------|-------------|------------------|
|