@remkoj/optimizely-cms-api 2.0.0-pre2 → 2.0.0-pre3
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/client/CmsIntegrationApiClient.d.ts +22 -22
- 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 +76 -76
- 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 +10 -10
- package/dist/client/models/ComponentProperty.d.ts +10 -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 +14 -14
- package/dist/client/models/ContentLocaleInfo.d.ts +11 -11
- package/dist/client/models/ContentMetadata.d.ts +46 -46
- package/dist/client/models/ContentMetadataPage.d.ts +19 -19
- package/dist/client/models/ContentProperty.d.ts +14 -14
- package/dist/client/models/ContentReference.d.ts +17 -17
- package/dist/client/models/ContentReferenceListItem.d.ts +14 -14
- package/dist/client/models/ContentReferenceProperty.d.ts +14 -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 +14 -14
- package/dist/client/models/DateTimeProperty.d.ts +14 -14
- package/dist/client/models/DoubleEnumerationSettings.d.ts +9 -9
- package/dist/client/models/FloatListItem.d.ts +16 -16
- package/dist/client/models/FloatProperty.d.ts +16 -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 +16 -16
- package/dist/client/models/IntegerProperty.d.ts +16 -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 +19 -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 +14 -14
- package/dist/client/models/StringProperty.d.ts +14 -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/ContentService.d.ts +172 -172
- package/dist/client/services/ContentTypesService.d.ts +66 -66
- package/dist/client/services/OauthService.d.ts +17 -17
- package/dist/client/services/PackagesService.d.ts +41 -41
- package/dist/client/services/PropertyFormatsService.d.ts +26 -26
- package/dist/client/services/PropertyGroupsService.d.ts +61 -61
- package/dist/config.d.ts +7 -8
- package/dist/config.js +6 -3
- package/dist/index.d.ts +15 -15
- package/package.json +4 -3
|
@@ -1,172 +1,172 @@
|
|
|
1
|
-
import type { ContentItem } from '../models/ContentItem';
|
|
2
|
-
import type { ContentItemPage } from '../models/ContentItemPage';
|
|
3
|
-
import type { ContentMetadata } from '../models/ContentMetadata';
|
|
4
|
-
import type { ContentMetadataPage } from '../models/ContentMetadataPage';
|
|
5
|
-
import type { CopyContentOptions } from '../models/CopyContentOptions';
|
|
6
|
-
import type { VersionStatus } from '../models/VersionStatus';
|
|
7
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
8
|
-
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
9
|
-
export declare class ContentService {
|
|
10
|
-
readonly httpRequest: BaseHttpRequest;
|
|
11
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
12
|
-
/**
|
|
13
|
-
* Create content
|
|
14
|
-
* Create a new content item.
|
|
15
|
-
* @param requestBody The content item that should be created.
|
|
16
|
-
* @param skipValidation Indicates that the content validation should be ignored.
|
|
17
|
-
* @returns ContentItem Created
|
|
18
|
-
* @throws ApiError
|
|
19
|
-
*/
|
|
20
|
-
contentCreate(requestBody: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
|
|
21
|
-
/**
|
|
22
|
-
* Get content
|
|
23
|
-
* Get shared metadata about the content instance with the provided key.
|
|
24
|
-
* @param key The key of the content to retrieve metadata for.
|
|
25
|
-
* @param allowDeleted Indicates that metadata for a deleted content may be returned.
|
|
26
|
-
* @returns ContentMetadata Success
|
|
27
|
-
* @throws ApiError
|
|
28
|
-
*/
|
|
29
|
-
contentGetMetadata(key: string, allowDeleted?: boolean): CancelablePromise<ContentMetadata>;
|
|
30
|
-
/**
|
|
31
|
-
* Update content
|
|
32
|
-
* Update an existing content item. If a content item with the provided key does not exist an error is returned.
|
|
33
|
-
* @param key The key of the content item to patch.
|
|
34
|
-
* @param requestBody The values of the content item that should be updated.
|
|
35
|
-
* @returns ContentMetadata Success
|
|
36
|
-
* @throws ApiError
|
|
37
|
-
*/
|
|
38
|
-
contentPatchMetadata(key: string, requestBody: ContentMetadata): CancelablePromise<ContentMetadata>;
|
|
39
|
-
/**
|
|
40
|
-
* Delete content
|
|
41
|
-
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
42
|
-
* @param key The key of the content item to delete.
|
|
43
|
-
* @param permanent Indicates that the content item should be permanently deleted immediately or if it should be soft deleted first.
|
|
44
|
-
* @returns ContentMetadata Success
|
|
45
|
-
* @throws ApiError
|
|
46
|
-
*/
|
|
47
|
-
contentDelete(key: string, permanent?: boolean): CancelablePromise<ContentMetadata>;
|
|
48
|
-
/**
|
|
49
|
-
* Get content path
|
|
50
|
-
* Get the content path with the provided key.
|
|
51
|
-
* @param key The key of the content path to retrieve.
|
|
52
|
-
* @param pageIndex
|
|
53
|
-
* @param pageSize
|
|
54
|
-
* @returns ContentMetadataPage Success
|
|
55
|
-
* @throws ApiError
|
|
56
|
-
*/
|
|
57
|
-
contentGetPath(key: string, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
|
|
58
|
-
/**
|
|
59
|
-
* List content in container
|
|
60
|
-
* List the content items located in a specific container.
|
|
61
|
-
* @param key The key of the content to retrieve items for.
|
|
62
|
-
* @param contentTypes Indicates which content types or base types to include in the list.
|
|
63
|
-
* @param pageIndex
|
|
64
|
-
* @param pageSize
|
|
65
|
-
* @returns ContentMetadataPage Success
|
|
66
|
-
* @throws ApiError
|
|
67
|
-
*/
|
|
68
|
-
contentListItems(key: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
|
|
69
|
-
/**
|
|
70
|
-
* List assets
|
|
71
|
-
* List the assets that belongs to a content instance.
|
|
72
|
-
* @param key The key of the content to retrieve assets for.
|
|
73
|
-
* @param contentTypes Indicates which content types or base types to include in the list.
|
|
74
|
-
* @param pageIndex
|
|
75
|
-
* @param pageSize
|
|
76
|
-
* @returns ContentMetadataPage Success
|
|
77
|
-
* @throws ApiError
|
|
78
|
-
*/
|
|
79
|
-
contentListAssets(key: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
|
|
80
|
-
/**
|
|
81
|
-
* Copy content
|
|
82
|
-
* Create a copy of the content item with the provided key.
|
|
83
|
-
* @param key The key of the content item to copy.
|
|
84
|
-
* @param requestBody Optional instructions for how to copy content.
|
|
85
|
-
* @returns ContentMetadata Success
|
|
86
|
-
* @throws ApiError
|
|
87
|
-
*/
|
|
88
|
-
contentCopy(key: string, requestBody?: CopyContentOptions): CancelablePromise<ContentMetadata>;
|
|
89
|
-
/**
|
|
90
|
-
* Restore content
|
|
91
|
-
* Restore the deleted content item with the provided key. If a content item with the provided key is not deleted an error is returned.
|
|
92
|
-
* @param key The key of the content item to undelete.
|
|
93
|
-
* @returns ContentMetadata Success
|
|
94
|
-
* @throws ApiError
|
|
95
|
-
*/
|
|
96
|
-
contentUndelete(key: string): CancelablePromise<ContentMetadata>;
|
|
97
|
-
/**
|
|
98
|
-
* Query versions
|
|
99
|
-
* List content versions based on the provided query options.
|
|
100
|
-
* @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
|
|
101
|
-
* Locale must be a valid IETF BCP-47 language tag.
|
|
102
|
-
* @param statuses Indicates which status content versions must have to be listed.
|
|
103
|
-
* @param pageIndex
|
|
104
|
-
* @param pageSize
|
|
105
|
-
* @returns ContentItemPage Success
|
|
106
|
-
* @throws ApiError
|
|
107
|
-
*/
|
|
108
|
-
contentListAllVersions(locales?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
|
|
109
|
-
/**
|
|
110
|
-
* List versions
|
|
111
|
-
* List versions of the content item with the provided key and the provided options.
|
|
112
|
-
* @param key
|
|
113
|
-
* @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
|
|
114
|
-
* Locale must be a valid IETF BCP-47 language tag.
|
|
115
|
-
* @param statuses Indicates which status content versions must have to be listed.
|
|
116
|
-
* @param pageIndex
|
|
117
|
-
* @param pageSize
|
|
118
|
-
* @returns ContentItemPage Success
|
|
119
|
-
* @throws ApiError
|
|
120
|
-
*/
|
|
121
|
-
contentListVersions(key: string, locales?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
|
|
122
|
-
/**
|
|
123
|
-
* Create version
|
|
124
|
-
* Create a new version of a content item.
|
|
125
|
-
* @param key The key of the content item for which a new content version should be created.
|
|
126
|
-
* @param requestBody The content version that should be created.
|
|
127
|
-
* @param skipValidation Indicates that the content validation should be ignored.
|
|
128
|
-
* @returns ContentItem Created
|
|
129
|
-
* @throws ApiError
|
|
130
|
-
*/
|
|
131
|
-
contentCreateVersion(key: string, requestBody: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
|
|
132
|
-
/**
|
|
133
|
-
* Delete locale
|
|
134
|
-
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
135
|
-
* @param key
|
|
136
|
-
* @param locale
|
|
137
|
-
* @returns ContentItem Success
|
|
138
|
-
* @throws ApiError
|
|
139
|
-
*/
|
|
140
|
-
contentDeleteLocale(key: string, locale?: string): CancelablePromise<ContentItem>;
|
|
141
|
-
/**
|
|
142
|
-
* Get version
|
|
143
|
-
* Get the content item with the provided key and version.
|
|
144
|
-
* @param key
|
|
145
|
-
* @param version
|
|
146
|
-
* @param locale
|
|
147
|
-
* @returns ContentItem Success
|
|
148
|
-
* @throws ApiError
|
|
149
|
-
*/
|
|
150
|
-
contentGetVersion(key: string, version: string, locale?: string): CancelablePromise<ContentItem>;
|
|
151
|
-
/**
|
|
152
|
-
* Update version
|
|
153
|
-
* Update an existing content item. If a content item with the provided key does not exist an error is returned.
|
|
154
|
-
* @param key The key of the content item that should be updated.
|
|
155
|
-
* @param version The version of the content that should be updated.
|
|
156
|
-
* @param requestBody The content information that should be updated.
|
|
157
|
-
* @param locale The locale of the content that should be updated.
|
|
158
|
-
* @param skipValidation Indicates that the content validation should be ignored.
|
|
159
|
-
* @returns ContentItem Success
|
|
160
|
-
* @throws ApiError
|
|
161
|
-
*/
|
|
162
|
-
contentPatchVersion(key: string, version: string, requestBody: ContentItem, locale?: string, skipValidation?: boolean): CancelablePromise<ContentItem>;
|
|
163
|
-
/**
|
|
164
|
-
* Delete version
|
|
165
|
-
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
166
|
-
* @param key
|
|
167
|
-
* @param version
|
|
168
|
-
* @returns ContentItem Success
|
|
169
|
-
* @throws ApiError
|
|
170
|
-
*/
|
|
171
|
-
contentDeleteVersion(key: string, version: string): CancelablePromise<ContentItem>;
|
|
172
|
-
}
|
|
1
|
+
import type { ContentItem } from '../models/ContentItem';
|
|
2
|
+
import type { ContentItemPage } from '../models/ContentItemPage';
|
|
3
|
+
import type { ContentMetadata } from '../models/ContentMetadata';
|
|
4
|
+
import type { ContentMetadataPage } from '../models/ContentMetadataPage';
|
|
5
|
+
import type { CopyContentOptions } from '../models/CopyContentOptions';
|
|
6
|
+
import type { VersionStatus } from '../models/VersionStatus';
|
|
7
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
8
|
+
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
9
|
+
export declare class ContentService {
|
|
10
|
+
readonly httpRequest: BaseHttpRequest;
|
|
11
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
12
|
+
/**
|
|
13
|
+
* Create content
|
|
14
|
+
* Create a new content item.
|
|
15
|
+
* @param requestBody The content item that should be created.
|
|
16
|
+
* @param skipValidation Indicates that the content validation should be ignored.
|
|
17
|
+
* @returns ContentItem Created
|
|
18
|
+
* @throws ApiError
|
|
19
|
+
*/
|
|
20
|
+
contentCreate(requestBody: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
|
|
21
|
+
/**
|
|
22
|
+
* Get content
|
|
23
|
+
* Get shared metadata about the content instance with the provided key.
|
|
24
|
+
* @param key The key of the content to retrieve metadata for.
|
|
25
|
+
* @param allowDeleted Indicates that metadata for a deleted content may be returned.
|
|
26
|
+
* @returns ContentMetadata Success
|
|
27
|
+
* @throws ApiError
|
|
28
|
+
*/
|
|
29
|
+
contentGetMetadata(key: string, allowDeleted?: boolean): CancelablePromise<ContentMetadata>;
|
|
30
|
+
/**
|
|
31
|
+
* Update content
|
|
32
|
+
* Update an existing content item. If a content item with the provided key does not exist an error is returned.
|
|
33
|
+
* @param key The key of the content item to patch.
|
|
34
|
+
* @param requestBody The values of the content item that should be updated.
|
|
35
|
+
* @returns ContentMetadata Success
|
|
36
|
+
* @throws ApiError
|
|
37
|
+
*/
|
|
38
|
+
contentPatchMetadata(key: string, requestBody: ContentMetadata): CancelablePromise<ContentMetadata>;
|
|
39
|
+
/**
|
|
40
|
+
* Delete content
|
|
41
|
+
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
42
|
+
* @param key The key of the content item to delete.
|
|
43
|
+
* @param permanent Indicates that the content item should be permanently deleted immediately or if it should be soft deleted first.
|
|
44
|
+
* @returns ContentMetadata Success
|
|
45
|
+
* @throws ApiError
|
|
46
|
+
*/
|
|
47
|
+
contentDelete(key: string, permanent?: boolean): CancelablePromise<ContentMetadata>;
|
|
48
|
+
/**
|
|
49
|
+
* Get content path
|
|
50
|
+
* Get the content path with the provided key.
|
|
51
|
+
* @param key The key of the content path to retrieve.
|
|
52
|
+
* @param pageIndex
|
|
53
|
+
* @param pageSize
|
|
54
|
+
* @returns ContentMetadataPage Success
|
|
55
|
+
* @throws ApiError
|
|
56
|
+
*/
|
|
57
|
+
contentGetPath(key: string, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
|
|
58
|
+
/**
|
|
59
|
+
* List content in container
|
|
60
|
+
* List the content items located in a specific container.
|
|
61
|
+
* @param key The key of the content to retrieve items for.
|
|
62
|
+
* @param contentTypes Indicates which content types or base types to include in the list.
|
|
63
|
+
* @param pageIndex
|
|
64
|
+
* @param pageSize
|
|
65
|
+
* @returns ContentMetadataPage Success
|
|
66
|
+
* @throws ApiError
|
|
67
|
+
*/
|
|
68
|
+
contentListItems(key: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
|
|
69
|
+
/**
|
|
70
|
+
* List assets
|
|
71
|
+
* List the assets that belongs to a content instance.
|
|
72
|
+
* @param key The key of the content to retrieve assets for.
|
|
73
|
+
* @param contentTypes Indicates which content types or base types to include in the list.
|
|
74
|
+
* @param pageIndex
|
|
75
|
+
* @param pageSize
|
|
76
|
+
* @returns ContentMetadataPage Success
|
|
77
|
+
* @throws ApiError
|
|
78
|
+
*/
|
|
79
|
+
contentListAssets(key: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
|
|
80
|
+
/**
|
|
81
|
+
* Copy content
|
|
82
|
+
* Create a copy of the content item with the provided key.
|
|
83
|
+
* @param key The key of the content item to copy.
|
|
84
|
+
* @param requestBody Optional instructions for how to copy content.
|
|
85
|
+
* @returns ContentMetadata Success
|
|
86
|
+
* @throws ApiError
|
|
87
|
+
*/
|
|
88
|
+
contentCopy(key: string, requestBody?: CopyContentOptions): CancelablePromise<ContentMetadata>;
|
|
89
|
+
/**
|
|
90
|
+
* Restore content
|
|
91
|
+
* Restore the deleted content item with the provided key. If a content item with the provided key is not deleted an error is returned.
|
|
92
|
+
* @param key The key of the content item to undelete.
|
|
93
|
+
* @returns ContentMetadata Success
|
|
94
|
+
* @throws ApiError
|
|
95
|
+
*/
|
|
96
|
+
contentUndelete(key: string): CancelablePromise<ContentMetadata>;
|
|
97
|
+
/**
|
|
98
|
+
* Query versions
|
|
99
|
+
* List content versions based on the provided query options.
|
|
100
|
+
* @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
|
|
101
|
+
* Locale must be a valid IETF BCP-47 language tag.
|
|
102
|
+
* @param statuses Indicates which status content versions must have to be listed.
|
|
103
|
+
* @param pageIndex
|
|
104
|
+
* @param pageSize
|
|
105
|
+
* @returns ContentItemPage Success
|
|
106
|
+
* @throws ApiError
|
|
107
|
+
*/
|
|
108
|
+
contentListAllVersions(locales?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
|
|
109
|
+
/**
|
|
110
|
+
* List versions
|
|
111
|
+
* List versions of the content item with the provided key and the provided options.
|
|
112
|
+
* @param key
|
|
113
|
+
* @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
|
|
114
|
+
* Locale must be a valid IETF BCP-47 language tag.
|
|
115
|
+
* @param statuses Indicates which status content versions must have to be listed.
|
|
116
|
+
* @param pageIndex
|
|
117
|
+
* @param pageSize
|
|
118
|
+
* @returns ContentItemPage Success
|
|
119
|
+
* @throws ApiError
|
|
120
|
+
*/
|
|
121
|
+
contentListVersions(key: string, locales?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
|
|
122
|
+
/**
|
|
123
|
+
* Create version
|
|
124
|
+
* Create a new version of a content item.
|
|
125
|
+
* @param key The key of the content item for which a new content version should be created.
|
|
126
|
+
* @param requestBody The content version that should be created.
|
|
127
|
+
* @param skipValidation Indicates that the content validation should be ignored.
|
|
128
|
+
* @returns ContentItem Created
|
|
129
|
+
* @throws ApiError
|
|
130
|
+
*/
|
|
131
|
+
contentCreateVersion(key: string, requestBody: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
|
|
132
|
+
/**
|
|
133
|
+
* Delete locale
|
|
134
|
+
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
135
|
+
* @param key
|
|
136
|
+
* @param locale
|
|
137
|
+
* @returns ContentItem Success
|
|
138
|
+
* @throws ApiError
|
|
139
|
+
*/
|
|
140
|
+
contentDeleteLocale(key: string, locale?: string): CancelablePromise<ContentItem>;
|
|
141
|
+
/**
|
|
142
|
+
* Get version
|
|
143
|
+
* Get the content item with the provided key and version.
|
|
144
|
+
* @param key
|
|
145
|
+
* @param version
|
|
146
|
+
* @param locale
|
|
147
|
+
* @returns ContentItem Success
|
|
148
|
+
* @throws ApiError
|
|
149
|
+
*/
|
|
150
|
+
contentGetVersion(key: string, version: string, locale?: string): CancelablePromise<ContentItem>;
|
|
151
|
+
/**
|
|
152
|
+
* Update version
|
|
153
|
+
* Update an existing content item. If a content item with the provided key does not exist an error is returned.
|
|
154
|
+
* @param key The key of the content item that should be updated.
|
|
155
|
+
* @param version The version of the content that should be updated.
|
|
156
|
+
* @param requestBody The content information that should be updated.
|
|
157
|
+
* @param locale The locale of the content that should be updated.
|
|
158
|
+
* @param skipValidation Indicates that the content validation should be ignored.
|
|
159
|
+
* @returns ContentItem Success
|
|
160
|
+
* @throws ApiError
|
|
161
|
+
*/
|
|
162
|
+
contentPatchVersion(key: string, version: string, requestBody: ContentItem, locale?: string, skipValidation?: boolean): CancelablePromise<ContentItem>;
|
|
163
|
+
/**
|
|
164
|
+
* Delete version
|
|
165
|
+
* Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
|
|
166
|
+
* @param key
|
|
167
|
+
* @param version
|
|
168
|
+
* @returns ContentItem Success
|
|
169
|
+
* @throws ApiError
|
|
170
|
+
*/
|
|
171
|
+
contentDeleteVersion(key: string, version: string): CancelablePromise<ContentItem>;
|
|
172
|
+
}
|
|
@@ -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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
63
|
+
* @throws ApiError
|
|
64
|
+
*/
|
|
65
|
+
contentTypesDelete(key: string): CancelablePromise<ContentType>;
|
|
66
|
+
}
|
|
@@ -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 Success
|
|
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 Success
|
|
14
|
+
* @throws ApiError
|
|
15
|
+
*/
|
|
16
|
+
oauthToken(requestBody: OauthTokenRequest): CancelablePromise<OauthToken>;
|
|
17
|
+
}
|
|
@@ -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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
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 Success
|
|
37
|
+
* @returns PackageJob Accepted
|
|
38
|
+
* @throws ApiError
|
|
39
|
+
*/
|
|
40
|
+
packagesImport(container?: string, overwriteExistingContentItems?: boolean, ignoreDataLossWarnings?: boolean, locale?: string, requestBody?: Blob): CancelablePromise<ImportPackageResult | PackageJob>;
|
|
41
|
+
}
|