@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,19 +1,19 @@
|
|
|
1
|
-
import type { PropertyFormat } from './PropertyFormat';
|
|
2
|
-
export type PropertyFormatPage = {
|
|
3
|
-
/**
|
|
4
|
-
* The items in this paged collection.
|
|
5
|
-
*/
|
|
6
|
-
readonly items?: Array<PropertyFormat>;
|
|
7
|
-
/**
|
|
8
|
-
* The zero-based index of the current page.
|
|
9
|
-
*/
|
|
10
|
-
readonly pageIndex?: number;
|
|
11
|
-
/**
|
|
12
|
-
* The number of item in each page. Not necessarily the same as the number of items in this page.
|
|
13
|
-
*/
|
|
14
|
-
readonly pageSize?: number;
|
|
15
|
-
/**
|
|
16
|
-
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
17
|
-
*/
|
|
18
|
-
readonly totalItemCount?: number;
|
|
19
|
-
};
|
|
1
|
+
import type { PropertyFormat } from './PropertyFormat';
|
|
2
|
+
export type PropertyFormatPage = {
|
|
3
|
+
/**
|
|
4
|
+
* The items in this paged collection.
|
|
5
|
+
*/
|
|
6
|
+
readonly items?: Array<PropertyFormat>;
|
|
7
|
+
/**
|
|
8
|
+
* The zero-based index of the current page.
|
|
9
|
+
*/
|
|
10
|
+
readonly pageIndex?: number;
|
|
11
|
+
/**
|
|
12
|
+
* The number of item in each page. Not necessarily the same as the number of items in this page.
|
|
13
|
+
*/
|
|
14
|
+
readonly pageSize?: number;
|
|
15
|
+
/**
|
|
16
|
+
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
17
|
+
*/
|
|
18
|
+
readonly totalItemCount?: number;
|
|
19
|
+
};
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Describes a property group of a ContentType in the CMS.
|
|
3
|
-
*/
|
|
4
|
-
export type PropertyGroup = {
|
|
5
|
-
/**
|
|
6
|
-
* The key that identifies this PropertyGroup.
|
|
7
|
-
*/
|
|
8
|
-
key: string;
|
|
9
|
-
/**
|
|
10
|
-
* The display name of this PropertyGroup.
|
|
11
|
-
*/
|
|
12
|
-
displayName?: string;
|
|
13
|
-
/**
|
|
14
|
-
* A string that is used to indicate the source of this PropertyGroup.
|
|
15
|
-
*/
|
|
16
|
-
readonly source?: string;
|
|
17
|
-
/**
|
|
18
|
-
* An value that is used to when sorting PropertyGroup instances.
|
|
19
|
-
*/
|
|
20
|
-
sortOrder?: number;
|
|
21
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* Describes a property group of a ContentType in the CMS.
|
|
3
|
+
*/
|
|
4
|
+
export type PropertyGroup = {
|
|
5
|
+
/**
|
|
6
|
+
* The key that identifies this PropertyGroup.
|
|
7
|
+
*/
|
|
8
|
+
key: string;
|
|
9
|
+
/**
|
|
10
|
+
* The display name of this PropertyGroup.
|
|
11
|
+
*/
|
|
12
|
+
displayName?: string;
|
|
13
|
+
/**
|
|
14
|
+
* A string that is used to indicate the source of this PropertyGroup.
|
|
15
|
+
*/
|
|
16
|
+
readonly source?: string;
|
|
17
|
+
/**
|
|
18
|
+
* An value that is used to when sorting PropertyGroup instances.
|
|
19
|
+
*/
|
|
20
|
+
sortOrder?: number;
|
|
21
|
+
};
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
import type { PropertyGroup } from './PropertyGroup';
|
|
2
|
-
export type PropertyGroupPage = {
|
|
3
|
-
/**
|
|
4
|
-
* The items in this paged collection.
|
|
5
|
-
*/
|
|
6
|
-
readonly items?: Array<PropertyGroup>;
|
|
7
|
-
/**
|
|
8
|
-
* The zero-based index of the current page.
|
|
9
|
-
*/
|
|
10
|
-
readonly pageIndex?: number;
|
|
11
|
-
/**
|
|
12
|
-
* The number of item in each page. Not necessarily the same as the number of items in this page.
|
|
13
|
-
*/
|
|
14
|
-
readonly pageSize?: number;
|
|
15
|
-
/**
|
|
16
|
-
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
17
|
-
*/
|
|
18
|
-
readonly totalItemCount?: number;
|
|
19
|
-
};
|
|
1
|
+
import type { PropertyGroup } from './PropertyGroup';
|
|
2
|
+
export type PropertyGroupPage = {
|
|
3
|
+
/**
|
|
4
|
+
* The items in this paged collection.
|
|
5
|
+
*/
|
|
6
|
+
readonly items?: Array<PropertyGroup>;
|
|
7
|
+
/**
|
|
8
|
+
* The zero-based index of the current page.
|
|
9
|
+
*/
|
|
10
|
+
readonly pageIndex?: number;
|
|
11
|
+
/**
|
|
12
|
+
* The number of item in each page. Not necessarily the same as the number of items in this page.
|
|
13
|
+
*/
|
|
14
|
+
readonly pageSize?: number;
|
|
15
|
+
/**
|
|
16
|
+
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
17
|
+
*/
|
|
18
|
+
readonly totalItemCount?: number;
|
|
19
|
+
};
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A writable implementation of an EnumerationSettings`1.
|
|
3
|
-
*/
|
|
4
|
-
export type StringEnumerationSettings = {
|
|
5
|
-
/**
|
|
6
|
-
* Enumeration values for this property or format.
|
|
7
|
-
*/
|
|
8
|
-
values?: Record<string, string>;
|
|
9
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* A writable implementation of an EnumerationSettings`1.
|
|
3
|
+
*/
|
|
4
|
+
export type StringEnumerationSettings = {
|
|
5
|
+
/**
|
|
6
|
+
* Enumeration values for this property or format.
|
|
7
|
+
*/
|
|
8
|
+
values?: Record<string, string>;
|
|
9
|
+
};
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import type { ListPropertyItem } from './ListPropertyItem';
|
|
2
|
-
import type { StringEnumerationSettings } from './StringEnumerationSettings';
|
|
3
|
-
/**
|
|
4
|
-
* Describes a property list item that can contain a string.
|
|
5
|
-
*/
|
|
6
|
-
export type StringListItem = (ListPropertyItem & {
|
|
7
|
-
minLength?: number | null;
|
|
8
|
-
maxLength?: number | null;
|
|
9
|
-
/**
|
|
10
|
-
* Regular expression pattern that limits what strings that list items of this type should be able to contain.
|
|
11
|
-
*/
|
|
12
|
-
pattern?: string | null;
|
|
13
|
-
enum?: StringEnumerationSettings;
|
|
14
|
-
});
|
|
1
|
+
import type { ListPropertyItem } from './ListPropertyItem';
|
|
2
|
+
import type { StringEnumerationSettings } from './StringEnumerationSettings';
|
|
3
|
+
/**
|
|
4
|
+
* Describes a property list item that can contain a string.
|
|
5
|
+
*/
|
|
6
|
+
export type StringListItem = (ListPropertyItem & {
|
|
7
|
+
minLength?: number | null;
|
|
8
|
+
maxLength?: number | null;
|
|
9
|
+
/**
|
|
10
|
+
* Regular expression pattern that limits what strings that list items of this type should be able to contain.
|
|
11
|
+
*/
|
|
12
|
+
pattern?: string | null;
|
|
13
|
+
enum?: StringEnumerationSettings;
|
|
14
|
+
});
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
-
import type { StringEnumerationSettings } from './StringEnumerationSettings';
|
|
3
|
-
/**
|
|
4
|
-
* Describes a property that can contain strings.
|
|
5
|
-
*/
|
|
6
|
-
export type StringProperty = (ContentTypeProperty & {
|
|
7
|
-
minLength?: number | null;
|
|
8
|
-
maxLength?: number | null;
|
|
9
|
-
/**
|
|
10
|
-
* Regular expression pattern that limits what strings that properties of this type should be able to contain.
|
|
11
|
-
*/
|
|
12
|
-
pattern?: string | null;
|
|
13
|
-
enum?: StringEnumerationSettings;
|
|
14
|
-
});
|
|
1
|
+
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
+
import type { StringEnumerationSettings } from './StringEnumerationSettings';
|
|
3
|
+
/**
|
|
4
|
+
* Describes a property that can contain strings.
|
|
5
|
+
*/
|
|
6
|
+
export type StringProperty = (ContentTypeProperty & {
|
|
7
|
+
minLength?: number | null;
|
|
8
|
+
maxLength?: number | null;
|
|
9
|
+
/**
|
|
10
|
+
* Regular expression pattern that limits what strings that properties of this type should be able to contain.
|
|
11
|
+
*/
|
|
12
|
+
pattern?: string | null;
|
|
13
|
+
enum?: StringEnumerationSettings;
|
|
14
|
+
});
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { ListPropertyItem } from './ListPropertyItem';
|
|
2
|
-
/**
|
|
3
|
-
* Describes a property list item that can contain a URL.
|
|
4
|
-
*/
|
|
5
|
-
export type UrlListItem = ListPropertyItem;
|
|
1
|
+
import type { ListPropertyItem } from './ListPropertyItem';
|
|
2
|
+
/**
|
|
3
|
+
* Describes a property list item that can contain a URL.
|
|
4
|
+
*/
|
|
5
|
+
export type UrlListItem = ListPropertyItem;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
-
/**
|
|
3
|
-
* Describes a property that can contain URLs.
|
|
4
|
-
*/
|
|
5
|
-
export type UrlProperty = ContentTypeProperty;
|
|
1
|
+
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
+
/**
|
|
3
|
+
* Describes a property that can contain URLs.
|
|
4
|
+
*/
|
|
5
|
+
export type UrlProperty = ContentTypeProperty;
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Represent the different status values of a content version.
|
|
3
|
-
*/
|
|
4
|
-
export declare enum VersionStatus {
|
|
5
|
-
DRAFT = "draft",
|
|
6
|
-
READY = "ready",
|
|
7
|
-
PUBLISHED = "published",
|
|
8
|
-
PREVIOUS = "previous",
|
|
9
|
-
SCHEDULED = "scheduled",
|
|
10
|
-
REJECTED = "rejected",
|
|
11
|
-
IN_REVIEW = "inReview"
|
|
12
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Represent the different status values of a content version.
|
|
3
|
+
*/
|
|
4
|
+
export declare enum VersionStatus {
|
|
5
|
+
DRAFT = "draft",
|
|
6
|
+
READY = "ready",
|
|
7
|
+
PUBLISHED = "published",
|
|
8
|
+
PREVIOUS = "previous",
|
|
9
|
+
SCHEDULED = "scheduled",
|
|
10
|
+
REJECTED = "rejected",
|
|
11
|
+
IN_REVIEW = "inReview"
|
|
12
|
+
}
|
|
@@ -1,105 +1,105 @@
|
|
|
1
|
-
import type { Changeset } from '../models/Changeset';
|
|
2
|
-
import type { ChangesetItem } from '../models/ChangesetItem';
|
|
3
|
-
import type { ChangesetItemPage } from '../models/ChangesetItemPage';
|
|
4
|
-
import type { ChangesetPage } from '../models/ChangesetPage';
|
|
5
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
6
|
-
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
7
|
-
export declare class ChangesetsService {
|
|
8
|
-
readonly httpRequest: BaseHttpRequest;
|
|
9
|
-
constructor(httpRequest: BaseHttpRequest);
|
|
10
|
-
/**
|
|
11
|
-
* List changeset
|
|
12
|
-
* Lists all changeset using the provided options.
|
|
13
|
-
* @param pageIndex
|
|
14
|
-
* @param pageSize
|
|
15
|
-
* @returns ChangesetPage Success
|
|
16
|
-
* @throws ApiError
|
|
17
|
-
*/
|
|
18
|
-
changesetsList(pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetPage>;
|
|
19
|
-
/**
|
|
20
|
-
* Create changeset
|
|
21
|
-
* Creates a new changeset.
|
|
22
|
-
* @param requestBody The changeset that should be created.
|
|
23
|
-
* @returns Changeset Success
|
|
24
|
-
* @throws ApiError
|
|
25
|
-
*/
|
|
26
|
-
changesetsCreate(requestBody: Changeset): CancelablePromise<Changeset>;
|
|
27
|
-
/**
|
|
28
|
-
* Get changeset
|
|
29
|
-
* Gets the changeset with the provided key.
|
|
30
|
-
* @param key The key of the changeset to retrieve.
|
|
31
|
-
* @returns Changeset Success
|
|
32
|
-
* @throws ApiError
|
|
33
|
-
*/
|
|
34
|
-
changesetsGet(key: string): CancelablePromise<Changeset>;
|
|
35
|
-
/**
|
|
36
|
-
* Delete changeset
|
|
37
|
-
* Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned.
|
|
38
|
-
* @param key The key of the changeset to delete.
|
|
39
|
-
* @returns Changeset Success
|
|
40
|
-
* @throws ApiError
|
|
41
|
-
*/
|
|
42
|
-
changesetsDelete(key: string): CancelablePromise<Changeset>;
|
|
43
|
-
/**
|
|
44
|
-
* Create or replace changeset
|
|
45
|
-
* Creates or replaces a changeset. If a changeset with the provided key exist it is replaced.
|
|
46
|
-
* Otherwise a new changeset is created.
|
|
47
|
-
* @param key The key of the changeset to update or create.
|
|
48
|
-
* @param requestBody The values of the created or replaced changeset.
|
|
49
|
-
* @returns Changeset Success
|
|
50
|
-
* @throws ApiError
|
|
51
|
-
*/
|
|
52
|
-
changesetsPut(key: string, requestBody: Changeset): CancelablePromise<Changeset>;
|
|
53
|
-
/**
|
|
54
|
-
* Get changeset item
|
|
55
|
-
* Gets the changeset item for the specified content reference.
|
|
56
|
-
* @param changeset The changeset key
|
|
57
|
-
* @param key The content key
|
|
58
|
-
* @param version The content version
|
|
59
|
-
* @returns ChangesetItem Success
|
|
60
|
-
* @throws ApiError
|
|
61
|
-
*/
|
|
62
|
-
changesetsGetItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
|
|
63
|
-
/**
|
|
64
|
-
* Delete changeset item
|
|
65
|
-
* Deletes the specified changeset item from the changeset.
|
|
66
|
-
* @param changeset The changeset key
|
|
67
|
-
* @param key The content key
|
|
68
|
-
* @param version The content version
|
|
69
|
-
* @returns ChangesetItem Success
|
|
70
|
-
* @throws ApiError
|
|
71
|
-
*/
|
|
72
|
-
changesetsDeleteItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
|
|
73
|
-
/**
|
|
74
|
-
* List changeset items
|
|
75
|
-
* Lists the available changeset items for the specified changeset using
|
|
76
|
-
* the provided options.
|
|
77
|
-
* @param changeset The changeset key
|
|
78
|
-
* @param pageIndex
|
|
79
|
-
* @param pageSize
|
|
80
|
-
* @returns ChangesetItemPage Success
|
|
81
|
-
* @throws ApiError
|
|
82
|
-
*/
|
|
83
|
-
changesetsListItems(changeset: string, pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetItemPage>;
|
|
84
|
-
/**
|
|
85
|
-
* Create changeset item
|
|
86
|
-
* Creates the given changeset item.
|
|
87
|
-
* @param changeset The changeset key
|
|
88
|
-
* @param requestBody The changeset item
|
|
89
|
-
* @returns ChangesetItem Success
|
|
90
|
-
* @throws ApiError
|
|
91
|
-
*/
|
|
92
|
-
changesetsCreateItem(changeset: string, requestBody: ChangesetItem): CancelablePromise<ChangesetItem>;
|
|
93
|
-
/**
|
|
94
|
-
* Update changeset item
|
|
95
|
-
* Updates the given changeset item.
|
|
96
|
-
* @param changeset The changeset key
|
|
97
|
-
* @param contentKey The content key
|
|
98
|
-
* @param contentVersion The content version
|
|
99
|
-
* @param requestBody The changeset item
|
|
100
|
-
* @param allowCreate Indicates if a new changeset item should be created if it does not exist
|
|
101
|
-
* @returns ChangesetItem Success
|
|
102
|
-
* @throws ApiError
|
|
103
|
-
*/
|
|
104
|
-
changesetsUpdateItem(changeset: string, contentKey: string, contentVersion: string, requestBody: ChangesetItem, allowCreate?: boolean): CancelablePromise<ChangesetItem>;
|
|
105
|
-
}
|
|
1
|
+
import type { Changeset } from '../models/Changeset';
|
|
2
|
+
import type { ChangesetItem } from '../models/ChangesetItem';
|
|
3
|
+
import type { ChangesetItemPage } from '../models/ChangesetItemPage';
|
|
4
|
+
import type { ChangesetPage } from '../models/ChangesetPage';
|
|
5
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
6
|
+
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
7
|
+
export declare class ChangesetsService {
|
|
8
|
+
readonly httpRequest: BaseHttpRequest;
|
|
9
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
10
|
+
/**
|
|
11
|
+
* List changeset
|
|
12
|
+
* Lists all changeset using the provided options.
|
|
13
|
+
* @param pageIndex
|
|
14
|
+
* @param pageSize
|
|
15
|
+
* @returns ChangesetPage Success
|
|
16
|
+
* @throws ApiError
|
|
17
|
+
*/
|
|
18
|
+
changesetsList(pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetPage>;
|
|
19
|
+
/**
|
|
20
|
+
* Create changeset
|
|
21
|
+
* Creates a new changeset.
|
|
22
|
+
* @param requestBody The changeset that should be created.
|
|
23
|
+
* @returns Changeset Success
|
|
24
|
+
* @throws ApiError
|
|
25
|
+
*/
|
|
26
|
+
changesetsCreate(requestBody: Changeset): CancelablePromise<Changeset>;
|
|
27
|
+
/**
|
|
28
|
+
* Get changeset
|
|
29
|
+
* Gets the changeset with the provided key.
|
|
30
|
+
* @param key The key of the changeset to retrieve.
|
|
31
|
+
* @returns Changeset Success
|
|
32
|
+
* @throws ApiError
|
|
33
|
+
*/
|
|
34
|
+
changesetsGet(key: string): CancelablePromise<Changeset>;
|
|
35
|
+
/**
|
|
36
|
+
* Delete changeset
|
|
37
|
+
* Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned.
|
|
38
|
+
* @param key The key of the changeset to delete.
|
|
39
|
+
* @returns Changeset Success
|
|
40
|
+
* @throws ApiError
|
|
41
|
+
*/
|
|
42
|
+
changesetsDelete(key: string): CancelablePromise<Changeset>;
|
|
43
|
+
/**
|
|
44
|
+
* Create or replace changeset
|
|
45
|
+
* Creates or replaces a changeset. If a changeset with the provided key exist it is replaced.
|
|
46
|
+
* Otherwise a new changeset is created.
|
|
47
|
+
* @param key The key of the changeset to update or create.
|
|
48
|
+
* @param requestBody The values of the created or replaced changeset.
|
|
49
|
+
* @returns Changeset Success
|
|
50
|
+
* @throws ApiError
|
|
51
|
+
*/
|
|
52
|
+
changesetsPut(key: string, requestBody: Changeset): CancelablePromise<Changeset>;
|
|
53
|
+
/**
|
|
54
|
+
* Get changeset item
|
|
55
|
+
* Gets the changeset item for the specified content reference.
|
|
56
|
+
* @param changeset The changeset key
|
|
57
|
+
* @param key The content key
|
|
58
|
+
* @param version The content version
|
|
59
|
+
* @returns ChangesetItem Success
|
|
60
|
+
* @throws ApiError
|
|
61
|
+
*/
|
|
62
|
+
changesetsGetItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
|
|
63
|
+
/**
|
|
64
|
+
* Delete changeset item
|
|
65
|
+
* Deletes the specified changeset item from the changeset.
|
|
66
|
+
* @param changeset The changeset key
|
|
67
|
+
* @param key The content key
|
|
68
|
+
* @param version The content version
|
|
69
|
+
* @returns ChangesetItem Success
|
|
70
|
+
* @throws ApiError
|
|
71
|
+
*/
|
|
72
|
+
changesetsDeleteItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
|
|
73
|
+
/**
|
|
74
|
+
* List changeset items
|
|
75
|
+
* Lists the available changeset items for the specified changeset using
|
|
76
|
+
* the provided options.
|
|
77
|
+
* @param changeset The changeset key
|
|
78
|
+
* @param pageIndex
|
|
79
|
+
* @param pageSize
|
|
80
|
+
* @returns ChangesetItemPage Success
|
|
81
|
+
* @throws ApiError
|
|
82
|
+
*/
|
|
83
|
+
changesetsListItems(changeset: string, pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetItemPage>;
|
|
84
|
+
/**
|
|
85
|
+
* Create changeset item
|
|
86
|
+
* Creates the given changeset item.
|
|
87
|
+
* @param changeset The changeset key
|
|
88
|
+
* @param requestBody The changeset item
|
|
89
|
+
* @returns ChangesetItem Success
|
|
90
|
+
* @throws ApiError
|
|
91
|
+
*/
|
|
92
|
+
changesetsCreateItem(changeset: string, requestBody: ChangesetItem): CancelablePromise<ChangesetItem>;
|
|
93
|
+
/**
|
|
94
|
+
* Update changeset item
|
|
95
|
+
* Updates the given changeset item.
|
|
96
|
+
* @param changeset The changeset key
|
|
97
|
+
* @param contentKey The content key
|
|
98
|
+
* @param contentVersion The content version
|
|
99
|
+
* @param requestBody The changeset item
|
|
100
|
+
* @param allowCreate Indicates if a new changeset item should be created if it does not exist
|
|
101
|
+
* @returns ChangesetItem Success
|
|
102
|
+
* @throws ApiError
|
|
103
|
+
*/
|
|
104
|
+
changesetsUpdateItem(changeset: string, contentKey: string, contentVersion: string, requestBody: ChangesetItem, allowCreate?: boolean): CancelablePromise<ChangesetItem>;
|
|
105
|
+
}
|