@remkoj/optimizely-cms-api 2.0.0-pre3 → 2.0.0-pre5
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/dist/api-client.d.ts +35 -0
- package/dist/api-client.js +67 -0
- package/dist/client/CmsIntegrationApiClient.d.ts +24 -22
- package/dist/client/CmsIntegrationApiClient.js +2 -0
- package/dist/client/core/ApiError.d.ts +10 -10
- package/dist/client/core/ApiRequestOptions.d.ts +13 -13
- package/dist/client/core/ApiResult.d.ts +7 -7
- package/dist/client/core/BaseHttpRequest.d.ts +8 -8
- package/dist/client/core/CancelablePromise.d.ts +20 -20
- package/dist/client/core/FetchHttpRequest.d.ts +14 -14
- package/dist/client/core/OpenAPI.d.ts +16 -16
- package/dist/client/core/request.d.ts +30 -30
- package/dist/client/index.d.ts +81 -76
- package/dist/client/index.js +3 -1
- package/dist/client/models/BinaryProperty.d.ts +8 -8
- package/dist/client/models/BooleanProperty.d.ts +5 -5
- package/dist/client/models/Changeset.d.ts +26 -26
- package/dist/client/models/ChangesetItem.d.ts +11 -11
- package/dist/client/models/ChangesetItemPage.d.ts +19 -19
- package/dist/client/models/ChangesetPage.d.ts +19 -19
- package/dist/client/models/ComponentListItem.d.ts +7 -10
- package/dist/client/models/ComponentProperty.d.ts +7 -10
- package/dist/client/models/ContentBaseType.d.ts +11 -11
- package/dist/client/models/ContentComponent.d.ts +34 -34
- package/dist/client/models/ContentItem.d.ts +60 -60
- package/dist/client/models/ContentItemListWithContentTypes.d.ts +27 -27
- package/dist/client/models/ContentItemPage.d.ts +19 -19
- package/dist/client/models/ContentItemWithContentTypes.d.ts +12 -12
- package/dist/client/models/ContentListItem.d.ts +8 -14
- package/dist/client/models/ContentLocaleInfo.d.ts +19 -11
- package/dist/client/models/ContentMetadata.d.ts +38 -46
- package/dist/client/models/ContentMetadataPage.d.ts +19 -19
- package/dist/client/models/ContentProperty.d.ts +8 -14
- package/dist/client/models/ContentReference.d.ts +17 -17
- package/dist/client/models/ContentReferenceListItem.d.ts +8 -14
- package/dist/client/models/ContentReferenceProperty.d.ts +8 -14
- package/dist/client/models/ContentType.d.ts +79 -79
- package/dist/client/models/ContentTypeFeature.d.ts +10 -10
- package/dist/client/models/ContentTypePage.d.ts +19 -19
- package/dist/client/models/ContentTypeProperty.d.ts +47 -47
- package/dist/client/models/ContentTypeUsage.d.ts +7 -7
- package/dist/client/models/CopyContentOptions.d.ts +21 -21
- package/dist/client/models/DateTimeListItem.d.ts +8 -14
- package/dist/client/models/DateTimeProperty.d.ts +8 -14
- package/dist/client/models/DisplaySetting.d.ts +22 -0
- package/dist/client/models/DisplaySetting.js +2 -0
- package/dist/client/models/DisplaySettingChoice.d.ts +13 -0
- package/dist/client/models/DisplaySettingChoice.js +2 -0
- package/dist/client/models/DisplayTemplate.d.ts +49 -0
- package/dist/client/models/DisplayTemplate.js +2 -0
- package/dist/client/models/DisplayTemplatePage.d.ts +19 -0
- package/dist/client/models/DisplayTemplatePage.js +2 -0
- package/dist/client/models/DoubleEnumerationSettings.d.ts +9 -9
- package/dist/client/models/FloatListItem.d.ts +10 -16
- package/dist/client/models/FloatProperty.d.ts +10 -16
- package/dist/client/models/ImageDescriptor.d.ts +17 -17
- package/dist/client/models/ImportPackageMessage.d.ts +17 -17
- package/dist/client/models/ImportPackageResult.d.ts +22 -22
- package/dist/client/models/IndexingType.d.ts +8 -8
- package/dist/client/models/Int32EnumerationSettings.d.ts +9 -9
- package/dist/client/models/IntegerListItem.d.ts +10 -16
- package/dist/client/models/IntegerProperty.d.ts +10 -16
- package/dist/client/models/JsonStringProperty.d.ts +5 -5
- package/dist/client/models/ListProperty.d.ts +26 -26
- package/dist/client/models/ListPropertyItem.d.ts +11 -11
- package/dist/client/models/LocaleStatus.d.ts +7 -7
- package/dist/client/models/Manifest.d.ts +24 -19
- package/dist/client/models/OauthToken.d.ts +18 -18
- package/dist/client/models/OauthTokenError.d.ts +13 -13
- package/dist/client/models/OauthTokenRequest.d.ts +21 -21
- package/dist/client/models/PackageJob.d.ts +28 -28
- package/dist/client/models/PackageJobMessage.d.ts +17 -17
- package/dist/client/models/PackageJobStatus.d.ts +4 -4
- package/dist/client/models/ProblemDetails.d.ts +1 -1
- package/dist/client/models/PropertyDataType.d.ts +18 -18
- package/dist/client/models/PropertyFormat.d.ts +34 -34
- package/dist/client/models/PropertyFormatPage.d.ts +19 -19
- package/dist/client/models/PropertyGroup.d.ts +21 -21
- package/dist/client/models/PropertyGroupPage.d.ts +19 -19
- package/dist/client/models/StringEnumerationSettings.d.ts +9 -9
- package/dist/client/models/StringListItem.d.ts +11 -14
- package/dist/client/models/StringProperty.d.ts +11 -14
- package/dist/client/models/UrlListItem.d.ts +5 -5
- package/dist/client/models/UrlProperty.d.ts +5 -5
- package/dist/client/models/VersionStatus.d.ts +12 -12
- package/dist/client/services/ChangesetsService.d.ts +105 -105
- package/dist/client/services/ChangesetsService.js +10 -10
- package/dist/client/services/ContentService.d.ts +172 -172
- package/dist/client/services/ContentService.js +14 -14
- package/dist/client/services/ContentTypesService.d.ts +66 -66
- package/dist/client/services/ContentTypesService.js +6 -6
- package/dist/client/services/DisplayTemplatesService.d.ts +60 -0
- package/dist/client/services/DisplayTemplatesService.js +135 -0
- package/dist/client/services/OauthService.d.ts +17 -17
- package/dist/client/services/OauthService.js +1 -1
- package/dist/client/services/PackagesService.d.ts +41 -41
- package/dist/client/services/PackagesService.js +3 -3
- package/dist/client/services/PropertyFormatsService.d.ts +26 -26
- package/dist/client/services/PropertyFormatsService.js +2 -2
- package/dist/client/services/PropertyGroupsService.d.ts +61 -61
- package/dist/client/services/PropertyGroupsService.js +6 -6
- package/dist/config.d.ts +8 -7
- package/dist/config.js +2 -1
- package/dist/getaccesstoken.d.ts +3 -0
- package/dist/getaccesstoken.js +43 -0
- package/dist/index.d.ts +16 -15
- package/dist/index.js +8 -51
- package/dist/types.d.ts +8 -0
- package/dist/types.js +2 -0
- package/dist/version.json +5 -0
- package/package.json +11 -7
|
@@ -33,7 +33,7 @@ class ContentService {
|
|
|
33
33
|
* Get shared metadata about the content instance with the provided key.
|
|
34
34
|
* @param key The key of the content to retrieve metadata for.
|
|
35
35
|
* @param allowDeleted Indicates that metadata for a deleted content may be returned.
|
|
36
|
-
* @returns ContentMetadata
|
|
36
|
+
* @returns ContentMetadata OK
|
|
37
37
|
* @throws ApiError
|
|
38
38
|
*/
|
|
39
39
|
contentGetMetadata(key, allowDeleted) {
|
|
@@ -56,7 +56,7 @@ class ContentService {
|
|
|
56
56
|
* Update an existing content item. If a content item with the provided key does not exist an error is returned.
|
|
57
57
|
* @param key The key of the content item to patch.
|
|
58
58
|
* @param requestBody The values of the content item that should be updated.
|
|
59
|
-
* @returns ContentMetadata
|
|
59
|
+
* @returns ContentMetadata OK
|
|
60
60
|
* @throws ApiError
|
|
61
61
|
*/
|
|
62
62
|
contentPatchMetadata(key, requestBody) {
|
|
@@ -79,7 +79,7 @@ class ContentService {
|
|
|
79
79
|
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
80
80
|
* @param key The key of the content item to delete.
|
|
81
81
|
* @param permanent Indicates that the content item should be permanently deleted immediately or if it should be soft deleted first.
|
|
82
|
-
* @returns ContentMetadata
|
|
82
|
+
* @returns ContentMetadata OK
|
|
83
83
|
* @throws ApiError
|
|
84
84
|
*/
|
|
85
85
|
contentDelete(key, permanent) {
|
|
@@ -104,7 +104,7 @@ class ContentService {
|
|
|
104
104
|
* @param key The key of the content path to retrieve.
|
|
105
105
|
* @param pageIndex
|
|
106
106
|
* @param pageSize
|
|
107
|
-
* @returns ContentMetadataPage
|
|
107
|
+
* @returns ContentMetadataPage OK
|
|
108
108
|
* @throws ApiError
|
|
109
109
|
*/
|
|
110
110
|
contentGetPath(key, pageIndex, pageSize) {
|
|
@@ -130,7 +130,7 @@ class ContentService {
|
|
|
130
130
|
* @param contentTypes Indicates which content types or base types to include in the list.
|
|
131
131
|
* @param pageIndex
|
|
132
132
|
* @param pageSize
|
|
133
|
-
* @returns ContentMetadataPage
|
|
133
|
+
* @returns ContentMetadataPage OK
|
|
134
134
|
* @throws ApiError
|
|
135
135
|
*/
|
|
136
136
|
contentListItems(key, contentTypes, pageIndex, pageSize) {
|
|
@@ -157,7 +157,7 @@ class ContentService {
|
|
|
157
157
|
* @param contentTypes Indicates which content types or base types to include in the list.
|
|
158
158
|
* @param pageIndex
|
|
159
159
|
* @param pageSize
|
|
160
|
-
* @returns ContentMetadataPage
|
|
160
|
+
* @returns ContentMetadataPage OK
|
|
161
161
|
* @throws ApiError
|
|
162
162
|
*/
|
|
163
163
|
contentListAssets(key, contentTypes, pageIndex, pageSize) {
|
|
@@ -182,7 +182,7 @@ class ContentService {
|
|
|
182
182
|
* Create a copy of the content item with the provided key.
|
|
183
183
|
* @param key The key of the content item to copy.
|
|
184
184
|
* @param requestBody Optional instructions for how to copy content.
|
|
185
|
-
* @returns ContentMetadata
|
|
185
|
+
* @returns ContentMetadata OK
|
|
186
186
|
* @throws ApiError
|
|
187
187
|
*/
|
|
188
188
|
contentCopy(key, requestBody) {
|
|
@@ -204,7 +204,7 @@ class ContentService {
|
|
|
204
204
|
* Restore content
|
|
205
205
|
* Restore the deleted content item with the provided key. If a content item with the provided key is not deleted an error is returned.
|
|
206
206
|
* @param key The key of the content item to undelete.
|
|
207
|
-
* @returns ContentMetadata
|
|
207
|
+
* @returns ContentMetadata OK
|
|
208
208
|
* @throws ApiError
|
|
209
209
|
*/
|
|
210
210
|
contentUndelete(key) {
|
|
@@ -228,7 +228,7 @@ class ContentService {
|
|
|
228
228
|
* @param statuses Indicates which status content versions must have to be listed.
|
|
229
229
|
* @param pageIndex
|
|
230
230
|
* @param pageSize
|
|
231
|
-
* @returns ContentItemPage
|
|
231
|
+
* @returns ContentItemPage OK
|
|
232
232
|
* @throws ApiError
|
|
233
233
|
*/
|
|
234
234
|
contentListAllVersions(locales, statuses, pageIndex, pageSize) {
|
|
@@ -255,7 +255,7 @@ class ContentService {
|
|
|
255
255
|
* @param statuses Indicates which status content versions must have to be listed.
|
|
256
256
|
* @param pageIndex
|
|
257
257
|
* @param pageSize
|
|
258
|
-
* @returns ContentItemPage
|
|
258
|
+
* @returns ContentItemPage OK
|
|
259
259
|
* @throws ApiError
|
|
260
260
|
*/
|
|
261
261
|
contentListVersions(key, locales, statuses, pageIndex, pageSize) {
|
|
@@ -308,7 +308,7 @@ class ContentService {
|
|
|
308
308
|
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
309
309
|
* @param key
|
|
310
310
|
* @param locale
|
|
311
|
-
* @returns ContentItem
|
|
311
|
+
* @returns ContentItem OK
|
|
312
312
|
* @throws ApiError
|
|
313
313
|
*/
|
|
314
314
|
contentDeleteLocale(key, locale) {
|
|
@@ -333,7 +333,7 @@ class ContentService {
|
|
|
333
333
|
* @param key
|
|
334
334
|
* @param version
|
|
335
335
|
* @param locale
|
|
336
|
-
* @returns ContentItem
|
|
336
|
+
* @returns ContentItem OK
|
|
337
337
|
* @throws ApiError
|
|
338
338
|
*/
|
|
339
339
|
contentGetVersion(key, version, locale) {
|
|
@@ -360,7 +360,7 @@ class ContentService {
|
|
|
360
360
|
* @param requestBody The content information that should be updated.
|
|
361
361
|
* @param locale The locale of the content that should be updated.
|
|
362
362
|
* @param skipValidation Indicates that the content validation should be ignored.
|
|
363
|
-
* @returns ContentItem
|
|
363
|
+
* @returns ContentItem OK
|
|
364
364
|
* @throws ApiError
|
|
365
365
|
*/
|
|
366
366
|
contentPatchVersion(key, version, requestBody, locale, skipValidation) {
|
|
@@ -388,7 +388,7 @@ class ContentService {
|
|
|
388
388
|
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
389
389
|
* @param key
|
|
390
390
|
* @param version
|
|
391
|
-
* @returns ContentItem
|
|
391
|
+
* @returns ContentItem OK
|
|
392
392
|
* @throws ApiError
|
|
393
393
|
*/
|
|
394
394
|
contentDeleteVersion(key, version) {
|
|
@@ -1,66 +1,66 @@
|
|
|
1
|
-
import type { ContentType } from '../models/ContentType';
|
|
2
|
-
import type { ContentTypePage } from '../models/ContentTypePage';
|
|
3
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
|
-
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
5
|
-
export declare class ContentTypesService {
|
|
6
|
-
readonly httpRequest: BaseHttpRequest;
|
|
7
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
8
|
-
/**
|
|
9
|
-
* List content types
|
|
10
|
-
* List content types using the provided options.
|
|
11
|
-
* @param forContainerType Only include types that are available for creation under the provided container type
|
|
12
|
-
* @param sources Indicates which sources should be included when listing content types.
|
|
13
|
-
* Use All to include content types from all sources or
|
|
14
|
-
* Default to include content types without a specific sources.
|
|
15
|
-
* @param pageIndex
|
|
16
|
-
* @param pageSize
|
|
17
|
-
* @returns ContentTypePage
|
|
18
|
-
* @throws ApiError
|
|
19
|
-
*/
|
|
20
|
-
contentTypesList(forContainerType?: string, sources?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentTypePage>;
|
|
21
|
-
/**
|
|
22
|
-
* Create content type
|
|
23
|
-
* Create a new content type.
|
|
24
|
-
* @param requestBody The content type that should be created.
|
|
25
|
-
* @returns ContentType
|
|
26
|
-
* @throws ApiError
|
|
27
|
-
*/
|
|
28
|
-
contentTypesCreate(requestBody: ContentType): CancelablePromise<ContentType>;
|
|
29
|
-
/**
|
|
30
|
-
* Get content type
|
|
31
|
-
* Get the content type with the provided key.
|
|
32
|
-
* @param key The key of the content type to retrieve.
|
|
33
|
-
* @returns ContentType
|
|
34
|
-
* @throws ApiError
|
|
35
|
-
*/
|
|
36
|
-
contentTypesGet(key: string): CancelablePromise<ContentType>;
|
|
37
|
-
/**
|
|
38
|
-
* Create or replace content type
|
|
39
|
-
* Create or replace a content type. If a content type with the provided key exist it is replaced.
|
|
40
|
-
* Otherwise a new content type is created.
|
|
41
|
-
* @param key The key of the content type to update or create.
|
|
42
|
-
* @param requestBody The values of the created or replaced content type.
|
|
43
|
-
* @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
|
|
44
|
-
* @returns ContentType
|
|
45
|
-
* @throws ApiError
|
|
46
|
-
*/
|
|
47
|
-
contentTypesPut(key: string, requestBody: ContentType, ignoreDataLossWarnings?: boolean): CancelablePromise<ContentType>;
|
|
48
|
-
/**
|
|
49
|
-
* Update content type
|
|
50
|
-
* Update an existing content type. If a content type with the provided key does not exist an error is returned.
|
|
51
|
-
* @param key The key of the content type to patch.
|
|
52
|
-
* @param requestBody The values of the content type that should be updated.
|
|
53
|
-
* @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
|
|
54
|
-
* @returns ContentType
|
|
55
|
-
* @throws ApiError
|
|
56
|
-
*/
|
|
57
|
-
contentTypesPatch(key: string, requestBody: ContentType, ignoreDataLossWarnings?: boolean): CancelablePromise<ContentType>;
|
|
58
|
-
/**
|
|
59
|
-
* Delete content type
|
|
60
|
-
* Deletes the content type with the provided key. If a content type with the provided key does not exist an error is returned.
|
|
61
|
-
* @param key The key of the content type to delete.
|
|
62
|
-
* @returns ContentType
|
|
63
|
-
* @throws ApiError
|
|
64
|
-
*/
|
|
65
|
-
contentTypesDelete(key: string): CancelablePromise<ContentType>;
|
|
66
|
-
}
|
|
1
|
+
import type { ContentType } from '../models/ContentType';
|
|
2
|
+
import type { ContentTypePage } from '../models/ContentTypePage';
|
|
3
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
|
+
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
5
|
+
export declare class ContentTypesService {
|
|
6
|
+
readonly httpRequest: BaseHttpRequest;
|
|
7
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
8
|
+
/**
|
|
9
|
+
* List content types
|
|
10
|
+
* List content types using the provided options.
|
|
11
|
+
* @param forContainerType Only include types that are available for creation under the provided container type
|
|
12
|
+
* @param sources Indicates which sources should be included when listing content types.
|
|
13
|
+
* Use All to include content types from all sources or
|
|
14
|
+
* Default to include content types without a specific sources.
|
|
15
|
+
* @param pageIndex
|
|
16
|
+
* @param pageSize
|
|
17
|
+
* @returns ContentTypePage OK
|
|
18
|
+
* @throws ApiError
|
|
19
|
+
*/
|
|
20
|
+
contentTypesList(forContainerType?: string, sources?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentTypePage>;
|
|
21
|
+
/**
|
|
22
|
+
* Create content type
|
|
23
|
+
* Create a new content type.
|
|
24
|
+
* @param requestBody The content type that should be created.
|
|
25
|
+
* @returns ContentType OK
|
|
26
|
+
* @throws ApiError
|
|
27
|
+
*/
|
|
28
|
+
contentTypesCreate(requestBody: ContentType): CancelablePromise<ContentType>;
|
|
29
|
+
/**
|
|
30
|
+
* Get content type
|
|
31
|
+
* Get the content type with the provided key.
|
|
32
|
+
* @param key The key of the content type to retrieve.
|
|
33
|
+
* @returns ContentType OK
|
|
34
|
+
* @throws ApiError
|
|
35
|
+
*/
|
|
36
|
+
contentTypesGet(key: string): CancelablePromise<ContentType>;
|
|
37
|
+
/**
|
|
38
|
+
* Create or replace content type
|
|
39
|
+
* Create or replace a content type. If a content type with the provided key exist it is replaced.
|
|
40
|
+
* Otherwise a new content type is created.
|
|
41
|
+
* @param key The key of the content type to update or create.
|
|
42
|
+
* @param requestBody The values of the created or replaced content type.
|
|
43
|
+
* @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
|
|
44
|
+
* @returns ContentType OK
|
|
45
|
+
* @throws ApiError
|
|
46
|
+
*/
|
|
47
|
+
contentTypesPut(key: string, requestBody: ContentType, ignoreDataLossWarnings?: boolean): CancelablePromise<ContentType>;
|
|
48
|
+
/**
|
|
49
|
+
* Update content type
|
|
50
|
+
* Update an existing content type. If a content type with the provided key does not exist an error is returned.
|
|
51
|
+
* @param key The key of the content type to patch.
|
|
52
|
+
* @param requestBody The values of the content type that should be updated.
|
|
53
|
+
* @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
|
|
54
|
+
* @returns ContentType OK
|
|
55
|
+
* @throws ApiError
|
|
56
|
+
*/
|
|
57
|
+
contentTypesPatch(key: string, requestBody: ContentType, ignoreDataLossWarnings?: boolean): CancelablePromise<ContentType>;
|
|
58
|
+
/**
|
|
59
|
+
* Delete content type
|
|
60
|
+
* Deletes the content type with the provided key. If a content type with the provided key does not exist an error is returned.
|
|
61
|
+
* @param key The key of the content type to delete.
|
|
62
|
+
* @returns ContentType OK
|
|
63
|
+
* @throws ApiError
|
|
64
|
+
*/
|
|
65
|
+
contentTypesDelete(key: string): CancelablePromise<ContentType>;
|
|
66
|
+
}
|
|
@@ -14,7 +14,7 @@ class ContentTypesService {
|
|
|
14
14
|
* Default to include content types without a specific sources.
|
|
15
15
|
* @param pageIndex
|
|
16
16
|
* @param pageSize
|
|
17
|
-
* @returns ContentTypePage
|
|
17
|
+
* @returns ContentTypePage OK
|
|
18
18
|
* @throws ApiError
|
|
19
19
|
*/
|
|
20
20
|
contentTypesList(forContainerType, sources, pageIndex, pageSize) {
|
|
@@ -36,7 +36,7 @@ class ContentTypesService {
|
|
|
36
36
|
* Create content type
|
|
37
37
|
* Create a new content type.
|
|
38
38
|
* @param requestBody The content type that should be created.
|
|
39
|
-
* @returns ContentType
|
|
39
|
+
* @returns ContentType OK
|
|
40
40
|
* @throws ApiError
|
|
41
41
|
*/
|
|
42
42
|
contentTypesCreate(requestBody) {
|
|
@@ -55,7 +55,7 @@ class ContentTypesService {
|
|
|
55
55
|
* Get content type
|
|
56
56
|
* Get the content type with the provided key.
|
|
57
57
|
* @param key The key of the content type to retrieve.
|
|
58
|
-
* @returns ContentType
|
|
58
|
+
* @returns ContentType OK
|
|
59
59
|
* @throws ApiError
|
|
60
60
|
*/
|
|
61
61
|
contentTypesGet(key) {
|
|
@@ -77,7 +77,7 @@ class ContentTypesService {
|
|
|
77
77
|
* @param key The key of the content type to update or create.
|
|
78
78
|
* @param requestBody The values of the created or replaced content type.
|
|
79
79
|
* @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
|
|
80
|
-
* @returns ContentType
|
|
80
|
+
* @returns ContentType OK
|
|
81
81
|
* @throws ApiError
|
|
82
82
|
*/
|
|
83
83
|
contentTypesPut(key, requestBody, ignoreDataLossWarnings) {
|
|
@@ -104,7 +104,7 @@ class ContentTypesService {
|
|
|
104
104
|
* @param key The key of the content type to patch.
|
|
105
105
|
* @param requestBody The values of the content type that should be updated.
|
|
106
106
|
* @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
|
|
107
|
-
* @returns ContentType
|
|
107
|
+
* @returns ContentType OK
|
|
108
108
|
* @throws ApiError
|
|
109
109
|
*/
|
|
110
110
|
contentTypesPatch(key, requestBody, ignoreDataLossWarnings) {
|
|
@@ -129,7 +129,7 @@ class ContentTypesService {
|
|
|
129
129
|
* Delete content type
|
|
130
130
|
* Deletes the content type with the provided key. If a content type with the provided key does not exist an error is returned.
|
|
131
131
|
* @param key The key of the content type to delete.
|
|
132
|
-
* @returns ContentType
|
|
132
|
+
* @returns ContentType OK
|
|
133
133
|
* @throws ApiError
|
|
134
134
|
*/
|
|
135
135
|
contentTypesDelete(key) {
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import type { DisplayTemplate } from '../models/DisplayTemplate';
|
|
2
|
+
import type { DisplayTemplatePage } from '../models/DisplayTemplatePage';
|
|
3
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
|
+
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
5
|
+
export declare class DisplayTemplatesService {
|
|
6
|
+
readonly httpRequest: BaseHttpRequest;
|
|
7
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
8
|
+
/**
|
|
9
|
+
* List display templates
|
|
10
|
+
* List display templates using the provided options.
|
|
11
|
+
* @param pageIndex
|
|
12
|
+
* @param pageSize
|
|
13
|
+
* @returns DisplayTemplatePage OK
|
|
14
|
+
* @throws ApiError
|
|
15
|
+
*/
|
|
16
|
+
displayTemplatesList(pageIndex?: number, pageSize?: number): CancelablePromise<DisplayTemplatePage>;
|
|
17
|
+
/**
|
|
18
|
+
* Create display template
|
|
19
|
+
* Create a new display template.
|
|
20
|
+
* @param requestBody The display template that should be created.
|
|
21
|
+
* @returns DisplayTemplate OK
|
|
22
|
+
* @throws ApiError
|
|
23
|
+
*/
|
|
24
|
+
displayTemplatesCreate(requestBody: DisplayTemplate): CancelablePromise<DisplayTemplate>;
|
|
25
|
+
/**
|
|
26
|
+
* Get display template
|
|
27
|
+
* Get the display template with the provided key.
|
|
28
|
+
* @param key The key of the display template to retrieve.
|
|
29
|
+
* @returns DisplayTemplate OK
|
|
30
|
+
* @throws ApiError
|
|
31
|
+
*/
|
|
32
|
+
displayTemplatesGet(key: string): CancelablePromise<DisplayTemplate>;
|
|
33
|
+
/**
|
|
34
|
+
* Create or replace a display template
|
|
35
|
+
* Create or replace a display template. If a display template with the provided key exist it is replaced.
|
|
36
|
+
* Otherwise a new display template is created.
|
|
37
|
+
* @param key The key of the display template to update or create.
|
|
38
|
+
* @param requestBody The values of the created or replaced display template.
|
|
39
|
+
* @returns DisplayTemplate OK
|
|
40
|
+
* @throws ApiError
|
|
41
|
+
*/
|
|
42
|
+
displayTemplatesPut(key: string, requestBody: DisplayTemplate): CancelablePromise<DisplayTemplate>;
|
|
43
|
+
/**
|
|
44
|
+
* Update display template
|
|
45
|
+
* Update an existing display template.
|
|
46
|
+
* @param key The key of the display template to patch.
|
|
47
|
+
* @param requestBody The values of the display template that should be updated.
|
|
48
|
+
* @returns DisplayTemplate OK
|
|
49
|
+
* @throws ApiError
|
|
50
|
+
*/
|
|
51
|
+
displayTemplatesPatch(key: string, requestBody: DisplayTemplate): CancelablePromise<DisplayTemplate>;
|
|
52
|
+
/**
|
|
53
|
+
* Delete display template
|
|
54
|
+
* Deletes the display template with the provided key.
|
|
55
|
+
* @param key The key of the display template to delete.
|
|
56
|
+
* @returns DisplayTemplate OK
|
|
57
|
+
* @throws ApiError
|
|
58
|
+
*/
|
|
59
|
+
displayTemplatesDelete(key: string): CancelablePromise<DisplayTemplate>;
|
|
60
|
+
}
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DisplayTemplatesService = void 0;
|
|
4
|
+
class DisplayTemplatesService {
|
|
5
|
+
constructor(httpRequest) {
|
|
6
|
+
this.httpRequest = httpRequest;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* List display templates
|
|
10
|
+
* List display templates using the provided options.
|
|
11
|
+
* @param pageIndex
|
|
12
|
+
* @param pageSize
|
|
13
|
+
* @returns DisplayTemplatePage OK
|
|
14
|
+
* @throws ApiError
|
|
15
|
+
*/
|
|
16
|
+
displayTemplatesList(pageIndex, pageSize) {
|
|
17
|
+
return this.httpRequest.request({
|
|
18
|
+
method: 'GET',
|
|
19
|
+
url: '/displaytemplates',
|
|
20
|
+
query: {
|
|
21
|
+
'pageIndex': pageIndex,
|
|
22
|
+
'pageSize': pageSize,
|
|
23
|
+
},
|
|
24
|
+
errors: {
|
|
25
|
+
403: `Forbidden`,
|
|
26
|
+
},
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Create display template
|
|
31
|
+
* Create a new display template.
|
|
32
|
+
* @param requestBody The display template that should be created.
|
|
33
|
+
* @returns DisplayTemplate OK
|
|
34
|
+
* @throws ApiError
|
|
35
|
+
*/
|
|
36
|
+
displayTemplatesCreate(requestBody) {
|
|
37
|
+
return this.httpRequest.request({
|
|
38
|
+
method: 'POST',
|
|
39
|
+
url: '/displaytemplates',
|
|
40
|
+
body: requestBody,
|
|
41
|
+
mediaType: 'application/json',
|
|
42
|
+
errors: {
|
|
43
|
+
400: `Bad Request`,
|
|
44
|
+
403: `Forbidden`,
|
|
45
|
+
},
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Get display template
|
|
50
|
+
* Get the display template with the provided key.
|
|
51
|
+
* @param key The key of the display template to retrieve.
|
|
52
|
+
* @returns DisplayTemplate OK
|
|
53
|
+
* @throws ApiError
|
|
54
|
+
*/
|
|
55
|
+
displayTemplatesGet(key) {
|
|
56
|
+
return this.httpRequest.request({
|
|
57
|
+
method: 'GET',
|
|
58
|
+
url: '/displaytemplates/{key}',
|
|
59
|
+
path: {
|
|
60
|
+
'key': key,
|
|
61
|
+
},
|
|
62
|
+
errors: {
|
|
63
|
+
403: `Forbidden`,
|
|
64
|
+
},
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Create or replace a display template
|
|
69
|
+
* Create or replace a display template. If a display template with the provided key exist it is replaced.
|
|
70
|
+
* Otherwise a new display template is created.
|
|
71
|
+
* @param key The key of the display template to update or create.
|
|
72
|
+
* @param requestBody The values of the created or replaced display template.
|
|
73
|
+
* @returns DisplayTemplate OK
|
|
74
|
+
* @throws ApiError
|
|
75
|
+
*/
|
|
76
|
+
displayTemplatesPut(key, requestBody) {
|
|
77
|
+
return this.httpRequest.request({
|
|
78
|
+
method: 'PUT',
|
|
79
|
+
url: '/displaytemplates/{key}',
|
|
80
|
+
path: {
|
|
81
|
+
'key': key,
|
|
82
|
+
},
|
|
83
|
+
body: requestBody,
|
|
84
|
+
mediaType: 'application/json',
|
|
85
|
+
errors: {
|
|
86
|
+
400: `Bad Request`,
|
|
87
|
+
403: `Forbidden`,
|
|
88
|
+
},
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Update display template
|
|
93
|
+
* Update an existing display template.
|
|
94
|
+
* @param key The key of the display template to patch.
|
|
95
|
+
* @param requestBody The values of the display template that should be updated.
|
|
96
|
+
* @returns DisplayTemplate OK
|
|
97
|
+
* @throws ApiError
|
|
98
|
+
*/
|
|
99
|
+
displayTemplatesPatch(key, requestBody) {
|
|
100
|
+
return this.httpRequest.request({
|
|
101
|
+
method: 'PATCH',
|
|
102
|
+
url: '/displaytemplates/{key}',
|
|
103
|
+
path: {
|
|
104
|
+
'key': key,
|
|
105
|
+
},
|
|
106
|
+
body: requestBody,
|
|
107
|
+
mediaType: 'application/merge-patch+json',
|
|
108
|
+
errors: {
|
|
109
|
+
400: `Bad Request`,
|
|
110
|
+
403: `Forbidden`,
|
|
111
|
+
},
|
|
112
|
+
});
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* Delete display template
|
|
116
|
+
* Deletes the display template with the provided key.
|
|
117
|
+
* @param key The key of the display template to delete.
|
|
118
|
+
* @returns DisplayTemplate OK
|
|
119
|
+
* @throws ApiError
|
|
120
|
+
*/
|
|
121
|
+
displayTemplatesDelete(key) {
|
|
122
|
+
return this.httpRequest.request({
|
|
123
|
+
method: 'DELETE',
|
|
124
|
+
url: '/displaytemplates/{key}',
|
|
125
|
+
path: {
|
|
126
|
+
'key': key,
|
|
127
|
+
},
|
|
128
|
+
errors: {
|
|
129
|
+
400: `Bad Request`,
|
|
130
|
+
403: `Forbidden`,
|
|
131
|
+
},
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
exports.DisplayTemplatesService = DisplayTemplatesService;
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
import type { OauthToken } from '../models/OauthToken';
|
|
2
|
-
import type { OauthTokenRequest } from '../models/OauthTokenRequest';
|
|
3
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
|
-
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
5
|
-
export declare class OauthService {
|
|
6
|
-
readonly httpRequest: BaseHttpRequest;
|
|
7
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
8
|
-
/**
|
|
9
|
-
* Request access token
|
|
10
|
-
* Request an access token. This endpoint only supports the 'client_credentials' grant type
|
|
11
|
-
* and will only issue short-lived tokens.
|
|
12
|
-
* @param requestBody
|
|
13
|
-
* @returns OauthToken
|
|
14
|
-
* @throws ApiError
|
|
15
|
-
*/
|
|
16
|
-
oauthToken(requestBody: OauthTokenRequest): CancelablePromise<OauthToken>;
|
|
17
|
-
}
|
|
1
|
+
import type { OauthToken } from '../models/OauthToken';
|
|
2
|
+
import type { OauthTokenRequest } from '../models/OauthTokenRequest';
|
|
3
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
|
+
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
5
|
+
export declare class OauthService {
|
|
6
|
+
readonly httpRequest: BaseHttpRequest;
|
|
7
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
8
|
+
/**
|
|
9
|
+
* Request access token
|
|
10
|
+
* Request an access token. This endpoint only supports the 'client_credentials' grant type
|
|
11
|
+
* and will only issue short-lived tokens.
|
|
12
|
+
* @param requestBody
|
|
13
|
+
* @returns OauthToken OK
|
|
14
|
+
* @throws ApiError
|
|
15
|
+
*/
|
|
16
|
+
oauthToken(requestBody: OauthTokenRequest): CancelablePromise<OauthToken>;
|
|
17
|
+
}
|
|
@@ -10,7 +10,7 @@ class OauthService {
|
|
|
10
10
|
* Request an access token. This endpoint only supports the 'client_credentials' grant type
|
|
11
11
|
* and will only issue short-lived tokens.
|
|
12
12
|
* @param requestBody
|
|
13
|
-
* @returns OauthToken
|
|
13
|
+
* @returns OauthToken OK
|
|
14
14
|
* @throws ApiError
|
|
15
15
|
*/
|
|
16
16
|
oauthToken(requestBody) {
|
|
@@ -1,41 +1,41 @@
|
|
|
1
|
-
import type { ImportPackageResult } from '../models/ImportPackageResult';
|
|
2
|
-
import type { Manifest } from '../models/Manifest';
|
|
3
|
-
import type { PackageJob } from '../models/PackageJob';
|
|
4
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
5
|
-
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
6
|
-
export declare class PackagesService {
|
|
7
|
-
readonly httpRequest: BaseHttpRequest;
|
|
8
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
9
|
-
/**
|
|
10
|
-
* Get job status
|
|
11
|
-
* Get a package job status.
|
|
12
|
-
* @param key The key of the package job.
|
|
13
|
-
* @returns PackageJob
|
|
14
|
-
* @throws ApiError
|
|
15
|
-
*/
|
|
16
|
-
packagesGet(key: string): CancelablePromise<PackageJob>;
|
|
17
|
-
/**
|
|
18
|
-
* Export package
|
|
19
|
-
* Export a data package.
|
|
20
|
-
* @param includeReadOnly Indicates if read-only resources should be included in the export data.
|
|
21
|
-
* @returns Manifest
|
|
22
|
-
* @throws ApiError
|
|
23
|
-
*/
|
|
24
|
-
packagesExport(includeReadOnly?: boolean): CancelablePromise<Manifest>;
|
|
25
|
-
/**
|
|
26
|
-
* Import package
|
|
27
|
-
* Import a data package.
|
|
28
|
-
* @param container The key of the container content where new content items should be created under.
|
|
29
|
-
* @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
|
|
30
|
-
* content item with the same key.
|
|
31
|
-
* If set to `false`, always create new content item under the specified container regardless of the content key.
|
|
32
|
-
* @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
|
|
33
|
-
* @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
|
|
34
|
-
* then content in all locales are imported.
|
|
35
|
-
* @param requestBody
|
|
36
|
-
* @returns ImportPackageResult
|
|
37
|
-
* @returns PackageJob Accepted
|
|
38
|
-
* @throws ApiError
|
|
39
|
-
*/
|
|
40
|
-
packagesImport(container?: string, overwriteExistingContentItems?: boolean, ignoreDataLossWarnings?: boolean, locale?: string, requestBody?: Blob): CancelablePromise<ImportPackageResult | PackageJob>;
|
|
41
|
-
}
|
|
1
|
+
import type { ImportPackageResult } from '../models/ImportPackageResult';
|
|
2
|
+
import type { Manifest } from '../models/Manifest';
|
|
3
|
+
import type { PackageJob } from '../models/PackageJob';
|
|
4
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
5
|
+
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
6
|
+
export declare class PackagesService {
|
|
7
|
+
readonly httpRequest: BaseHttpRequest;
|
|
8
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
9
|
+
/**
|
|
10
|
+
* Get job status
|
|
11
|
+
* Get a package job status.
|
|
12
|
+
* @param key The key of the package job.
|
|
13
|
+
* @returns PackageJob OK
|
|
14
|
+
* @throws ApiError
|
|
15
|
+
*/
|
|
16
|
+
packagesGet(key: string): CancelablePromise<PackageJob>;
|
|
17
|
+
/**
|
|
18
|
+
* Export package
|
|
19
|
+
* Export a data package.
|
|
20
|
+
* @param includeReadOnly Indicates if read-only resources should be included in the export data.
|
|
21
|
+
* @returns Manifest OK
|
|
22
|
+
* @throws ApiError
|
|
23
|
+
*/
|
|
24
|
+
packagesExport(includeReadOnly?: boolean): CancelablePromise<Manifest>;
|
|
25
|
+
/**
|
|
26
|
+
* Import package
|
|
27
|
+
* Import a data package.
|
|
28
|
+
* @param container The key of the container content where new content items should be created under.
|
|
29
|
+
* @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
|
|
30
|
+
* content item with the same key.
|
|
31
|
+
* If set to `false`, always create new content item under the specified container regardless of the content key.
|
|
32
|
+
* @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
|
|
33
|
+
* @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
|
|
34
|
+
* then content in all locales are imported.
|
|
35
|
+
* @param requestBody
|
|
36
|
+
* @returns ImportPackageResult OK
|
|
37
|
+
* @returns PackageJob Accepted
|
|
38
|
+
* @throws ApiError
|
|
39
|
+
*/
|
|
40
|
+
packagesImport(container?: string, overwriteExistingContentItems?: boolean, ignoreDataLossWarnings?: boolean, locale?: string, requestBody?: Blob): CancelablePromise<ImportPackageResult | PackageJob>;
|
|
41
|
+
}
|
|
@@ -9,7 +9,7 @@ class PackagesService {
|
|
|
9
9
|
* Get job status
|
|
10
10
|
* Get a package job status.
|
|
11
11
|
* @param key The key of the package job.
|
|
12
|
-
* @returns PackageJob
|
|
12
|
+
* @returns PackageJob OK
|
|
13
13
|
* @throws ApiError
|
|
14
14
|
*/
|
|
15
15
|
packagesGet(key) {
|
|
@@ -28,7 +28,7 @@ class PackagesService {
|
|
|
28
28
|
* Export package
|
|
29
29
|
* Export a data package.
|
|
30
30
|
* @param includeReadOnly Indicates if read-only resources should be included in the export data.
|
|
31
|
-
* @returns Manifest
|
|
31
|
+
* @returns Manifest OK
|
|
32
32
|
* @throws ApiError
|
|
33
33
|
*/
|
|
34
34
|
packagesExport(includeReadOnly) {
|
|
@@ -54,7 +54,7 @@ class PackagesService {
|
|
|
54
54
|
* @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
|
|
55
55
|
* then content in all locales are imported.
|
|
56
56
|
* @param requestBody
|
|
57
|
-
* @returns ImportPackageResult
|
|
57
|
+
* @returns ImportPackageResult OK
|
|
58
58
|
* @returns PackageJob Accepted
|
|
59
59
|
* @throws ApiError
|
|
60
60
|
*/
|