@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,17 +1,17 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A reference to a specific content instance.
|
|
3
|
-
*/
|
|
4
|
-
export type ContentReference = {
|
|
5
|
-
/**
|
|
6
|
-
* The content key that identifies the content.
|
|
7
|
-
*/
|
|
8
|
-
readonly key?: string;
|
|
9
|
-
/**
|
|
10
|
-
* The name of the content locale
|
|
11
|
-
*/
|
|
12
|
-
readonly locale?: string;
|
|
13
|
-
/**
|
|
14
|
-
* The identifier of a specific version of the content.
|
|
15
|
-
*/
|
|
16
|
-
readonly version?: string;
|
|
17
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* A reference to a specific content instance.
|
|
3
|
+
*/
|
|
4
|
+
export type ContentReference = {
|
|
5
|
+
/**
|
|
6
|
+
* The content key that identifies the content.
|
|
7
|
+
*/
|
|
8
|
+
readonly key?: string;
|
|
9
|
+
/**
|
|
10
|
+
* The name of the content locale
|
|
11
|
+
*/
|
|
12
|
+
readonly locale?: string;
|
|
13
|
+
/**
|
|
14
|
+
* The identifier of a specific version of the content.
|
|
15
|
+
*/
|
|
16
|
+
readonly version?: string;
|
|
17
|
+
};
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import type { ListPropertyItem } from './ListPropertyItem';
|
|
2
|
-
/**
|
|
3
|
-
* Describes a property list item that can hold a reference to a content item.
|
|
4
|
-
*/
|
|
5
|
-
export type ContentReferenceListItem = (ListPropertyItem & {
|
|
6
|
-
/**
|
|
7
|
-
* Specifies which content types and base types these list items are allowed to reference.
|
|
8
|
-
*/
|
|
9
|
-
allowedTypes?: Array<string>;
|
|
10
|
-
/**
|
|
11
|
-
* Specifies which content types and base types these list items cannot contain.
|
|
12
|
-
*/
|
|
13
|
-
restrictedTypes?: Array<string>;
|
|
14
|
-
});
|
|
1
|
+
import type { ListPropertyItem } from './ListPropertyItem';
|
|
2
|
+
/**
|
|
3
|
+
* Describes a property list item that can hold a reference to a content item.
|
|
4
|
+
*/
|
|
5
|
+
export type ContentReferenceListItem = (ListPropertyItem & {
|
|
6
|
+
/**
|
|
7
|
+
* Specifies which content types and base types these list items are allowed to reference.
|
|
8
|
+
*/
|
|
9
|
+
allowedTypes?: Array<string>;
|
|
10
|
+
/**
|
|
11
|
+
* Specifies which content types and base types these list items cannot contain.
|
|
12
|
+
*/
|
|
13
|
+
restrictedTypes?: Array<string>;
|
|
14
|
+
});
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
-
/**
|
|
3
|
-
* Describes a property that can contain a reference to a content item.
|
|
4
|
-
*/
|
|
5
|
-
export type ContentReferenceProperty = (ContentTypeProperty & {
|
|
6
|
-
/**
|
|
7
|
-
* Specifies which content types and base types this property is allowed to reference.
|
|
8
|
-
*/
|
|
9
|
-
allowedTypes?: Array<string>;
|
|
10
|
-
/**
|
|
11
|
-
* Specifies which content types and base types this property is restricted from referencing.
|
|
12
|
-
*/
|
|
13
|
-
restrictedTypes?: Array<string>;
|
|
14
|
-
});
|
|
1
|
+
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
+
/**
|
|
3
|
+
* Describes a property that can contain a reference to a content item.
|
|
4
|
+
*/
|
|
5
|
+
export type ContentReferenceProperty = (ContentTypeProperty & {
|
|
6
|
+
/**
|
|
7
|
+
* Specifies which content types and base types this property is allowed to reference.
|
|
8
|
+
*/
|
|
9
|
+
allowedTypes?: Array<string>;
|
|
10
|
+
/**
|
|
11
|
+
* Specifies which content types and base types this property is restricted from referencing.
|
|
12
|
+
*/
|
|
13
|
+
restrictedTypes?: Array<string>;
|
|
14
|
+
});
|
|
@@ -1,79 +1,79 @@
|
|
|
1
|
-
import type { BinaryProperty } from './BinaryProperty';
|
|
2
|
-
import type { BooleanProperty } from './BooleanProperty';
|
|
3
|
-
import type { ComponentProperty } from './ComponentProperty';
|
|
4
|
-
import type { ContentBaseType } from './ContentBaseType';
|
|
5
|
-
import type { ContentProperty } from './ContentProperty';
|
|
6
|
-
import type { ContentReferenceProperty } from './ContentReferenceProperty';
|
|
7
|
-
import type { ContentTypeFeature } from './ContentTypeFeature';
|
|
8
|
-
import type { ContentTypeUsage } from './ContentTypeUsage';
|
|
9
|
-
import type { DateTimeProperty } from './DateTimeProperty';
|
|
10
|
-
import type { FloatProperty } from './FloatProperty';
|
|
11
|
-
import type { IntegerProperty } from './IntegerProperty';
|
|
12
|
-
import type { JsonStringProperty } from './JsonStringProperty';
|
|
13
|
-
import type { ListProperty } from './ListProperty';
|
|
14
|
-
import type { StringProperty } from './StringProperty';
|
|
15
|
-
import type { UrlProperty } from './UrlProperty';
|
|
16
|
-
/**
|
|
17
|
-
* A writable implementation of an ContentType.
|
|
18
|
-
*/
|
|
19
|
-
export type ContentType = {
|
|
20
|
-
/**
|
|
21
|
-
* The key that identifies this ContentType.
|
|
22
|
-
*/
|
|
23
|
-
key: string;
|
|
24
|
-
/**
|
|
25
|
-
* The display name of this ContentType.
|
|
26
|
-
*/
|
|
27
|
-
displayName?: string;
|
|
28
|
-
/**
|
|
29
|
-
* A description of this ContentType.
|
|
30
|
-
*/
|
|
31
|
-
description?: string;
|
|
32
|
-
baseType?: ContentBaseType;
|
|
33
|
-
/**
|
|
34
|
-
* A string that is used to indicate the source of this ContentType.
|
|
35
|
-
*/
|
|
36
|
-
readonly source?: string;
|
|
37
|
-
/**
|
|
38
|
-
* An value that is used to when sorting ContentType instances.
|
|
39
|
-
*/
|
|
40
|
-
sortOrder?: number;
|
|
41
|
-
/**
|
|
42
|
-
* Provides a set of features that content based on this ContentType supports.
|
|
43
|
-
* This value is assigned based on the BaseType and cannot be modified.
|
|
44
|
-
*/
|
|
45
|
-
features?: Array<ContentTypeFeature>;
|
|
46
|
-
/**
|
|
47
|
-
* Specifies how this ContentType can be used.
|
|
48
|
-
*/
|
|
49
|
-
usage?: Array<ContentTypeUsage>;
|
|
50
|
-
/**
|
|
51
|
-
* Provides a set of content types that can be created in container of this type
|
|
52
|
-
*/
|
|
53
|
-
mayContainTypes?: Array<string>;
|
|
54
|
-
/**
|
|
55
|
-
* Provides a set of media file extensions that this content type can handle.
|
|
56
|
-
*/
|
|
57
|
-
mediaFileExtensions?: Array<string>;
|
|
58
|
-
/**
|
|
59
|
-
* A timestamp indicating when this ContentType was first created.
|
|
60
|
-
*/
|
|
61
|
-
readonly created?: string;
|
|
62
|
-
/**
|
|
63
|
-
* The username of the user that made the latest modification to this ContentType.
|
|
64
|
-
*/
|
|
65
|
-
readonly lastModifiedBy?: string;
|
|
66
|
-
/**
|
|
67
|
-
* Indicates the last time this content type was modified.
|
|
68
|
-
*/
|
|
69
|
-
readonly lastModified?: string;
|
|
70
|
-
/**
|
|
71
|
-
* Dictionary with all custom properties of this ContentType.
|
|
72
|
-
*/
|
|
73
|
-
properties?: Record<string, (BinaryProperty | BooleanProperty | ComponentProperty | ContentProperty | ContentReferenceProperty | DateTimeProperty | FloatProperty | IntegerProperty | StringProperty | UrlProperty | JsonStringProperty | ListProperty | {
|
|
74
|
-
/**
|
|
75
|
-
* Settings for the editor.
|
|
76
|
-
*/
|
|
77
|
-
editorSettings?: Record<string, Record<string, any>> | null;
|
|
78
|
-
})>;
|
|
79
|
-
};
|
|
1
|
+
import type { BinaryProperty } from './BinaryProperty';
|
|
2
|
+
import type { BooleanProperty } from './BooleanProperty';
|
|
3
|
+
import type { ComponentProperty } from './ComponentProperty';
|
|
4
|
+
import type { ContentBaseType } from './ContentBaseType';
|
|
5
|
+
import type { ContentProperty } from './ContentProperty';
|
|
6
|
+
import type { ContentReferenceProperty } from './ContentReferenceProperty';
|
|
7
|
+
import type { ContentTypeFeature } from './ContentTypeFeature';
|
|
8
|
+
import type { ContentTypeUsage } from './ContentTypeUsage';
|
|
9
|
+
import type { DateTimeProperty } from './DateTimeProperty';
|
|
10
|
+
import type { FloatProperty } from './FloatProperty';
|
|
11
|
+
import type { IntegerProperty } from './IntegerProperty';
|
|
12
|
+
import type { JsonStringProperty } from './JsonStringProperty';
|
|
13
|
+
import type { ListProperty } from './ListProperty';
|
|
14
|
+
import type { StringProperty } from './StringProperty';
|
|
15
|
+
import type { UrlProperty } from './UrlProperty';
|
|
16
|
+
/**
|
|
17
|
+
* A writable implementation of an ContentType.
|
|
18
|
+
*/
|
|
19
|
+
export type ContentType = {
|
|
20
|
+
/**
|
|
21
|
+
* The key that identifies this ContentType.
|
|
22
|
+
*/
|
|
23
|
+
key: string;
|
|
24
|
+
/**
|
|
25
|
+
* The display name of this ContentType.
|
|
26
|
+
*/
|
|
27
|
+
displayName?: string;
|
|
28
|
+
/**
|
|
29
|
+
* A description of this ContentType.
|
|
30
|
+
*/
|
|
31
|
+
description?: string;
|
|
32
|
+
baseType?: ContentBaseType;
|
|
33
|
+
/**
|
|
34
|
+
* A string that is used to indicate the source of this ContentType.
|
|
35
|
+
*/
|
|
36
|
+
readonly source?: string;
|
|
37
|
+
/**
|
|
38
|
+
* An value that is used to when sorting ContentType instances.
|
|
39
|
+
*/
|
|
40
|
+
sortOrder?: number;
|
|
41
|
+
/**
|
|
42
|
+
* Provides a set of features that content based on this ContentType supports.
|
|
43
|
+
* This value is assigned based on the BaseType and cannot be modified.
|
|
44
|
+
*/
|
|
45
|
+
features?: Array<ContentTypeFeature>;
|
|
46
|
+
/**
|
|
47
|
+
* Specifies how this ContentType can be used.
|
|
48
|
+
*/
|
|
49
|
+
usage?: Array<ContentTypeUsage>;
|
|
50
|
+
/**
|
|
51
|
+
* Provides a set of content types that can be created in container of this type
|
|
52
|
+
*/
|
|
53
|
+
mayContainTypes?: Array<string>;
|
|
54
|
+
/**
|
|
55
|
+
* Provides a set of media file extensions that this content type can handle.
|
|
56
|
+
*/
|
|
57
|
+
mediaFileExtensions?: Array<string>;
|
|
58
|
+
/**
|
|
59
|
+
* A timestamp indicating when this ContentType was first created.
|
|
60
|
+
*/
|
|
61
|
+
readonly created?: string;
|
|
62
|
+
/**
|
|
63
|
+
* The username of the user that made the latest modification to this ContentType.
|
|
64
|
+
*/
|
|
65
|
+
readonly lastModifiedBy?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Indicates the last time this content type was modified.
|
|
68
|
+
*/
|
|
69
|
+
readonly lastModified?: string;
|
|
70
|
+
/**
|
|
71
|
+
* Dictionary with all custom properties of this ContentType.
|
|
72
|
+
*/
|
|
73
|
+
properties?: Record<string, (BinaryProperty | BooleanProperty | ComponentProperty | ContentProperty | ContentReferenceProperty | DateTimeProperty | FloatProperty | IntegerProperty | StringProperty | UrlProperty | JsonStringProperty | ListProperty | {
|
|
74
|
+
/**
|
|
75
|
+
* Settings for the editor.
|
|
76
|
+
*/
|
|
77
|
+
editorSettings?: Record<string, Record<string, any>> | null;
|
|
78
|
+
})>;
|
|
79
|
+
};
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Represent different features that a content type can have.
|
|
3
|
-
*/
|
|
4
|
-
export declare enum ContentTypeFeature {
|
|
5
|
-
LOCALIZATION = "localization",
|
|
6
|
-
VERSIONING = "versioning",
|
|
7
|
-
PUBLISH_PERIOD = "publishPeriod",
|
|
8
|
-
ROUTING = "routing",
|
|
9
|
-
BINARY = "binary"
|
|
10
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Represent different features that a content type can have.
|
|
3
|
+
*/
|
|
4
|
+
export declare enum ContentTypeFeature {
|
|
5
|
+
LOCALIZATION = "localization",
|
|
6
|
+
VERSIONING = "versioning",
|
|
7
|
+
PUBLISH_PERIOD = "publishPeriod",
|
|
8
|
+
ROUTING = "routing",
|
|
9
|
+
BINARY = "binary"
|
|
10
|
+
}
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
import type { ContentType } from './ContentType';
|
|
2
|
-
export type ContentTypePage = {
|
|
3
|
-
/**
|
|
4
|
-
* The items in this paged collection.
|
|
5
|
-
*/
|
|
6
|
-
readonly items?: Array<ContentType>;
|
|
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 { ContentType } from './ContentType';
|
|
2
|
+
export type ContentTypePage = {
|
|
3
|
+
/**
|
|
4
|
+
* The items in this paged collection.
|
|
5
|
+
*/
|
|
6
|
+
readonly items?: Array<ContentType>;
|
|
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,47 +1,47 @@
|
|
|
1
|
-
import type { IndexingType } from './IndexingType';
|
|
2
|
-
import type { PropertyDataType } from './PropertyDataType';
|
|
3
|
-
/**
|
|
4
|
-
* A writable implementation of an ContentTypeProperty.
|
|
5
|
-
*/
|
|
6
|
-
export type ContentTypeProperty = {
|
|
7
|
-
type: PropertyDataType;
|
|
8
|
-
/**
|
|
9
|
-
* The key of the PropertyFormat that this ContentTypeProperty is an instance of.
|
|
10
|
-
*/
|
|
11
|
-
format?: string | null;
|
|
12
|
-
/**
|
|
13
|
-
* The display name of this ContentTypeProperty.
|
|
14
|
-
*/
|
|
15
|
-
displayName?: string;
|
|
16
|
-
/**
|
|
17
|
-
* A description of this ContentTypeProperty.
|
|
18
|
-
*/
|
|
19
|
-
description?: string;
|
|
20
|
-
/**
|
|
21
|
-
* Indicates if a property instance of this type must always be assigned a value.
|
|
22
|
-
*/
|
|
23
|
-
required?: boolean;
|
|
24
|
-
/**
|
|
25
|
-
* Indicates if a property instance of this type should be localized for each locale
|
|
26
|
-
* or if values are shared between all locales.
|
|
27
|
-
*/
|
|
28
|
-
localized?: boolean;
|
|
29
|
-
/**
|
|
30
|
-
* A reference to the PropertyGroup that this ContentTypeProperty is part of.
|
|
31
|
-
* If this value is empty, a group may be assigned by the system.
|
|
32
|
-
*/
|
|
33
|
-
group?: string;
|
|
34
|
-
/**
|
|
35
|
-
* An value that is used to when sorting ContentTypeProperty instances.
|
|
36
|
-
*/
|
|
37
|
-
sortOrder?: number;
|
|
38
|
-
indexingType?: IndexingType;
|
|
39
|
-
/**
|
|
40
|
-
* Editor used for managing this property.
|
|
41
|
-
*/
|
|
42
|
-
editor?: string | null;
|
|
43
|
-
/**
|
|
44
|
-
* Settings for the editor.
|
|
45
|
-
*/
|
|
46
|
-
editorSettings?: Record<string, Record<string, any>> | null;
|
|
47
|
-
};
|
|
1
|
+
import type { IndexingType } from './IndexingType';
|
|
2
|
+
import type { PropertyDataType } from './PropertyDataType';
|
|
3
|
+
/**
|
|
4
|
+
* A writable implementation of an ContentTypeProperty.
|
|
5
|
+
*/
|
|
6
|
+
export type ContentTypeProperty = {
|
|
7
|
+
type: PropertyDataType;
|
|
8
|
+
/**
|
|
9
|
+
* The key of the PropertyFormat that this ContentTypeProperty is an instance of.
|
|
10
|
+
*/
|
|
11
|
+
format?: string | null;
|
|
12
|
+
/**
|
|
13
|
+
* The display name of this ContentTypeProperty.
|
|
14
|
+
*/
|
|
15
|
+
displayName?: string;
|
|
16
|
+
/**
|
|
17
|
+
* A description of this ContentTypeProperty.
|
|
18
|
+
*/
|
|
19
|
+
description?: string;
|
|
20
|
+
/**
|
|
21
|
+
* Indicates if a property instance of this type must always be assigned a value.
|
|
22
|
+
*/
|
|
23
|
+
required?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Indicates if a property instance of this type should be localized for each locale
|
|
26
|
+
* or if values are shared between all locales.
|
|
27
|
+
*/
|
|
28
|
+
localized?: boolean;
|
|
29
|
+
/**
|
|
30
|
+
* A reference to the PropertyGroup that this ContentTypeProperty is part of.
|
|
31
|
+
* If this value is empty, a group may be assigned by the system.
|
|
32
|
+
*/
|
|
33
|
+
group?: string;
|
|
34
|
+
/**
|
|
35
|
+
* An value that is used to when sorting ContentTypeProperty instances.
|
|
36
|
+
*/
|
|
37
|
+
sortOrder?: number;
|
|
38
|
+
indexingType?: IndexingType;
|
|
39
|
+
/**
|
|
40
|
+
* Editor used for managing this property.
|
|
41
|
+
*/
|
|
42
|
+
editor?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* Settings for the editor.
|
|
45
|
+
*/
|
|
46
|
+
editorSettings?: Record<string, Record<string, any>> | null;
|
|
47
|
+
};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Represent the usage types for a ContentType.
|
|
3
|
-
*/
|
|
4
|
-
export declare enum ContentTypeUsage {
|
|
5
|
-
PROPERTY = "property",
|
|
6
|
-
INSTANCE = "instance"
|
|
7
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Represent the usage types for a ContentType.
|
|
3
|
+
*/
|
|
4
|
+
export declare enum ContentTypeUsage {
|
|
5
|
+
PROPERTY = "property",
|
|
6
|
+
INSTANCE = "instance"
|
|
7
|
+
}
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Options for copying content.
|
|
3
|
-
*/
|
|
4
|
-
export type CopyContentOptions = {
|
|
5
|
-
/**
|
|
6
|
-
* Indicates if deleted content could be used as source.
|
|
7
|
-
*/
|
|
8
|
-
allowDeleted?: boolean;
|
|
9
|
-
/**
|
|
10
|
-
* Optional key of the container where the copied content should be placed.
|
|
11
|
-
*/
|
|
12
|
-
container?: string | null;
|
|
13
|
-
/**
|
|
14
|
-
* Optional key of the owner where the copied content should be placed.
|
|
15
|
-
*/
|
|
16
|
-
owner?: string | null;
|
|
17
|
-
/**
|
|
18
|
-
* Indicates if published versions of the content should keep their published status rather than being created as a draft version at the destination.
|
|
19
|
-
*/
|
|
20
|
-
keepPublishedStatus?: boolean;
|
|
21
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* Options for copying content.
|
|
3
|
+
*/
|
|
4
|
+
export type CopyContentOptions = {
|
|
5
|
+
/**
|
|
6
|
+
* Indicates if deleted content could be used as source.
|
|
7
|
+
*/
|
|
8
|
+
allowDeleted?: boolean;
|
|
9
|
+
/**
|
|
10
|
+
* Optional key of the container where the copied content should be placed.
|
|
11
|
+
*/
|
|
12
|
+
container?: string | null;
|
|
13
|
+
/**
|
|
14
|
+
* Optional key of the owner where the copied content should be placed.
|
|
15
|
+
*/
|
|
16
|
+
owner?: string | null;
|
|
17
|
+
/**
|
|
18
|
+
* Indicates if published versions of the content should keep their published status rather than being created as a draft version at the destination.
|
|
19
|
+
*/
|
|
20
|
+
keepPublishedStatus?: boolean;
|
|
21
|
+
};
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import type { ListPropertyItem } from './ListPropertyItem';
|
|
2
|
-
/**
|
|
3
|
-
* Describes a property list item that can contain a timestamp.
|
|
4
|
-
*/
|
|
5
|
-
export type DateTimeListItem = (ListPropertyItem & {
|
|
6
|
-
/**
|
|
7
|
-
* The earliest timestamp that list items of this type should be able to contain.
|
|
8
|
-
*/
|
|
9
|
-
minimum?: string | null;
|
|
10
|
-
/**
|
|
11
|
-
* The latest timestamp that list items of this type should be able to contain.
|
|
12
|
-
*/
|
|
13
|
-
maximum?: string | null;
|
|
14
|
-
});
|
|
1
|
+
import type { ListPropertyItem } from './ListPropertyItem';
|
|
2
|
+
/**
|
|
3
|
+
* Describes a property list item that can contain a timestamp.
|
|
4
|
+
*/
|
|
5
|
+
export type DateTimeListItem = (ListPropertyItem & {
|
|
6
|
+
/**
|
|
7
|
+
* The earliest timestamp that list items of this type should be able to contain.
|
|
8
|
+
*/
|
|
9
|
+
minimum?: string | null;
|
|
10
|
+
/**
|
|
11
|
+
* The latest timestamp that list items of this type should be able to contain.
|
|
12
|
+
*/
|
|
13
|
+
maximum?: string | null;
|
|
14
|
+
});
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
-
/**
|
|
3
|
-
* Describes a property that can contain a timestamp.
|
|
4
|
-
*/
|
|
5
|
-
export type DateTimeProperty = (ContentTypeProperty & {
|
|
6
|
-
/**
|
|
7
|
-
* The earliest timestamp that properties of this type should be able to contain.
|
|
8
|
-
*/
|
|
9
|
-
minimum?: string | null;
|
|
10
|
-
/**
|
|
11
|
-
* The latest timestamp that properties of this type should be able to contain.
|
|
12
|
-
*/
|
|
13
|
-
maximum?: string | null;
|
|
14
|
-
});
|
|
1
|
+
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
+
/**
|
|
3
|
+
* Describes a property that can contain a timestamp.
|
|
4
|
+
*/
|
|
5
|
+
export type DateTimeProperty = (ContentTypeProperty & {
|
|
6
|
+
/**
|
|
7
|
+
* The earliest timestamp that properties of this type should be able to contain.
|
|
8
|
+
*/
|
|
9
|
+
minimum?: string | null;
|
|
10
|
+
/**
|
|
11
|
+
* The latest timestamp that properties of this type should be able to contain.
|
|
12
|
+
*/
|
|
13
|
+
maximum?: string | null;
|
|
14
|
+
});
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A writable implementation of an EnumerationSettings`1.
|
|
3
|
-
*/
|
|
4
|
-
export type DoubleEnumerationSettings = {
|
|
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 DoubleEnumerationSettings = {
|
|
5
|
+
/**
|
|
6
|
+
* Enumeration values for this property or format.
|
|
7
|
+
*/
|
|
8
|
+
values?: Record<string, string>;
|
|
9
|
+
};
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import type { DoubleEnumerationSettings } from './DoubleEnumerationSettings';
|
|
2
|
-
import type { ListPropertyItem } from './ListPropertyItem';
|
|
3
|
-
/**
|
|
4
|
-
* Describes a property list item that can contain a float number.
|
|
5
|
-
*/
|
|
6
|
-
export type FloatListItem = (ListPropertyItem & {
|
|
7
|
-
/**
|
|
8
|
-
* The minimum value that list items of this type should be able to contain.
|
|
9
|
-
*/
|
|
10
|
-
minimum?: number | null;
|
|
11
|
-
/**
|
|
12
|
-
* The maximum value that list items of this type should be able to contain.
|
|
13
|
-
*/
|
|
14
|
-
maximum?: number | null;
|
|
15
|
-
enum?: DoubleEnumerationSettings;
|
|
16
|
-
});
|
|
1
|
+
import type { DoubleEnumerationSettings } from './DoubleEnumerationSettings';
|
|
2
|
+
import type { ListPropertyItem } from './ListPropertyItem';
|
|
3
|
+
/**
|
|
4
|
+
* Describes a property list item that can contain a float number.
|
|
5
|
+
*/
|
|
6
|
+
export type FloatListItem = (ListPropertyItem & {
|
|
7
|
+
/**
|
|
8
|
+
* The minimum value that list items of this type should be able to contain.
|
|
9
|
+
*/
|
|
10
|
+
minimum?: number | null;
|
|
11
|
+
/**
|
|
12
|
+
* The maximum value that list items of this type should be able to contain.
|
|
13
|
+
*/
|
|
14
|
+
maximum?: number | null;
|
|
15
|
+
enum?: DoubleEnumerationSettings;
|
|
16
|
+
});
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
-
import type { DoubleEnumerationSettings } from './DoubleEnumerationSettings';
|
|
3
|
-
/**
|
|
4
|
-
* Describes a property that can contain a float number.
|
|
5
|
-
*/
|
|
6
|
-
export type FloatProperty = (ContentTypeProperty & {
|
|
7
|
-
/**
|
|
8
|
-
* The minimum value that properties of this type should be able to contain.
|
|
9
|
-
*/
|
|
10
|
-
minimum?: number | null;
|
|
11
|
-
/**
|
|
12
|
-
* The maximum value that properties of this type should be able to contain.
|
|
13
|
-
*/
|
|
14
|
-
maximum?: number | null;
|
|
15
|
-
enum?: DoubleEnumerationSettings;
|
|
16
|
-
});
|
|
1
|
+
import type { ContentTypeProperty } from './ContentTypeProperty';
|
|
2
|
+
import type { DoubleEnumerationSettings } from './DoubleEnumerationSettings';
|
|
3
|
+
/**
|
|
4
|
+
* Describes a property that can contain a float number.
|
|
5
|
+
*/
|
|
6
|
+
export type FloatProperty = (ContentTypeProperty & {
|
|
7
|
+
/**
|
|
8
|
+
* The minimum value that properties of this type should be able to contain.
|
|
9
|
+
*/
|
|
10
|
+
minimum?: number | null;
|
|
11
|
+
/**
|
|
12
|
+
* The maximum value that properties of this type should be able to contain.
|
|
13
|
+
*/
|
|
14
|
+
maximum?: number | null;
|
|
15
|
+
enum?: DoubleEnumerationSettings;
|
|
16
|
+
});
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Instruction for generating an alternative image from the main binary of an image content item.
|
|
3
|
-
*/
|
|
4
|
-
export type ImageDescriptor = {
|
|
5
|
-
/**
|
|
6
|
-
* The image width in pixels.
|
|
7
|
-
*/
|
|
8
|
-
width?: number;
|
|
9
|
-
/**
|
|
10
|
-
* The image height in pixels.
|
|
11
|
-
*/
|
|
12
|
-
height?: number;
|
|
13
|
-
/**
|
|
14
|
-
* Indicates if the image should be pregenerated when a new image is uploaded rather than when first requested.
|
|
15
|
-
*/
|
|
16
|
-
pregenerated?: boolean;
|
|
17
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* Instruction for generating an alternative image from the main binary of an image content item.
|
|
3
|
+
*/
|
|
4
|
+
export type ImageDescriptor = {
|
|
5
|
+
/**
|
|
6
|
+
* The image width in pixels.
|
|
7
|
+
*/
|
|
8
|
+
width?: number;
|
|
9
|
+
/**
|
|
10
|
+
* The image height in pixels.
|
|
11
|
+
*/
|
|
12
|
+
height?: number;
|
|
13
|
+
/**
|
|
14
|
+
* Indicates if the image should be pregenerated when a new image is uploaded rather than when first requested.
|
|
15
|
+
*/
|
|
16
|
+
pregenerated?: boolean;
|
|
17
|
+
};
|