@caraer/client 2.0.386 → 2.0.389
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/api.ts +88 -84
- package/dist/api.d.ts +43 -39
- package/dist/api.js +78 -78
- package/dist/esm/api.d.ts +43 -39
- package/dist/esm/api.js +78 -78
- package/docs/DateRange.md +18 -0
- package/docs/Record.md +2 -2
- package/docs/RecordRelationRequestDTO.md +1 -1
- package/docs/WebpagesApi.md +56 -56
- package/docs/WebsiteSettingsDTO.md +4 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
package/api.ts
CHANGED
|
@@ -1886,6 +1886,8 @@ export interface CustomFontDTO {
|
|
|
1886
1886
|
'familyName'?: string;
|
|
1887
1887
|
'variants'?: Array<FontVariantDTO>;
|
|
1888
1888
|
}
|
|
1889
|
+
export interface DateRange extends PropertyFormat {
|
|
1890
|
+
}
|
|
1889
1891
|
/**
|
|
1890
1892
|
* Response class representing the result of a delete operation.
|
|
1891
1893
|
*/
|
|
@@ -2957,9 +2959,9 @@ export interface ModelRecord {
|
|
|
2957
2959
|
'deleted'?: boolean;
|
|
2958
2960
|
'complete'?: boolean;
|
|
2959
2961
|
'uuid': string;
|
|
2960
|
-
'user'?: PublicUserDTO;
|
|
2961
2962
|
'properties'?: Array<FilledProperty>;
|
|
2962
2963
|
'objects'?: { [key: string]: any | null; };
|
|
2964
|
+
'user'?: PublicUserDTO;
|
|
2963
2965
|
}
|
|
2964
2966
|
export interface MultiLine extends PropertyFormat {
|
|
2965
2967
|
}
|
|
@@ -3839,7 +3841,7 @@ export interface PropertyDTO {
|
|
|
3839
3841
|
* @type PropertyDTOFormat
|
|
3840
3842
|
* Format configuration for the property\'s display and validation
|
|
3841
3843
|
*/
|
|
3842
|
-
export type PropertyDTOFormat = Currency | CurrencyRange | Duration | Email | LinkedProperty | ModelDate | ModelFile | MultiLine | MultiSelect | Number | NumberRange | Phone | Progress | Recurrence | SingleCheckbox | SingleLine | SingleSelect | Structure | Tag | Url;
|
|
3844
|
+
export type PropertyDTOFormat = Currency | CurrencyRange | DateRange | Duration | Email | LinkedProperty | ModelDate | ModelFile | MultiLine | MultiSelect | Number | NumberRange | Phone | Progress | Recurrence | SingleCheckbox | SingleLine | SingleSelect | Structure | Tag | Url;
|
|
3843
3845
|
|
|
3844
3846
|
export interface PropertyFormat {
|
|
3845
3847
|
'label'?: string;
|
|
@@ -3961,7 +3963,7 @@ export interface RecordRelationRequestDTO {
|
|
|
3961
3963
|
*/
|
|
3962
3964
|
'edgeProperties'?: { [key: string]: any | null; };
|
|
3963
3965
|
/**
|
|
3964
|
-
* Nested record to create
|
|
3966
|
+
* Nested record to create or update (by uuid or unique properties) before linking
|
|
3965
3967
|
*/
|
|
3966
3968
|
'record'?: RecordDTO;
|
|
3967
3969
|
/**
|
|
@@ -6176,6 +6178,8 @@ export interface WebsiteSettingsDTO {
|
|
|
6176
6178
|
'headerTertiaryButtonIconColor'?: string;
|
|
6177
6179
|
'cookieText'?: string;
|
|
6178
6180
|
'cookieAgreementText'?: string;
|
|
6181
|
+
'cookieBannerEnabled'?: boolean;
|
|
6182
|
+
'cookieBannerModuleUuid'?: string;
|
|
6179
6183
|
'cssStyles'?: string;
|
|
6180
6184
|
'headJsScript'?: string;
|
|
6181
6185
|
'bodyJsScript'?: string;
|
|
@@ -24759,50 +24763,6 @@ export const WebpagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
24759
24763
|
options: localVarRequestOptions,
|
|
24760
24764
|
};
|
|
24761
24765
|
},
|
|
24762
|
-
/**
|
|
24763
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
24764
|
-
* @summary Fetch public custom footer module
|
|
24765
|
-
* @param {string} xCaraerSubdomain
|
|
24766
|
-
* @param {string} moduleUuid
|
|
24767
|
-
* @param {*} [options] Override http request option.
|
|
24768
|
-
* @throws {RequiredError}
|
|
24769
|
-
*/
|
|
24770
|
-
getPublicCustomFooterModule: async (xCaraerSubdomain: string, moduleUuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24771
|
-
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
24772
|
-
assertParamExists('getPublicCustomFooterModule', 'xCaraerSubdomain', xCaraerSubdomain)
|
|
24773
|
-
// verify required parameter 'moduleUuid' is not null or undefined
|
|
24774
|
-
assertParamExists('getPublicCustomFooterModule', 'moduleUuid', moduleUuid)
|
|
24775
|
-
const localVarPath = `/api/v2/webpages/public/module/{moduleUuid}`
|
|
24776
|
-
.replace('{moduleUuid}', encodeURIComponent(String(moduleUuid)));
|
|
24777
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24778
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24779
|
-
let baseOptions;
|
|
24780
|
-
if (configuration) {
|
|
24781
|
-
baseOptions = configuration.baseOptions;
|
|
24782
|
-
}
|
|
24783
|
-
|
|
24784
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
24785
|
-
const localVarHeaderParameter = {} as any;
|
|
24786
|
-
const localVarQueryParameter = {} as any;
|
|
24787
|
-
|
|
24788
|
-
// authentication bearerAuth required
|
|
24789
|
-
// http bearer authentication required
|
|
24790
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
24791
|
-
|
|
24792
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
24793
|
-
|
|
24794
|
-
if (xCaraerSubdomain != null) {
|
|
24795
|
-
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
24796
|
-
}
|
|
24797
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24798
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24799
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
24800
|
-
|
|
24801
|
-
return {
|
|
24802
|
-
url: toPathString(localVarUrlObj),
|
|
24803
|
-
options: localVarRequestOptions,
|
|
24804
|
-
};
|
|
24805
|
-
},
|
|
24806
24766
|
/**
|
|
24807
24767
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
24808
24768
|
* @summary Get previews for a public webpage
|
|
@@ -25077,6 +25037,50 @@ export const WebpagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
25077
25037
|
options: localVarRequestOptions,
|
|
25078
25038
|
};
|
|
25079
25039
|
},
|
|
25040
|
+
/**
|
|
25041
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
25042
|
+
* @summary Fetch public website module
|
|
25043
|
+
* @param {string} xCaraerSubdomain
|
|
25044
|
+
* @param {string} moduleUuid
|
|
25045
|
+
* @param {*} [options] Override http request option.
|
|
25046
|
+
* @throws {RequiredError}
|
|
25047
|
+
*/
|
|
25048
|
+
getPublicWebsiteModule: async (xCaraerSubdomain: string, moduleUuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25049
|
+
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
25050
|
+
assertParamExists('getPublicWebsiteModule', 'xCaraerSubdomain', xCaraerSubdomain)
|
|
25051
|
+
// verify required parameter 'moduleUuid' is not null or undefined
|
|
25052
|
+
assertParamExists('getPublicWebsiteModule', 'moduleUuid', moduleUuid)
|
|
25053
|
+
const localVarPath = `/api/v2/webpages/public/module/{moduleUuid}`
|
|
25054
|
+
.replace('{moduleUuid}', encodeURIComponent(String(moduleUuid)));
|
|
25055
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25056
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25057
|
+
let baseOptions;
|
|
25058
|
+
if (configuration) {
|
|
25059
|
+
baseOptions = configuration.baseOptions;
|
|
25060
|
+
}
|
|
25061
|
+
|
|
25062
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
25063
|
+
const localVarHeaderParameter = {} as any;
|
|
25064
|
+
const localVarQueryParameter = {} as any;
|
|
25065
|
+
|
|
25066
|
+
// authentication bearerAuth required
|
|
25067
|
+
// http bearer authentication required
|
|
25068
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
25069
|
+
|
|
25070
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
25071
|
+
|
|
25072
|
+
if (xCaraerSubdomain != null) {
|
|
25073
|
+
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
25074
|
+
}
|
|
25075
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25076
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25077
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
25078
|
+
|
|
25079
|
+
return {
|
|
25080
|
+
url: toPathString(localVarUrlObj),
|
|
25081
|
+
options: localVarRequestOptions,
|
|
25082
|
+
};
|
|
25083
|
+
},
|
|
25080
25084
|
/**
|
|
25081
25085
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
25082
25086
|
* @summary Get template webpage
|
|
@@ -25961,20 +25965,6 @@ export const WebpagesApiFp = function(configuration?: Configuration) {
|
|
|
25961
25965
|
const localVarOperationServerBasePath = operationServerMap['WebpagesApi.getMenus']?.[localVarOperationServerIndex]?.url;
|
|
25962
25966
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25963
25967
|
},
|
|
25964
|
-
/**
|
|
25965
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
25966
|
-
* @summary Fetch public custom footer module
|
|
25967
|
-
* @param {string} xCaraerSubdomain
|
|
25968
|
-
* @param {string} moduleUuid
|
|
25969
|
-
* @param {*} [options] Override http request option.
|
|
25970
|
-
* @throws {RequiredError}
|
|
25971
|
-
*/
|
|
25972
|
-
async getPublicCustomFooterModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponse>> {
|
|
25973
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options);
|
|
25974
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25975
|
-
const localVarOperationServerBasePath = operationServerMap['WebpagesApi.getPublicCustomFooterModule']?.[localVarOperationServerIndex]?.url;
|
|
25976
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25977
|
-
},
|
|
25978
25968
|
/**
|
|
25979
25969
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
25980
25970
|
* @summary Get previews for a public webpage
|
|
@@ -26054,6 +26044,20 @@ export const WebpagesApiFp = function(configuration?: Configuration) {
|
|
|
26054
26044
|
const localVarOperationServerBasePath = operationServerMap['WebpagesApi.getPublicWebpageProtection']?.[localVarOperationServerIndex]?.url;
|
|
26055
26045
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26056
26046
|
},
|
|
26047
|
+
/**
|
|
26048
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
26049
|
+
* @summary Fetch public website module
|
|
26050
|
+
* @param {string} xCaraerSubdomain
|
|
26051
|
+
* @param {string} moduleUuid
|
|
26052
|
+
* @param {*} [options] Override http request option.
|
|
26053
|
+
* @throws {RequiredError}
|
|
26054
|
+
*/
|
|
26055
|
+
async getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponse>> {
|
|
26056
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options);
|
|
26057
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
26058
|
+
const localVarOperationServerBasePath = operationServerMap['WebpagesApi.getPublicWebsiteModule']?.[localVarOperationServerIndex]?.url;
|
|
26059
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26060
|
+
},
|
|
26057
26061
|
/**
|
|
26058
26062
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
26059
26063
|
* @summary Get template webpage
|
|
@@ -26435,17 +26439,6 @@ export const WebpagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
26435
26439
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponse> {
|
|
26436
26440
|
return localVarFp.getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(axios, basePath));
|
|
26437
26441
|
},
|
|
26438
|
-
/**
|
|
26439
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
26440
|
-
* @summary Fetch public custom footer module
|
|
26441
|
-
* @param {string} xCaraerSubdomain
|
|
26442
|
-
* @param {string} moduleUuid
|
|
26443
|
-
* @param {*} [options] Override http request option.
|
|
26444
|
-
* @throws {RequiredError}
|
|
26445
|
-
*/
|
|
26446
|
-
getPublicCustomFooterModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponse> {
|
|
26447
|
-
return localVarFp.getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(axios, basePath));
|
|
26448
|
-
},
|
|
26449
26442
|
/**
|
|
26450
26443
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
26451
26444
|
* @summary Get previews for a public webpage
|
|
@@ -26513,6 +26506,17 @@ export const WebpagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
26513
26506
|
getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseWebpageProtectionInfoDTO> {
|
|
26514
26507
|
return localVarFp.getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(axios, basePath));
|
|
26515
26508
|
},
|
|
26509
|
+
/**
|
|
26510
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
26511
|
+
* @summary Fetch public website module
|
|
26512
|
+
* @param {string} xCaraerSubdomain
|
|
26513
|
+
* @param {string} moduleUuid
|
|
26514
|
+
* @param {*} [options] Override http request option.
|
|
26515
|
+
* @throws {RequiredError}
|
|
26516
|
+
*/
|
|
26517
|
+
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponse> {
|
|
26518
|
+
return localVarFp.getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(axios, basePath));
|
|
26519
|
+
},
|
|
26516
26520
|
/**
|
|
26517
26521
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
26518
26522
|
* @summary Get template webpage
|
|
@@ -26861,18 +26865,6 @@ export class WebpagesApi extends BaseAPI {
|
|
|
26861
26865
|
return WebpagesApiFp(this.configuration).getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(this.axios, this.basePath));
|
|
26862
26866
|
}
|
|
26863
26867
|
|
|
26864
|
-
/**
|
|
26865
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
26866
|
-
* @summary Fetch public custom footer module
|
|
26867
|
-
* @param {string} xCaraerSubdomain
|
|
26868
|
-
* @param {string} moduleUuid
|
|
26869
|
-
* @param {*} [options] Override http request option.
|
|
26870
|
-
* @throws {RequiredError}
|
|
26871
|
-
*/
|
|
26872
|
-
public getPublicCustomFooterModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig) {
|
|
26873
|
-
return WebpagesApiFp(this.configuration).getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(this.axios, this.basePath));
|
|
26874
|
-
}
|
|
26875
|
-
|
|
26876
26868
|
/**
|
|
26877
26869
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
26878
26870
|
* @summary Get previews for a public webpage
|
|
@@ -26944,6 +26936,18 @@ export class WebpagesApi extends BaseAPI {
|
|
|
26944
26936
|
return WebpagesApiFp(this.configuration).getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(this.axios, this.basePath));
|
|
26945
26937
|
}
|
|
26946
26938
|
|
|
26939
|
+
/**
|
|
26940
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
26941
|
+
* @summary Fetch public website module
|
|
26942
|
+
* @param {string} xCaraerSubdomain
|
|
26943
|
+
* @param {string} moduleUuid
|
|
26944
|
+
* @param {*} [options] Override http request option.
|
|
26945
|
+
* @throws {RequiredError}
|
|
26946
|
+
*/
|
|
26947
|
+
public getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig) {
|
|
26948
|
+
return WebpagesApiFp(this.configuration).getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(this.axios, this.basePath));
|
|
26949
|
+
}
|
|
26950
|
+
|
|
26947
26951
|
/**
|
|
26948
26952
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
26949
26953
|
* @summary Get template webpage
|
package/dist/api.d.ts
CHANGED
|
@@ -1872,6 +1872,8 @@ export interface CustomFontDTO {
|
|
|
1872
1872
|
'familyName'?: string;
|
|
1873
1873
|
'variants'?: Array<FontVariantDTO>;
|
|
1874
1874
|
}
|
|
1875
|
+
export interface DateRange extends PropertyFormat {
|
|
1876
|
+
}
|
|
1875
1877
|
/**
|
|
1876
1878
|
* Response class representing the result of a delete operation.
|
|
1877
1879
|
*/
|
|
@@ -2950,11 +2952,11 @@ export interface ModelRecord {
|
|
|
2950
2952
|
'deleted'?: boolean;
|
|
2951
2953
|
'complete'?: boolean;
|
|
2952
2954
|
'uuid': string;
|
|
2953
|
-
'user'?: PublicUserDTO;
|
|
2954
2955
|
'properties'?: Array<FilledProperty>;
|
|
2955
2956
|
'objects'?: {
|
|
2956
2957
|
[key: string]: any | null;
|
|
2957
2958
|
};
|
|
2959
|
+
'user'?: PublicUserDTO;
|
|
2958
2960
|
}
|
|
2959
2961
|
export interface MultiLine extends PropertyFormat {
|
|
2960
2962
|
}
|
|
@@ -3843,7 +3845,7 @@ export interface PropertyDTO {
|
|
|
3843
3845
|
* @type PropertyDTOFormat
|
|
3844
3846
|
* Format configuration for the property\'s display and validation
|
|
3845
3847
|
*/
|
|
3846
|
-
export type PropertyDTOFormat = Currency | CurrencyRange | Duration | Email | LinkedProperty | ModelDate | ModelFile | MultiLine | MultiSelect | Number | NumberRange | Phone | Progress | Recurrence | SingleCheckbox | SingleLine | SingleSelect | Structure | Tag | Url;
|
|
3848
|
+
export type PropertyDTOFormat = Currency | CurrencyRange | DateRange | Duration | Email | LinkedProperty | ModelDate | ModelFile | MultiLine | MultiSelect | Number | NumberRange | Phone | Progress | Recurrence | SingleCheckbox | SingleLine | SingleSelect | Structure | Tag | Url;
|
|
3847
3849
|
export interface PropertyFormat {
|
|
3848
3850
|
'label'?: string;
|
|
3849
3851
|
'name'?: string;
|
|
@@ -3974,7 +3976,7 @@ export interface RecordRelationRequestDTO {
|
|
|
3974
3976
|
[key: string]: any | null;
|
|
3975
3977
|
};
|
|
3976
3978
|
/**
|
|
3977
|
-
* Nested record to create
|
|
3979
|
+
* Nested record to create or update (by uuid or unique properties) before linking
|
|
3978
3980
|
*/
|
|
3979
3981
|
'record'?: RecordDTO;
|
|
3980
3982
|
/**
|
|
@@ -6212,6 +6214,8 @@ export interface WebsiteSettingsDTO {
|
|
|
6212
6214
|
'headerTertiaryButtonIconColor'?: string;
|
|
6213
6215
|
'cookieText'?: string;
|
|
6214
6216
|
'cookieAgreementText'?: string;
|
|
6217
|
+
'cookieBannerEnabled'?: boolean;
|
|
6218
|
+
'cookieBannerModuleUuid'?: string;
|
|
6215
6219
|
'cssStyles'?: string;
|
|
6216
6220
|
'headJsScript'?: string;
|
|
6217
6221
|
'bodyJsScript'?: string;
|
|
@@ -14705,15 +14709,6 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
14705
14709
|
* @throws {RequiredError}
|
|
14706
14710
|
*/
|
|
14707
14711
|
getMenus: (xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14708
|
-
/**
|
|
14709
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
14710
|
-
* @summary Fetch public custom footer module
|
|
14711
|
-
* @param {string} xCaraerSubdomain
|
|
14712
|
-
* @param {string} moduleUuid
|
|
14713
|
-
* @param {*} [options] Override http request option.
|
|
14714
|
-
* @throws {RequiredError}
|
|
14715
|
-
*/
|
|
14716
|
-
getPublicCustomFooterModule: (xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14717
14712
|
/**
|
|
14718
14713
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
14719
14714
|
* @summary Get previews for a public webpage
|
|
@@ -14773,6 +14768,15 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
14773
14768
|
* @throws {RequiredError}
|
|
14774
14769
|
*/
|
|
14775
14770
|
getPublicWebpageProtection: (xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14771
|
+
/**
|
|
14772
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
14773
|
+
* @summary Fetch public website module
|
|
14774
|
+
* @param {string} xCaraerSubdomain
|
|
14775
|
+
* @param {string} moduleUuid
|
|
14776
|
+
* @param {*} [options] Override http request option.
|
|
14777
|
+
* @throws {RequiredError}
|
|
14778
|
+
*/
|
|
14779
|
+
getPublicWebsiteModule: (xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14776
14780
|
/**
|
|
14777
14781
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
14778
14782
|
* @summary Get template webpage
|
|
@@ -15047,15 +15051,6 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
15047
15051
|
* @throws {RequiredError}
|
|
15048
15052
|
*/
|
|
15049
15053
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponse>>;
|
|
15050
|
-
/**
|
|
15051
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
15052
|
-
* @summary Fetch public custom footer module
|
|
15053
|
-
* @param {string} xCaraerSubdomain
|
|
15054
|
-
* @param {string} moduleUuid
|
|
15055
|
-
* @param {*} [options] Override http request option.
|
|
15056
|
-
* @throws {RequiredError}
|
|
15057
|
-
*/
|
|
15058
|
-
getPublicCustomFooterModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponse>>;
|
|
15059
15054
|
/**
|
|
15060
15055
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
15061
15056
|
* @summary Get previews for a public webpage
|
|
@@ -15115,6 +15110,15 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
15115
15110
|
* @throws {RequiredError}
|
|
15116
15111
|
*/
|
|
15117
15112
|
getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseWebpageProtectionInfoDTO>>;
|
|
15113
|
+
/**
|
|
15114
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
15115
|
+
* @summary Fetch public website module
|
|
15116
|
+
* @param {string} xCaraerSubdomain
|
|
15117
|
+
* @param {string} moduleUuid
|
|
15118
|
+
* @param {*} [options] Override http request option.
|
|
15119
|
+
* @throws {RequiredError}
|
|
15120
|
+
*/
|
|
15121
|
+
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponse>>;
|
|
15118
15122
|
/**
|
|
15119
15123
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
15120
15124
|
* @summary Get template webpage
|
|
@@ -15389,15 +15393,6 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
15389
15393
|
* @throws {RequiredError}
|
|
15390
15394
|
*/
|
|
15391
15395
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponse>;
|
|
15392
|
-
/**
|
|
15393
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
15394
|
-
* @summary Fetch public custom footer module
|
|
15395
|
-
* @param {string} xCaraerSubdomain
|
|
15396
|
-
* @param {string} moduleUuid
|
|
15397
|
-
* @param {*} [options] Override http request option.
|
|
15398
|
-
* @throws {RequiredError}
|
|
15399
|
-
*/
|
|
15400
|
-
getPublicCustomFooterModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponse>;
|
|
15401
15396
|
/**
|
|
15402
15397
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
15403
15398
|
* @summary Get previews for a public webpage
|
|
@@ -15457,6 +15452,15 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
15457
15452
|
* @throws {RequiredError}
|
|
15458
15453
|
*/
|
|
15459
15454
|
getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseWebpageProtectionInfoDTO>;
|
|
15455
|
+
/**
|
|
15456
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
15457
|
+
* @summary Fetch public website module
|
|
15458
|
+
* @param {string} xCaraerSubdomain
|
|
15459
|
+
* @param {string} moduleUuid
|
|
15460
|
+
* @param {*} [options] Override http request option.
|
|
15461
|
+
* @throws {RequiredError}
|
|
15462
|
+
*/
|
|
15463
|
+
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponse>;
|
|
15460
15464
|
/**
|
|
15461
15465
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
15462
15466
|
* @summary Get template webpage
|
|
@@ -15731,15 +15735,6 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
15731
15735
|
* @throws {RequiredError}
|
|
15732
15736
|
*/
|
|
15733
15737
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponse, any, {}>>;
|
|
15734
|
-
/**
|
|
15735
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
15736
|
-
* @summary Fetch public custom footer module
|
|
15737
|
-
* @param {string} xCaraerSubdomain
|
|
15738
|
-
* @param {string} moduleUuid
|
|
15739
|
-
* @param {*} [options] Override http request option.
|
|
15740
|
-
* @throws {RequiredError}
|
|
15741
|
-
*/
|
|
15742
|
-
getPublicCustomFooterModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponse, any, {}>>;
|
|
15743
15738
|
/**
|
|
15744
15739
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
15745
15740
|
* @summary Get previews for a public webpage
|
|
@@ -15799,6 +15794,15 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
15799
15794
|
* @throws {RequiredError}
|
|
15800
15795
|
*/
|
|
15801
15796
|
getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseWebpageProtectionInfoDTO, any, {}>>;
|
|
15797
|
+
/**
|
|
15798
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
15799
|
+
* @summary Fetch public website module
|
|
15800
|
+
* @param {string} xCaraerSubdomain
|
|
15801
|
+
* @param {string} moduleUuid
|
|
15802
|
+
* @param {*} [options] Override http request option.
|
|
15803
|
+
* @throws {RequiredError}
|
|
15804
|
+
*/
|
|
15805
|
+
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponse, any, {}>>;
|
|
15802
15806
|
/**
|
|
15803
15807
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
15804
15808
|
* @summary Get template webpage
|
package/dist/api.js
CHANGED
|
@@ -17760,45 +17760,6 @@ const WebpagesApiAxiosParamCreator = function (configuration) {
|
|
|
17760
17760
|
options: localVarRequestOptions,
|
|
17761
17761
|
};
|
|
17762
17762
|
}),
|
|
17763
|
-
/**
|
|
17764
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
17765
|
-
* @summary Fetch public custom footer module
|
|
17766
|
-
* @param {string} xCaraerSubdomain
|
|
17767
|
-
* @param {string} moduleUuid
|
|
17768
|
-
* @param {*} [options] Override http request option.
|
|
17769
|
-
* @throws {RequiredError}
|
|
17770
|
-
*/
|
|
17771
|
-
getPublicCustomFooterModule: (xCaraerSubdomain_1, moduleUuid_1, ...args_1) => __awaiter(this, [xCaraerSubdomain_1, moduleUuid_1, ...args_1], void 0, function* (xCaraerSubdomain, moduleUuid, options = {}) {
|
|
17772
|
-
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
17773
|
-
(0, common_1.assertParamExists)('getPublicCustomFooterModule', 'xCaraerSubdomain', xCaraerSubdomain);
|
|
17774
|
-
// verify required parameter 'moduleUuid' is not null or undefined
|
|
17775
|
-
(0, common_1.assertParamExists)('getPublicCustomFooterModule', 'moduleUuid', moduleUuid);
|
|
17776
|
-
const localVarPath = `/api/v2/webpages/public/module/{moduleUuid}`
|
|
17777
|
-
.replace('{moduleUuid}', encodeURIComponent(String(moduleUuid)));
|
|
17778
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17779
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
17780
|
-
let baseOptions;
|
|
17781
|
-
if (configuration) {
|
|
17782
|
-
baseOptions = configuration.baseOptions;
|
|
17783
|
-
}
|
|
17784
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
17785
|
-
const localVarHeaderParameter = {};
|
|
17786
|
-
const localVarQueryParameter = {};
|
|
17787
|
-
// authentication bearerAuth required
|
|
17788
|
-
// http bearer authentication required
|
|
17789
|
-
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
17790
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17791
|
-
if (xCaraerSubdomain != null) {
|
|
17792
|
-
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
17793
|
-
}
|
|
17794
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
17795
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17796
|
-
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17797
|
-
return {
|
|
17798
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
17799
|
-
options: localVarRequestOptions,
|
|
17800
|
-
};
|
|
17801
|
-
}),
|
|
17802
17763
|
/**
|
|
17803
17764
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
17804
17765
|
* @summary Get previews for a public webpage
|
|
@@ -18047,6 +18008,45 @@ const WebpagesApiAxiosParamCreator = function (configuration) {
|
|
|
18047
18008
|
options: localVarRequestOptions,
|
|
18048
18009
|
};
|
|
18049
18010
|
}),
|
|
18011
|
+
/**
|
|
18012
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
18013
|
+
* @summary Fetch public website module
|
|
18014
|
+
* @param {string} xCaraerSubdomain
|
|
18015
|
+
* @param {string} moduleUuid
|
|
18016
|
+
* @param {*} [options] Override http request option.
|
|
18017
|
+
* @throws {RequiredError}
|
|
18018
|
+
*/
|
|
18019
|
+
getPublicWebsiteModule: (xCaraerSubdomain_1, moduleUuid_1, ...args_1) => __awaiter(this, [xCaraerSubdomain_1, moduleUuid_1, ...args_1], void 0, function* (xCaraerSubdomain, moduleUuid, options = {}) {
|
|
18020
|
+
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
18021
|
+
(0, common_1.assertParamExists)('getPublicWebsiteModule', 'xCaraerSubdomain', xCaraerSubdomain);
|
|
18022
|
+
// verify required parameter 'moduleUuid' is not null or undefined
|
|
18023
|
+
(0, common_1.assertParamExists)('getPublicWebsiteModule', 'moduleUuid', moduleUuid);
|
|
18024
|
+
const localVarPath = `/api/v2/webpages/public/module/{moduleUuid}`
|
|
18025
|
+
.replace('{moduleUuid}', encodeURIComponent(String(moduleUuid)));
|
|
18026
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18027
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
18028
|
+
let baseOptions;
|
|
18029
|
+
if (configuration) {
|
|
18030
|
+
baseOptions = configuration.baseOptions;
|
|
18031
|
+
}
|
|
18032
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
18033
|
+
const localVarHeaderParameter = {};
|
|
18034
|
+
const localVarQueryParameter = {};
|
|
18035
|
+
// authentication bearerAuth required
|
|
18036
|
+
// http bearer authentication required
|
|
18037
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
18038
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
18039
|
+
if (xCaraerSubdomain != null) {
|
|
18040
|
+
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
18041
|
+
}
|
|
18042
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
18043
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18044
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
18045
|
+
return {
|
|
18046
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
18047
|
+
options: localVarRequestOptions,
|
|
18048
|
+
};
|
|
18049
|
+
}),
|
|
18050
18050
|
/**
|
|
18051
18051
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
18052
18052
|
* @summary Get template webpage
|
|
@@ -18884,23 +18884,6 @@ const WebpagesApiFp = function (configuration) {
|
|
|
18884
18884
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18885
18885
|
});
|
|
18886
18886
|
},
|
|
18887
|
-
/**
|
|
18888
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
18889
|
-
* @summary Fetch public custom footer module
|
|
18890
|
-
* @param {string} xCaraerSubdomain
|
|
18891
|
-
* @param {string} moduleUuid
|
|
18892
|
-
* @param {*} [options] Override http request option.
|
|
18893
|
-
* @throws {RequiredError}
|
|
18894
|
-
*/
|
|
18895
|
-
getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options) {
|
|
18896
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
18897
|
-
var _a, _b, _c;
|
|
18898
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options);
|
|
18899
|
-
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
18900
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['WebpagesApi.getPublicCustomFooterModule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
18901
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18902
|
-
});
|
|
18903
|
-
},
|
|
18904
18887
|
/**
|
|
18905
18888
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
18906
18889
|
* @summary Get previews for a public webpage
|
|
@@ -18992,6 +18975,23 @@ const WebpagesApiFp = function (configuration) {
|
|
|
18992
18975
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18993
18976
|
});
|
|
18994
18977
|
},
|
|
18978
|
+
/**
|
|
18979
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
18980
|
+
* @summary Fetch public website module
|
|
18981
|
+
* @param {string} xCaraerSubdomain
|
|
18982
|
+
* @param {string} moduleUuid
|
|
18983
|
+
* @param {*} [options] Override http request option.
|
|
18984
|
+
* @throws {RequiredError}
|
|
18985
|
+
*/
|
|
18986
|
+
getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options) {
|
|
18987
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18988
|
+
var _a, _b, _c;
|
|
18989
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options);
|
|
18990
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
18991
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['WebpagesApi.getPublicWebsiteModule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
18992
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18993
|
+
});
|
|
18994
|
+
},
|
|
18995
18995
|
/**
|
|
18996
18996
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
18997
18997
|
* @summary Get template webpage
|
|
@@ -19418,17 +19418,6 @@ const WebpagesApiFactory = function (configuration, basePath, axios) {
|
|
|
19418
19418
|
getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options) {
|
|
19419
19419
|
return localVarFp.getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(axios, basePath));
|
|
19420
19420
|
},
|
|
19421
|
-
/**
|
|
19422
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
19423
|
-
* @summary Fetch public custom footer module
|
|
19424
|
-
* @param {string} xCaraerSubdomain
|
|
19425
|
-
* @param {string} moduleUuid
|
|
19426
|
-
* @param {*} [options] Override http request option.
|
|
19427
|
-
* @throws {RequiredError}
|
|
19428
|
-
*/
|
|
19429
|
-
getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options) {
|
|
19430
|
-
return localVarFp.getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(axios, basePath));
|
|
19431
|
-
},
|
|
19432
19421
|
/**
|
|
19433
19422
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
19434
19423
|
* @summary Get previews for a public webpage
|
|
@@ -19496,6 +19485,17 @@ const WebpagesApiFactory = function (configuration, basePath, axios) {
|
|
|
19496
19485
|
getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options) {
|
|
19497
19486
|
return localVarFp.getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(axios, basePath));
|
|
19498
19487
|
},
|
|
19488
|
+
/**
|
|
19489
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
19490
|
+
* @summary Fetch public website module
|
|
19491
|
+
* @param {string} xCaraerSubdomain
|
|
19492
|
+
* @param {string} moduleUuid
|
|
19493
|
+
* @param {*} [options] Override http request option.
|
|
19494
|
+
* @throws {RequiredError}
|
|
19495
|
+
*/
|
|
19496
|
+
getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options) {
|
|
19497
|
+
return localVarFp.getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(axios, basePath));
|
|
19498
|
+
},
|
|
19499
19499
|
/**
|
|
19500
19500
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
19501
19501
|
* @summary Get template webpage
|
|
@@ -19830,17 +19830,6 @@ class WebpagesApi extends base_1.BaseAPI {
|
|
|
19830
19830
|
getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options) {
|
|
19831
19831
|
return (0, exports.WebpagesApiFp)(this.configuration).getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(this.axios, this.basePath));
|
|
19832
19832
|
}
|
|
19833
|
-
/**
|
|
19834
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
19835
|
-
* @summary Fetch public custom footer module
|
|
19836
|
-
* @param {string} xCaraerSubdomain
|
|
19837
|
-
* @param {string} moduleUuid
|
|
19838
|
-
* @param {*} [options] Override http request option.
|
|
19839
|
-
* @throws {RequiredError}
|
|
19840
|
-
*/
|
|
19841
|
-
getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options) {
|
|
19842
|
-
return (0, exports.WebpagesApiFp)(this.configuration).getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(this.axios, this.basePath));
|
|
19843
|
-
}
|
|
19844
19833
|
/**
|
|
19845
19834
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
19846
19835
|
* @summary Get previews for a public webpage
|
|
@@ -19908,6 +19897,17 @@ class WebpagesApi extends base_1.BaseAPI {
|
|
|
19908
19897
|
getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options) {
|
|
19909
19898
|
return (0, exports.WebpagesApiFp)(this.configuration).getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(this.axios, this.basePath));
|
|
19910
19899
|
}
|
|
19900
|
+
/**
|
|
19901
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
19902
|
+
* @summary Fetch public website module
|
|
19903
|
+
* @param {string} xCaraerSubdomain
|
|
19904
|
+
* @param {string} moduleUuid
|
|
19905
|
+
* @param {*} [options] Override http request option.
|
|
19906
|
+
* @throws {RequiredError}
|
|
19907
|
+
*/
|
|
19908
|
+
getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options) {
|
|
19909
|
+
return (0, exports.WebpagesApiFp)(this.configuration).getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(this.axios, this.basePath));
|
|
19910
|
+
}
|
|
19911
19911
|
/**
|
|
19912
19912
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
19913
19913
|
* @summary Get template webpage
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1872,6 +1872,8 @@ export interface CustomFontDTO {
|
|
|
1872
1872
|
'familyName'?: string;
|
|
1873
1873
|
'variants'?: Array<FontVariantDTO>;
|
|
1874
1874
|
}
|
|
1875
|
+
export interface DateRange extends PropertyFormat {
|
|
1876
|
+
}
|
|
1875
1877
|
/**
|
|
1876
1878
|
* Response class representing the result of a delete operation.
|
|
1877
1879
|
*/
|
|
@@ -2950,11 +2952,11 @@ export interface ModelRecord {
|
|
|
2950
2952
|
'deleted'?: boolean;
|
|
2951
2953
|
'complete'?: boolean;
|
|
2952
2954
|
'uuid': string;
|
|
2953
|
-
'user'?: PublicUserDTO;
|
|
2954
2955
|
'properties'?: Array<FilledProperty>;
|
|
2955
2956
|
'objects'?: {
|
|
2956
2957
|
[key: string]: any | null;
|
|
2957
2958
|
};
|
|
2959
|
+
'user'?: PublicUserDTO;
|
|
2958
2960
|
}
|
|
2959
2961
|
export interface MultiLine extends PropertyFormat {
|
|
2960
2962
|
}
|
|
@@ -3843,7 +3845,7 @@ export interface PropertyDTO {
|
|
|
3843
3845
|
* @type PropertyDTOFormat
|
|
3844
3846
|
* Format configuration for the property\'s display and validation
|
|
3845
3847
|
*/
|
|
3846
|
-
export type PropertyDTOFormat = Currency | CurrencyRange | Duration | Email | LinkedProperty | ModelDate | ModelFile | MultiLine | MultiSelect | Number | NumberRange | Phone | Progress | Recurrence | SingleCheckbox | SingleLine | SingleSelect | Structure | Tag | Url;
|
|
3848
|
+
export type PropertyDTOFormat = Currency | CurrencyRange | DateRange | Duration | Email | LinkedProperty | ModelDate | ModelFile | MultiLine | MultiSelect | Number | NumberRange | Phone | Progress | Recurrence | SingleCheckbox | SingleLine | SingleSelect | Structure | Tag | Url;
|
|
3847
3849
|
export interface PropertyFormat {
|
|
3848
3850
|
'label'?: string;
|
|
3849
3851
|
'name'?: string;
|
|
@@ -3974,7 +3976,7 @@ export interface RecordRelationRequestDTO {
|
|
|
3974
3976
|
[key: string]: any | null;
|
|
3975
3977
|
};
|
|
3976
3978
|
/**
|
|
3977
|
-
* Nested record to create
|
|
3979
|
+
* Nested record to create or update (by uuid or unique properties) before linking
|
|
3978
3980
|
*/
|
|
3979
3981
|
'record'?: RecordDTO;
|
|
3980
3982
|
/**
|
|
@@ -6212,6 +6214,8 @@ export interface WebsiteSettingsDTO {
|
|
|
6212
6214
|
'headerTertiaryButtonIconColor'?: string;
|
|
6213
6215
|
'cookieText'?: string;
|
|
6214
6216
|
'cookieAgreementText'?: string;
|
|
6217
|
+
'cookieBannerEnabled'?: boolean;
|
|
6218
|
+
'cookieBannerModuleUuid'?: string;
|
|
6215
6219
|
'cssStyles'?: string;
|
|
6216
6220
|
'headJsScript'?: string;
|
|
6217
6221
|
'bodyJsScript'?: string;
|
|
@@ -14705,15 +14709,6 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
14705
14709
|
* @throws {RequiredError}
|
|
14706
14710
|
*/
|
|
14707
14711
|
getMenus: (xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14708
|
-
/**
|
|
14709
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
14710
|
-
* @summary Fetch public custom footer module
|
|
14711
|
-
* @param {string} xCaraerSubdomain
|
|
14712
|
-
* @param {string} moduleUuid
|
|
14713
|
-
* @param {*} [options] Override http request option.
|
|
14714
|
-
* @throws {RequiredError}
|
|
14715
|
-
*/
|
|
14716
|
-
getPublicCustomFooterModule: (xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14717
14712
|
/**
|
|
14718
14713
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
14719
14714
|
* @summary Get previews for a public webpage
|
|
@@ -14773,6 +14768,15 @@ export declare const WebpagesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
14773
14768
|
* @throws {RequiredError}
|
|
14774
14769
|
*/
|
|
14775
14770
|
getPublicWebpageProtection: (xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14771
|
+
/**
|
|
14772
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
14773
|
+
* @summary Fetch public website module
|
|
14774
|
+
* @param {string} xCaraerSubdomain
|
|
14775
|
+
* @param {string} moduleUuid
|
|
14776
|
+
* @param {*} [options] Override http request option.
|
|
14777
|
+
* @throws {RequiredError}
|
|
14778
|
+
*/
|
|
14779
|
+
getPublicWebsiteModule: (xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14776
14780
|
/**
|
|
14777
14781
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
14778
14782
|
* @summary Get template webpage
|
|
@@ -15047,15 +15051,6 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
15047
15051
|
* @throws {RequiredError}
|
|
15048
15052
|
*/
|
|
15049
15053
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginationResponse>>;
|
|
15050
|
-
/**
|
|
15051
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
15052
|
-
* @summary Fetch public custom footer module
|
|
15053
|
-
* @param {string} xCaraerSubdomain
|
|
15054
|
-
* @param {string} moduleUuid
|
|
15055
|
-
* @param {*} [options] Override http request option.
|
|
15056
|
-
* @throws {RequiredError}
|
|
15057
|
-
*/
|
|
15058
|
-
getPublicCustomFooterModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponse>>;
|
|
15059
15054
|
/**
|
|
15060
15055
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
15061
15056
|
* @summary Get previews for a public webpage
|
|
@@ -15115,6 +15110,15 @@ export declare const WebpagesApiFp: (configuration?: Configuration) => {
|
|
|
15115
15110
|
* @throws {RequiredError}
|
|
15116
15111
|
*/
|
|
15117
15112
|
getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseWebpageProtectionInfoDTO>>;
|
|
15113
|
+
/**
|
|
15114
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
15115
|
+
* @summary Fetch public website module
|
|
15116
|
+
* @param {string} xCaraerSubdomain
|
|
15117
|
+
* @param {string} moduleUuid
|
|
15118
|
+
* @param {*} [options] Override http request option.
|
|
15119
|
+
* @throws {RequiredError}
|
|
15120
|
+
*/
|
|
15121
|
+
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponse>>;
|
|
15118
15122
|
/**
|
|
15119
15123
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
15120
15124
|
* @summary Get template webpage
|
|
@@ -15389,15 +15393,6 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
15389
15393
|
* @throws {RequiredError}
|
|
15390
15394
|
*/
|
|
15391
15395
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise<PaginationResponse>;
|
|
15392
|
-
/**
|
|
15393
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
15394
|
-
* @summary Fetch public custom footer module
|
|
15395
|
-
* @param {string} xCaraerSubdomain
|
|
15396
|
-
* @param {string} moduleUuid
|
|
15397
|
-
* @param {*} [options] Override http request option.
|
|
15398
|
-
* @throws {RequiredError}
|
|
15399
|
-
*/
|
|
15400
|
-
getPublicCustomFooterModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponse>;
|
|
15401
15396
|
/**
|
|
15402
15397
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
15403
15398
|
* @summary Get previews for a public webpage
|
|
@@ -15457,6 +15452,15 @@ export declare const WebpagesApiFactory: (configuration?: Configuration, basePat
|
|
|
15457
15452
|
* @throws {RequiredError}
|
|
15458
15453
|
*/
|
|
15459
15454
|
getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseWebpageProtectionInfoDTO>;
|
|
15455
|
+
/**
|
|
15456
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
15457
|
+
* @summary Fetch public website module
|
|
15458
|
+
* @param {string} xCaraerSubdomain
|
|
15459
|
+
* @param {string} moduleUuid
|
|
15460
|
+
* @param {*} [options] Override http request option.
|
|
15461
|
+
* @throws {RequiredError}
|
|
15462
|
+
*/
|
|
15463
|
+
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponse>;
|
|
15460
15464
|
/**
|
|
15461
15465
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
15462
15466
|
* @summary Get template webpage
|
|
@@ -15731,15 +15735,6 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
15731
15735
|
* @throws {RequiredError}
|
|
15732
15736
|
*/
|
|
15733
15737
|
getMenus(xCaraerSubdomain: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginationResponse, any, {}>>;
|
|
15734
|
-
/**
|
|
15735
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
15736
|
-
* @summary Fetch public custom footer module
|
|
15737
|
-
* @param {string} xCaraerSubdomain
|
|
15738
|
-
* @param {string} moduleUuid
|
|
15739
|
-
* @param {*} [options] Override http request option.
|
|
15740
|
-
* @throws {RequiredError}
|
|
15741
|
-
*/
|
|
15742
|
-
getPublicCustomFooterModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponse, any, {}>>;
|
|
15743
15738
|
/**
|
|
15744
15739
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
15745
15740
|
* @summary Get previews for a public webpage
|
|
@@ -15799,6 +15794,15 @@ export declare class WebpagesApi extends BaseAPI {
|
|
|
15799
15794
|
* @throws {RequiredError}
|
|
15800
15795
|
*/
|
|
15801
15796
|
getPublicWebpageProtection(xCaraerSubdomain: string, uuid: string, xCaraerEnvironment?: string, xCaraerPrimaryEnvironment?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseWebpageProtectionInfoDTO, any, {}>>;
|
|
15797
|
+
/**
|
|
15798
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
15799
|
+
* @summary Fetch public website module
|
|
15800
|
+
* @param {string} xCaraerSubdomain
|
|
15801
|
+
* @param {string} moduleUuid
|
|
15802
|
+
* @param {*} [options] Override http request option.
|
|
15803
|
+
* @throws {RequiredError}
|
|
15804
|
+
*/
|
|
15805
|
+
getPublicWebsiteModule(xCaraerSubdomain: string, moduleUuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponse, any, {}>>;
|
|
15802
15806
|
/**
|
|
15803
15807
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
15804
15808
|
* @summary Get template webpage
|
package/dist/esm/api.js
CHANGED
|
@@ -17659,45 +17659,6 @@ export const WebpagesApiAxiosParamCreator = function (configuration) {
|
|
|
17659
17659
|
options: localVarRequestOptions,
|
|
17660
17660
|
};
|
|
17661
17661
|
}),
|
|
17662
|
-
/**
|
|
17663
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
17664
|
-
* @summary Fetch public custom footer module
|
|
17665
|
-
* @param {string} xCaraerSubdomain
|
|
17666
|
-
* @param {string} moduleUuid
|
|
17667
|
-
* @param {*} [options] Override http request option.
|
|
17668
|
-
* @throws {RequiredError}
|
|
17669
|
-
*/
|
|
17670
|
-
getPublicCustomFooterModule: (xCaraerSubdomain_1, moduleUuid_1, ...args_1) => __awaiter(this, [xCaraerSubdomain_1, moduleUuid_1, ...args_1], void 0, function* (xCaraerSubdomain, moduleUuid, options = {}) {
|
|
17671
|
-
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
17672
|
-
assertParamExists('getPublicCustomFooterModule', 'xCaraerSubdomain', xCaraerSubdomain);
|
|
17673
|
-
// verify required parameter 'moduleUuid' is not null or undefined
|
|
17674
|
-
assertParamExists('getPublicCustomFooterModule', 'moduleUuid', moduleUuid);
|
|
17675
|
-
const localVarPath = `/api/v2/webpages/public/module/{moduleUuid}`
|
|
17676
|
-
.replace('{moduleUuid}', encodeURIComponent(String(moduleUuid)));
|
|
17677
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17678
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17679
|
-
let baseOptions;
|
|
17680
|
-
if (configuration) {
|
|
17681
|
-
baseOptions = configuration.baseOptions;
|
|
17682
|
-
}
|
|
17683
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
17684
|
-
const localVarHeaderParameter = {};
|
|
17685
|
-
const localVarQueryParameter = {};
|
|
17686
|
-
// authentication bearerAuth required
|
|
17687
|
-
// http bearer authentication required
|
|
17688
|
-
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
17689
|
-
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17690
|
-
if (xCaraerSubdomain != null) {
|
|
17691
|
-
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
17692
|
-
}
|
|
17693
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17694
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17695
|
-
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17696
|
-
return {
|
|
17697
|
-
url: toPathString(localVarUrlObj),
|
|
17698
|
-
options: localVarRequestOptions,
|
|
17699
|
-
};
|
|
17700
|
-
}),
|
|
17701
17662
|
/**
|
|
17702
17663
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
17703
17664
|
* @summary Get previews for a public webpage
|
|
@@ -17946,6 +17907,45 @@ export const WebpagesApiAxiosParamCreator = function (configuration) {
|
|
|
17946
17907
|
options: localVarRequestOptions,
|
|
17947
17908
|
};
|
|
17948
17909
|
}),
|
|
17910
|
+
/**
|
|
17911
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
17912
|
+
* @summary Fetch public website module
|
|
17913
|
+
* @param {string} xCaraerSubdomain
|
|
17914
|
+
* @param {string} moduleUuid
|
|
17915
|
+
* @param {*} [options] Override http request option.
|
|
17916
|
+
* @throws {RequiredError}
|
|
17917
|
+
*/
|
|
17918
|
+
getPublicWebsiteModule: (xCaraerSubdomain_1, moduleUuid_1, ...args_1) => __awaiter(this, [xCaraerSubdomain_1, moduleUuid_1, ...args_1], void 0, function* (xCaraerSubdomain, moduleUuid, options = {}) {
|
|
17919
|
+
// verify required parameter 'xCaraerSubdomain' is not null or undefined
|
|
17920
|
+
assertParamExists('getPublicWebsiteModule', 'xCaraerSubdomain', xCaraerSubdomain);
|
|
17921
|
+
// verify required parameter 'moduleUuid' is not null or undefined
|
|
17922
|
+
assertParamExists('getPublicWebsiteModule', 'moduleUuid', moduleUuid);
|
|
17923
|
+
const localVarPath = `/api/v2/webpages/public/module/{moduleUuid}`
|
|
17924
|
+
.replace('{moduleUuid}', encodeURIComponent(String(moduleUuid)));
|
|
17925
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17926
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17927
|
+
let baseOptions;
|
|
17928
|
+
if (configuration) {
|
|
17929
|
+
baseOptions = configuration.baseOptions;
|
|
17930
|
+
}
|
|
17931
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
17932
|
+
const localVarHeaderParameter = {};
|
|
17933
|
+
const localVarQueryParameter = {};
|
|
17934
|
+
// authentication bearerAuth required
|
|
17935
|
+
// http bearer authentication required
|
|
17936
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
17937
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17938
|
+
if (xCaraerSubdomain != null) {
|
|
17939
|
+
localVarHeaderParameter['X-Caraer-Subdomain'] = String(xCaraerSubdomain);
|
|
17940
|
+
}
|
|
17941
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17942
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17943
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17944
|
+
return {
|
|
17945
|
+
url: toPathString(localVarUrlObj),
|
|
17946
|
+
options: localVarRequestOptions,
|
|
17947
|
+
};
|
|
17948
|
+
}),
|
|
17949
17949
|
/**
|
|
17950
17950
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
17951
17951
|
* @summary Get template webpage
|
|
@@ -18782,23 +18782,6 @@ export const WebpagesApiFp = function (configuration) {
|
|
|
18782
18782
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18783
18783
|
});
|
|
18784
18784
|
},
|
|
18785
|
-
/**
|
|
18786
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
18787
|
-
* @summary Fetch public custom footer module
|
|
18788
|
-
* @param {string} xCaraerSubdomain
|
|
18789
|
-
* @param {string} moduleUuid
|
|
18790
|
-
* @param {*} [options] Override http request option.
|
|
18791
|
-
* @throws {RequiredError}
|
|
18792
|
-
*/
|
|
18793
|
-
getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options) {
|
|
18794
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
18795
|
-
var _a, _b, _c;
|
|
18796
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options);
|
|
18797
|
-
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
18798
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['WebpagesApi.getPublicCustomFooterModule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
18799
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18800
|
-
});
|
|
18801
|
-
},
|
|
18802
18785
|
/**
|
|
18803
18786
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
18804
18787
|
* @summary Get previews for a public webpage
|
|
@@ -18890,6 +18873,23 @@ export const WebpagesApiFp = function (configuration) {
|
|
|
18890
18873
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18891
18874
|
});
|
|
18892
18875
|
},
|
|
18876
|
+
/**
|
|
18877
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
18878
|
+
* @summary Fetch public website module
|
|
18879
|
+
* @param {string} xCaraerSubdomain
|
|
18880
|
+
* @param {string} moduleUuid
|
|
18881
|
+
* @param {*} [options] Override http request option.
|
|
18882
|
+
* @throws {RequiredError}
|
|
18883
|
+
*/
|
|
18884
|
+
getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options) {
|
|
18885
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18886
|
+
var _a, _b, _c;
|
|
18887
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options);
|
|
18888
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
18889
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['WebpagesApi.getPublicWebsiteModule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
18890
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18891
|
+
});
|
|
18892
|
+
},
|
|
18893
18893
|
/**
|
|
18894
18894
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
18895
18895
|
* @summary Get template webpage
|
|
@@ -19315,17 +19315,6 @@ export const WebpagesApiFactory = function (configuration, basePath, axios) {
|
|
|
19315
19315
|
getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options) {
|
|
19316
19316
|
return localVarFp.getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(axios, basePath));
|
|
19317
19317
|
},
|
|
19318
|
-
/**
|
|
19319
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
19320
|
-
* @summary Fetch public custom footer module
|
|
19321
|
-
* @param {string} xCaraerSubdomain
|
|
19322
|
-
* @param {string} moduleUuid
|
|
19323
|
-
* @param {*} [options] Override http request option.
|
|
19324
|
-
* @throws {RequiredError}
|
|
19325
|
-
*/
|
|
19326
|
-
getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options) {
|
|
19327
|
-
return localVarFp.getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(axios, basePath));
|
|
19328
|
-
},
|
|
19329
19318
|
/**
|
|
19330
19319
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
19331
19320
|
* @summary Get previews for a public webpage
|
|
@@ -19393,6 +19382,17 @@ export const WebpagesApiFactory = function (configuration, basePath, axios) {
|
|
|
19393
19382
|
getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options) {
|
|
19394
19383
|
return localVarFp.getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(axios, basePath));
|
|
19395
19384
|
},
|
|
19385
|
+
/**
|
|
19386
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
19387
|
+
* @summary Fetch public website module
|
|
19388
|
+
* @param {string} xCaraerSubdomain
|
|
19389
|
+
* @param {string} moduleUuid
|
|
19390
|
+
* @param {*} [options] Override http request option.
|
|
19391
|
+
* @throws {RequiredError}
|
|
19392
|
+
*/
|
|
19393
|
+
getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options) {
|
|
19394
|
+
return localVarFp.getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(axios, basePath));
|
|
19395
|
+
},
|
|
19396
19396
|
/**
|
|
19397
19397
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
19398
19398
|
* @summary Get template webpage
|
|
@@ -19726,17 +19726,6 @@ export class WebpagesApi extends BaseAPI {
|
|
|
19726
19726
|
getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options) {
|
|
19727
19727
|
return WebpagesApiFp(this.configuration).getMenus(xCaraerSubdomain, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(this.axios, this.basePath));
|
|
19728
19728
|
}
|
|
19729
|
-
/**
|
|
19730
|
-
* Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
19731
|
-
* @summary Fetch public custom footer module
|
|
19732
|
-
* @param {string} xCaraerSubdomain
|
|
19733
|
-
* @param {string} moduleUuid
|
|
19734
|
-
* @param {*} [options] Override http request option.
|
|
19735
|
-
* @throws {RequiredError}
|
|
19736
|
-
*/
|
|
19737
|
-
getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options) {
|
|
19738
|
-
return WebpagesApiFp(this.configuration).getPublicCustomFooterModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(this.axios, this.basePath));
|
|
19739
|
-
}
|
|
19740
19729
|
/**
|
|
19741
19730
|
* Retrieves a list of previews for a public webpage identified by its UUID. Returns a PaginationResponse containing PreviewDTO objects.
|
|
19742
19731
|
* @summary Get previews for a public webpage
|
|
@@ -19804,6 +19793,17 @@ export class WebpagesApi extends BaseAPI {
|
|
|
19804
19793
|
getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options) {
|
|
19805
19794
|
return WebpagesApiFp(this.configuration).getPublicWebpageProtection(xCaraerSubdomain, uuid, xCaraerEnvironment, xCaraerPrimaryEnvironment, options).then((request) => request(this.axios, this.basePath));
|
|
19806
19795
|
}
|
|
19796
|
+
/**
|
|
19797
|
+
* Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
19798
|
+
* @summary Fetch public website module
|
|
19799
|
+
* @param {string} xCaraerSubdomain
|
|
19800
|
+
* @param {string} moduleUuid
|
|
19801
|
+
* @param {*} [options] Override http request option.
|
|
19802
|
+
* @throws {RequiredError}
|
|
19803
|
+
*/
|
|
19804
|
+
getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options) {
|
|
19805
|
+
return WebpagesApiFp(this.configuration).getPublicWebsiteModule(xCaraerSubdomain, moduleUuid, options).then((request) => request(this.axios, this.basePath));
|
|
19806
|
+
}
|
|
19807
19807
|
/**
|
|
19808
19808
|
* Retrieves the template webpage for the given object name by querying the TemplateWebpage associated with it. Returns a ShowResponse containing TemplateWebpageDTO data.
|
|
19809
19809
|
* @summary Get template webpage
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# DateRange
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
import { DateRange } from '@caraer/client';
|
|
13
|
+
|
|
14
|
+
const instance: DateRange = {
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Record.md
CHANGED
|
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**deleted** | **boolean** | | [optional] [default to undefined]
|
|
18
18
|
**complete** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**uuid** | **string** | | [default to undefined]
|
|
20
|
-
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
21
20
|
**properties** | [**Array<FilledProperty>**](FilledProperty.md) | | [optional] [default to undefined]
|
|
22
21
|
**objects** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
|
|
22
|
+
**user** | [**PublicUserDTO**](PublicUserDTO.md) | | [optional] [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
|
@@ -39,9 +39,9 @@ const instance: ModelRecord = {
|
|
|
39
39
|
deleted,
|
|
40
40
|
complete,
|
|
41
41
|
uuid,
|
|
42
|
-
user,
|
|
43
42
|
properties,
|
|
44
43
|
objects,
|
|
44
|
+
user,
|
|
45
45
|
};
|
|
46
46
|
```
|
|
47
47
|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**uuid** | **string** | UUID of an existing record to link to | [optional] [default to undefined]
|
|
11
11
|
**properties** | **{ [key: string]: any | null; }** | Properties to update on the existing record referenced by uuid before linking | [optional] [default to undefined]
|
|
12
12
|
**edgeProperties** | **{ [key: string]: any | null; }** | Values for properties declared on the relation schema, stored on the relation edge itself (not on either record). Omit to leave existing edge values untouched; a null value clears a key. | [optional] [default to undefined]
|
|
13
|
-
**record** | [**RecordDTO**](RecordDTO.md) | Nested record to create
|
|
13
|
+
**record** | [**RecordDTO**](RecordDTO.md) | Nested record to create or update (by uuid or unique properties) before linking | [optional] [default to undefined]
|
|
14
14
|
**objectName** | **string** | Object name for nested record create when relation allows multiple target types | [optional] [default to undefined]
|
|
15
15
|
**primary** | **boolean** | When true, marks this relation edge as primary | [optional] [default to undefined]
|
|
16
16
|
**merge** | **boolean** | When true, MERGE relation edge instead of CREATE | [optional] [default to undefined]
|
package/docs/WebpagesApi.md
CHANGED
|
@@ -18,11 +18,11 @@ All URIs are relative to *https://v2.api.caraer.com*
|
|
|
18
18
|
|[**getCompanySettings**](#getcompanysettings) | **GET** /api/v2/webpages/public/companySettings | Fetch public company settings|
|
|
19
19
|
|[**getEnvironments**](#getenvironments) | **GET** /api/v2/webpages/environments | Get all environments|
|
|
20
20
|
|[**getMenus**](#getmenus) | **GET** /api/v2/webpages/public/getMenus | Fetch public web menus|
|
|
21
|
-
|[**getPublicCustomFooterModule**](#getpubliccustomfootermodule) | **GET** /api/v2/webpages/public/module/{moduleUuid} | Fetch public custom footer module|
|
|
22
21
|
|[**getPublicPreviews**](#getpublicpreviews) | **POST** /api/v2/webpages/public/previews/{pageUuid}/{componentUuid}/{layout} | Get previews for a public webpage|
|
|
23
22
|
|[**getPublicWebpage**](#getpublicwebpage) | **GET** /api/v2/webpages/public/{rootSlug}/{slug} | Get a public webpage by slug|
|
|
24
23
|
|[**getPublicWebpageByUuid**](#getpublicwebpagebyuuid) | **GET** /api/v2/webpages/public/uuid/{uuid} | Get a public webpage by UUID|
|
|
25
24
|
|[**getPublicWebpageProtection**](#getpublicwebpageprotection) | **GET** /api/v2/webpages/public/uuid/{uuid}/protection | Get webpage protection metadata|
|
|
25
|
+
|[**getPublicWebsiteModule**](#getpublicwebsitemodule) | **GET** /api/v2/webpages/public/module/{moduleUuid} | Fetch public website module|
|
|
26
26
|
|[**getTemplateWebpage**](#gettemplatewebpage) | **GET** /api/v2/webpages/template/{objectName}/{environment} | Get template webpage|
|
|
27
27
|
|[**getTemplateWebpageEditingStatus**](#gettemplatewebpageeditingstatus) | **GET** /api/v2/webpages/template/{objectName}/{environment}/editing-status | Check if a template webpage is being edited|
|
|
28
28
|
|[**getWebpage**](#getwebpage) | **GET** /api/v2/webpages/{uuid} | Get webpage details|
|
|
@@ -819,61 +819,6 @@ const { status, data } = await apiInstance.getMenus(
|
|
|
819
819
|
|
|
820
820
|
[[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)
|
|
821
821
|
|
|
822
|
-
# **getPublicCustomFooterModule**
|
|
823
|
-
> ShowResponse getPublicCustomFooterModule()
|
|
824
|
-
|
|
825
|
-
Returns the PageContent tree for the module configured as custom footer when enabled. Requires X-Caraer-Subdomain; only the UUID configured in website settings is accessible.
|
|
826
|
-
|
|
827
|
-
### Example
|
|
828
|
-
|
|
829
|
-
```typescript
|
|
830
|
-
import {
|
|
831
|
-
WebpagesApi,
|
|
832
|
-
Configuration
|
|
833
|
-
} from '@caraer/client';
|
|
834
|
-
|
|
835
|
-
const configuration = new Configuration();
|
|
836
|
-
const apiInstance = new WebpagesApi(configuration);
|
|
837
|
-
|
|
838
|
-
let xCaraerSubdomain: string; // (default to undefined)
|
|
839
|
-
let moduleUuid: string; // (default to undefined)
|
|
840
|
-
|
|
841
|
-
const { status, data } = await apiInstance.getPublicCustomFooterModule(
|
|
842
|
-
xCaraerSubdomain,
|
|
843
|
-
moduleUuid
|
|
844
|
-
);
|
|
845
|
-
```
|
|
846
|
-
|
|
847
|
-
### Parameters
|
|
848
|
-
|
|
849
|
-
|Name | Type | Description | Notes|
|
|
850
|
-
|------------- | ------------- | ------------- | -------------|
|
|
851
|
-
| **xCaraerSubdomain** | [**string**] | | defaults to undefined|
|
|
852
|
-
| **moduleUuid** | [**string**] | | defaults to undefined|
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
### Return type
|
|
856
|
-
|
|
857
|
-
**ShowResponse**
|
|
858
|
-
|
|
859
|
-
### Authorization
|
|
860
|
-
|
|
861
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
862
|
-
|
|
863
|
-
### HTTP request headers
|
|
864
|
-
|
|
865
|
-
- **Content-Type**: Not defined
|
|
866
|
-
- **Accept**: application/json
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
### HTTP response details
|
|
870
|
-
| Status code | Description | Response headers |
|
|
871
|
-
|-------------|-------------|------------------|
|
|
872
|
-
|**200** | Module retrieved successfully | - |
|
|
873
|
-
|**404** | Module not found or not exposed | - |
|
|
874
|
-
|
|
875
|
-
[[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)
|
|
876
|
-
|
|
877
822
|
# **getPublicPreviews**
|
|
878
823
|
> PaginationResponsePreviewDTO getPublicPreviews()
|
|
879
824
|
|
|
@@ -1161,6 +1106,61 @@ const { status, data } = await apiInstance.getPublicWebpageProtection(
|
|
|
1161
1106
|
|
|
1162
1107
|
[[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)
|
|
1163
1108
|
|
|
1109
|
+
# **getPublicWebsiteModule**
|
|
1110
|
+
> ShowResponse getPublicWebsiteModule()
|
|
1111
|
+
|
|
1112
|
+
Returns the PageContent tree for a module exposed by website settings, such as the custom footer or the cookie banner. Requires X-Caraer-Subdomain; only the UUIDs configured in website settings are accessible.
|
|
1113
|
+
|
|
1114
|
+
### Example
|
|
1115
|
+
|
|
1116
|
+
```typescript
|
|
1117
|
+
import {
|
|
1118
|
+
WebpagesApi,
|
|
1119
|
+
Configuration
|
|
1120
|
+
} from '@caraer/client';
|
|
1121
|
+
|
|
1122
|
+
const configuration = new Configuration();
|
|
1123
|
+
const apiInstance = new WebpagesApi(configuration);
|
|
1124
|
+
|
|
1125
|
+
let xCaraerSubdomain: string; // (default to undefined)
|
|
1126
|
+
let moduleUuid: string; // (default to undefined)
|
|
1127
|
+
|
|
1128
|
+
const { status, data } = await apiInstance.getPublicWebsiteModule(
|
|
1129
|
+
xCaraerSubdomain,
|
|
1130
|
+
moduleUuid
|
|
1131
|
+
);
|
|
1132
|
+
```
|
|
1133
|
+
|
|
1134
|
+
### Parameters
|
|
1135
|
+
|
|
1136
|
+
|Name | Type | Description | Notes|
|
|
1137
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1138
|
+
| **xCaraerSubdomain** | [**string**] | | defaults to undefined|
|
|
1139
|
+
| **moduleUuid** | [**string**] | | defaults to undefined|
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
### Return type
|
|
1143
|
+
|
|
1144
|
+
**ShowResponse**
|
|
1145
|
+
|
|
1146
|
+
### Authorization
|
|
1147
|
+
|
|
1148
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1149
|
+
|
|
1150
|
+
### HTTP request headers
|
|
1151
|
+
|
|
1152
|
+
- **Content-Type**: Not defined
|
|
1153
|
+
- **Accept**: application/json
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
### HTTP response details
|
|
1157
|
+
| Status code | Description | Response headers |
|
|
1158
|
+
|-------------|-------------|------------------|
|
|
1159
|
+
|**200** | Module retrieved successfully | - |
|
|
1160
|
+
|**404** | Module not found or not exposed | - |
|
|
1161
|
+
|
|
1162
|
+
[[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)
|
|
1163
|
+
|
|
1164
1164
|
# **getTemplateWebpage**
|
|
1165
1165
|
> ShowResponse getTemplateWebpage()
|
|
1166
1166
|
|
|
@@ -93,6 +93,8 @@ Name | Type | Description | Notes
|
|
|
93
93
|
**headerTertiaryButtonIconColor** | **string** | | [optional] [default to undefined]
|
|
94
94
|
**cookieText** | **string** | | [optional] [default to undefined]
|
|
95
95
|
**cookieAgreementText** | **string** | | [optional] [default to undefined]
|
|
96
|
+
**cookieBannerEnabled** | **boolean** | | [optional] [default to undefined]
|
|
97
|
+
**cookieBannerModuleUuid** | **string** | | [optional] [default to undefined]
|
|
96
98
|
**cssStyles** | **string** | | [optional] [default to undefined]
|
|
97
99
|
**headJsScript** | **string** | | [optional] [default to undefined]
|
|
98
100
|
**bodyJsScript** | **string** | | [optional] [default to undefined]
|
|
@@ -251,6 +253,8 @@ const instance: WebsiteSettingsDTO = {
|
|
|
251
253
|
headerTertiaryButtonIconColor,
|
|
252
254
|
cookieText,
|
|
253
255
|
cookieAgreementText,
|
|
256
|
+
cookieBannerEnabled,
|
|
257
|
+
cookieBannerModuleUuid,
|
|
254
258
|
cssStyles,
|
|
255
259
|
headJsScript,
|
|
256
260
|
bodyJsScript,
|