@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.
Files changed (84) hide show
  1. package/dist/client/CmsIntegrationApiClient.d.ts +22 -22
  2. package/dist/client/core/ApiError.d.ts +10 -10
  3. package/dist/client/core/ApiRequestOptions.d.ts +13 -13
  4. package/dist/client/core/ApiResult.d.ts +7 -7
  5. package/dist/client/core/BaseHttpRequest.d.ts +8 -8
  6. package/dist/client/core/CancelablePromise.d.ts +20 -20
  7. package/dist/client/core/FetchHttpRequest.d.ts +14 -14
  8. package/dist/client/core/OpenAPI.d.ts +16 -16
  9. package/dist/client/core/request.d.ts +30 -30
  10. package/dist/client/index.d.ts +76 -76
  11. package/dist/client/models/BinaryProperty.d.ts +8 -8
  12. package/dist/client/models/BooleanProperty.d.ts +5 -5
  13. package/dist/client/models/Changeset.d.ts +26 -26
  14. package/dist/client/models/ChangesetItem.d.ts +11 -11
  15. package/dist/client/models/ChangesetItemPage.d.ts +19 -19
  16. package/dist/client/models/ChangesetPage.d.ts +19 -19
  17. package/dist/client/models/ComponentListItem.d.ts +10 -10
  18. package/dist/client/models/ComponentProperty.d.ts +10 -10
  19. package/dist/client/models/ContentBaseType.d.ts +11 -11
  20. package/dist/client/models/ContentComponent.d.ts +34 -34
  21. package/dist/client/models/ContentItem.d.ts +60 -60
  22. package/dist/client/models/ContentItemListWithContentTypes.d.ts +27 -27
  23. package/dist/client/models/ContentItemPage.d.ts +19 -19
  24. package/dist/client/models/ContentItemWithContentTypes.d.ts +12 -12
  25. package/dist/client/models/ContentListItem.d.ts +14 -14
  26. package/dist/client/models/ContentLocaleInfo.d.ts +11 -11
  27. package/dist/client/models/ContentMetadata.d.ts +46 -46
  28. package/dist/client/models/ContentMetadataPage.d.ts +19 -19
  29. package/dist/client/models/ContentProperty.d.ts +14 -14
  30. package/dist/client/models/ContentReference.d.ts +17 -17
  31. package/dist/client/models/ContentReferenceListItem.d.ts +14 -14
  32. package/dist/client/models/ContentReferenceProperty.d.ts +14 -14
  33. package/dist/client/models/ContentType.d.ts +79 -79
  34. package/dist/client/models/ContentTypeFeature.d.ts +10 -10
  35. package/dist/client/models/ContentTypePage.d.ts +19 -19
  36. package/dist/client/models/ContentTypeProperty.d.ts +47 -47
  37. package/dist/client/models/ContentTypeUsage.d.ts +7 -7
  38. package/dist/client/models/CopyContentOptions.d.ts +21 -21
  39. package/dist/client/models/DateTimeListItem.d.ts +14 -14
  40. package/dist/client/models/DateTimeProperty.d.ts +14 -14
  41. package/dist/client/models/DoubleEnumerationSettings.d.ts +9 -9
  42. package/dist/client/models/FloatListItem.d.ts +16 -16
  43. package/dist/client/models/FloatProperty.d.ts +16 -16
  44. package/dist/client/models/ImageDescriptor.d.ts +17 -17
  45. package/dist/client/models/ImportPackageMessage.d.ts +17 -17
  46. package/dist/client/models/ImportPackageResult.d.ts +22 -22
  47. package/dist/client/models/IndexingType.d.ts +8 -8
  48. package/dist/client/models/Int32EnumerationSettings.d.ts +9 -9
  49. package/dist/client/models/IntegerListItem.d.ts +16 -16
  50. package/dist/client/models/IntegerProperty.d.ts +16 -16
  51. package/dist/client/models/JsonStringProperty.d.ts +5 -5
  52. package/dist/client/models/ListProperty.d.ts +26 -26
  53. package/dist/client/models/ListPropertyItem.d.ts +11 -11
  54. package/dist/client/models/LocaleStatus.d.ts +7 -7
  55. package/dist/client/models/Manifest.d.ts +19 -19
  56. package/dist/client/models/OauthToken.d.ts +18 -18
  57. package/dist/client/models/OauthTokenError.d.ts +13 -13
  58. package/dist/client/models/OauthTokenRequest.d.ts +21 -21
  59. package/dist/client/models/PackageJob.d.ts +28 -28
  60. package/dist/client/models/PackageJobMessage.d.ts +17 -17
  61. package/dist/client/models/PackageJobStatus.d.ts +4 -4
  62. package/dist/client/models/ProblemDetails.d.ts +1 -1
  63. package/dist/client/models/PropertyDataType.d.ts +18 -18
  64. package/dist/client/models/PropertyFormat.d.ts +34 -34
  65. package/dist/client/models/PropertyFormatPage.d.ts +19 -19
  66. package/dist/client/models/PropertyGroup.d.ts +21 -21
  67. package/dist/client/models/PropertyGroupPage.d.ts +19 -19
  68. package/dist/client/models/StringEnumerationSettings.d.ts +9 -9
  69. package/dist/client/models/StringListItem.d.ts +14 -14
  70. package/dist/client/models/StringProperty.d.ts +14 -14
  71. package/dist/client/models/UrlListItem.d.ts +5 -5
  72. package/dist/client/models/UrlProperty.d.ts +5 -5
  73. package/dist/client/models/VersionStatus.d.ts +12 -12
  74. package/dist/client/services/ChangesetsService.d.ts +105 -105
  75. package/dist/client/services/ContentService.d.ts +172 -172
  76. package/dist/client/services/ContentTypesService.d.ts +66 -66
  77. package/dist/client/services/OauthService.d.ts +17 -17
  78. package/dist/client/services/PackagesService.d.ts +41 -41
  79. package/dist/client/services/PropertyFormatsService.d.ts +26 -26
  80. package/dist/client/services/PropertyGroupsService.d.ts +61 -61
  81. package/dist/config.d.ts +7 -8
  82. package/dist/config.js +6 -3
  83. package/dist/index.d.ts +15 -15
  84. package/package.json +4 -3
@@ -1,17 +1,17 @@
1
- /**
2
- * Describes a message from a package importing operation.
3
- */
4
- export type ImportPackageMessage = {
5
- /**
6
- * The section where the message originated from.
7
- */
8
- readonly section?: string | null;
9
- /**
10
- * The message describing an outcome.
11
- */
12
- readonly message?: string;
13
- /**
14
- * The identifier of the resource that was the reason for this message to be created.
15
- */
16
- readonly identifier?: string | null;
17
- };
1
+ /**
2
+ * Describes a message from a package importing operation.
3
+ */
4
+ export type ImportPackageMessage = {
5
+ /**
6
+ * The section where the message originated from.
7
+ */
8
+ readonly section?: string | null;
9
+ /**
10
+ * The message describing an outcome.
11
+ */
12
+ readonly message?: string;
13
+ /**
14
+ * The identifier of the resource that was the reason for this message to be created.
15
+ */
16
+ readonly identifier?: string | null;
17
+ };
@@ -1,22 +1,22 @@
1
- import type { ImportPackageMessage } from './ImportPackageMessage';
2
- /**
3
- * Describes the result of a data package import.
4
- */
5
- export type ImportPackageResult = {
6
- /**
7
- * Indication if the import succeeded.
8
- */
9
- readonly success?: boolean;
10
- /**
11
- * List of messages describing the outcome from the package import.
12
- */
13
- outcomes?: Array<ImportPackageMessage>;
14
- /**
15
- * List of error messages from the package import.
16
- */
17
- errors?: Array<ImportPackageMessage>;
18
- /**
19
- * List of warning messages from the package import.
20
- */
21
- warnings?: Array<ImportPackageMessage>;
22
- };
1
+ import type { ImportPackageMessage } from './ImportPackageMessage';
2
+ /**
3
+ * Describes the result of a data package import.
4
+ */
5
+ export type ImportPackageResult = {
6
+ /**
7
+ * Indication if the import succeeded.
8
+ */
9
+ readonly success?: boolean;
10
+ /**
11
+ * List of messages describing the outcome from the package import.
12
+ */
13
+ outcomes?: Array<ImportPackageMessage>;
14
+ /**
15
+ * List of error messages from the package import.
16
+ */
17
+ errors?: Array<ImportPackageMessage>;
18
+ /**
19
+ * List of warning messages from the package import.
20
+ */
21
+ warnings?: Array<ImportPackageMessage>;
22
+ };
@@ -1,8 +1,8 @@
1
- /**
2
- * Represent the indexing type of a ContentTypeProperty.
3
- */
4
- export declare enum IndexingType {
5
- DISABLED = "disabled",
6
- QUERYABLE = "queryable",
7
- SEARCHABLE = "searchable"
8
- }
1
+ /**
2
+ * Represent the indexing type of a ContentTypeProperty.
3
+ */
4
+ export declare enum IndexingType {
5
+ DISABLED = "disabled",
6
+ QUERYABLE = "queryable",
7
+ SEARCHABLE = "searchable"
8
+ }
@@ -1,9 +1,9 @@
1
- /**
2
- * A writable implementation of an EnumerationSettings`1.
3
- */
4
- export type Int32EnumerationSettings = {
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 Int32EnumerationSettings = {
5
+ /**
6
+ * Enumeration values for this property or format.
7
+ */
8
+ values?: Record<string, string>;
9
+ };
@@ -1,16 +1,16 @@
1
- import type { Int32EnumerationSettings } from './Int32EnumerationSettings';
2
- import type { ListPropertyItem } from './ListPropertyItem';
3
- /**
4
- * Describes a property list item that can contain integers.
5
- */
6
- export type IntegerListItem = (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?: Int32EnumerationSettings;
16
- });
1
+ import type { Int32EnumerationSettings } from './Int32EnumerationSettings';
2
+ import type { ListPropertyItem } from './ListPropertyItem';
3
+ /**
4
+ * Describes a property list item that can contain integers.
5
+ */
6
+ export type IntegerListItem = (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?: Int32EnumerationSettings;
16
+ });
@@ -1,16 +1,16 @@
1
- import type { ContentTypeProperty } from './ContentTypeProperty';
2
- import type { Int32EnumerationSettings } from './Int32EnumerationSettings';
3
- /**
4
- * Describes a property that can contain an integer.
5
- */
6
- export type IntegerProperty = (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?: Int32EnumerationSettings;
16
- });
1
+ import type { ContentTypeProperty } from './ContentTypeProperty';
2
+ import type { Int32EnumerationSettings } from './Int32EnumerationSettings';
3
+ /**
4
+ * Describes a property that can contain an integer.
5
+ */
6
+ export type IntegerProperty = (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?: Int32EnumerationSettings;
16
+ });
@@ -1,5 +1,5 @@
1
- import type { ContentTypeProperty } from './ContentTypeProperty';
2
- /**
3
- * Describes a property that can contain a JSON value in the form of a string.
4
- */
5
- export type JsonStringProperty = ContentTypeProperty;
1
+ import type { ContentTypeProperty } from './ContentTypeProperty';
2
+ /**
3
+ * Describes a property that can contain a JSON value in the form of a string.
4
+ */
5
+ export type JsonStringProperty = ContentTypeProperty;
@@ -1,26 +1,26 @@
1
- import type { ComponentListItem } from './ComponentListItem';
2
- import type { ContentListItem } from './ContentListItem';
3
- import type { ContentReferenceListItem } from './ContentReferenceListItem';
4
- import type { ContentTypeProperty } from './ContentTypeProperty';
5
- import type { DateTimeListItem } from './DateTimeListItem';
6
- import type { FloatListItem } from './FloatListItem';
7
- import type { IntegerListItem } from './IntegerListItem';
8
- import type { StringListItem } from './StringListItem';
9
- import type { UrlListItem } from './UrlListItem';
10
- /**
11
- * A property in the CMS that may hold a list of items.
12
- */
13
- export type ListProperty = (ContentTypeProperty & {
14
- /**
15
- * Specifies the minimum number of items in this array property.
16
- */
17
- minItems?: number | null;
18
- /**
19
- * Specifies the maximum number of items in this array property.
20
- */
21
- maxItems?: number | null;
22
- /**
23
- * Describes the list item of a ListProperty in the CMS.
24
- */
25
- items: (ComponentListItem | ContentListItem | ContentReferenceListItem | DateTimeListItem | FloatListItem | IntegerListItem | StringListItem | UrlListItem);
26
- });
1
+ import type { ComponentListItem } from './ComponentListItem';
2
+ import type { ContentListItem } from './ContentListItem';
3
+ import type { ContentReferenceListItem } from './ContentReferenceListItem';
4
+ import type { ContentTypeProperty } from './ContentTypeProperty';
5
+ import type { DateTimeListItem } from './DateTimeListItem';
6
+ import type { FloatListItem } from './FloatListItem';
7
+ import type { IntegerListItem } from './IntegerListItem';
8
+ import type { StringListItem } from './StringListItem';
9
+ import type { UrlListItem } from './UrlListItem';
10
+ /**
11
+ * A property in the CMS that may hold a list of items.
12
+ */
13
+ export type ListProperty = (ContentTypeProperty & {
14
+ /**
15
+ * Specifies the minimum number of items in this array property.
16
+ */
17
+ minItems?: number | null;
18
+ /**
19
+ * Specifies the maximum number of items in this array property.
20
+ */
21
+ maxItems?: number | null;
22
+ /**
23
+ * Describes the list item of a ListProperty in the CMS.
24
+ */
25
+ items: (ComponentListItem | ContentListItem | ContentReferenceListItem | DateTimeListItem | FloatListItem | IntegerListItem | StringListItem | UrlListItem);
26
+ });
@@ -1,11 +1,11 @@
1
- import type { PropertyDataType } from './PropertyDataType';
2
- /**
3
- * Describes the list item of a ListProperty in the CMS.
4
- */
5
- export type ListPropertyItem = {
6
- type: PropertyDataType;
7
- /**
8
- * The key of the PropertyFormat that this property item is an instance of.
9
- */
10
- format?: string | null;
11
- };
1
+ import type { PropertyDataType } from './PropertyDataType';
2
+ /**
3
+ * Describes the list item of a ListProperty in the CMS.
4
+ */
5
+ export type ListPropertyItem = {
6
+ type: PropertyDataType;
7
+ /**
8
+ * The key of the PropertyFormat that this property item is an instance of.
9
+ */
10
+ format?: string | null;
11
+ };
@@ -1,7 +1,7 @@
1
- /**
2
- * Represent the different status values of a content locale.
3
- */
4
- export declare enum LocaleStatus {
5
- DRAFT = "draft",
6
- PUBLISHED = "published"
7
- }
1
+ /**
2
+ * Represent the different status values of a content locale.
3
+ */
4
+ export declare enum LocaleStatus {
5
+ DRAFT = "draft",
6
+ PUBLISHED = "published"
7
+ }
@@ -1,19 +1,19 @@
1
- import type { ContentType } from './ContentType';
2
- import type { PropertyGroup } from './PropertyGroup';
3
- /**
4
- * Manifest that describest CMS definitions.
5
- */
6
- export type Manifest = {
7
- /**
8
- * List of content type property groups.
9
- */
10
- propertyGroups?: Array<PropertyGroup>;
11
- /**
12
- * List of content types.
13
- */
14
- contentTypes?: Array<ContentType>;
15
- /**
16
- * A timestamp indicated when any item in this manifest was last modified.
17
- */
18
- readonly lastModified?: string;
19
- };
1
+ import type { ContentType } from './ContentType';
2
+ import type { PropertyGroup } from './PropertyGroup';
3
+ /**
4
+ * Manifest that describest CMS definitions.
5
+ */
6
+ export type Manifest = {
7
+ /**
8
+ * List of content type property groups.
9
+ */
10
+ propertyGroups?: Array<PropertyGroup>;
11
+ /**
12
+ * List of content types.
13
+ */
14
+ contentTypes?: Array<ContentType>;
15
+ /**
16
+ * A timestamp indicated when any item in this manifest was last modified.
17
+ */
18
+ readonly lastModified?: string;
19
+ };
@@ -1,18 +1,18 @@
1
- /**
2
- * Represents an OAuth JSON Web Token (JWT) and
3
- * its expiry in seconds.
4
- */
5
- export type OauthToken = {
6
- /**
7
- * Gets or sets the access token.
8
- */
9
- access_token?: string | null;
10
- /**
11
- * Gets or sets the expiry time in seconds.
12
- */
13
- expires_in?: number;
14
- /**
15
- * Gets or sets the token type.
16
- */
17
- token_type?: string;
18
- };
1
+ /**
2
+ * Represents an OAuth JSON Web Token (JWT) and
3
+ * its expiry in seconds.
4
+ */
5
+ export type OauthToken = {
6
+ /**
7
+ * Gets or sets the access token.
8
+ */
9
+ access_token?: string | null;
10
+ /**
11
+ * Gets or sets the expiry time in seconds.
12
+ */
13
+ expires_in?: number;
14
+ /**
15
+ * Gets or sets the token type.
16
+ */
17
+ token_type?: string;
18
+ };
@@ -1,13 +1,13 @@
1
- /**
2
- * Represents an OAuth error.
3
- */
4
- export type OauthTokenError = {
5
- /**
6
- * Gets or sets the error.
7
- */
8
- error?: string | null;
9
- /**
10
- * Gets or sets the error description.
11
- */
12
- error_description?: string | null;
13
- };
1
+ /**
2
+ * Represents an OAuth error.
3
+ */
4
+ export type OauthTokenError = {
5
+ /**
6
+ * Gets or sets the error.
7
+ */
8
+ error?: string | null;
9
+ /**
10
+ * Gets or sets the error description.
11
+ */
12
+ error_description?: string | null;
13
+ };
@@ -1,21 +1,21 @@
1
- /**
2
- * Represents an OAuth token request.
3
- */
4
- export type OauthTokenRequest = {
5
- /**
6
- * Gets or sets the grant type.
7
- */
8
- grant_type?: string | null;
9
- /**
10
- * Gets or sets the client id.
11
- */
12
- client_id?: string | null;
13
- /**
14
- * Gets or sets the client secret.
15
- */
16
- client_secret?: string | null;
17
- /**
18
- * Get or sets the subject to act as.
19
- */
20
- act_as?: string | null;
21
- };
1
+ /**
2
+ * Represents an OAuth token request.
3
+ */
4
+ export type OauthTokenRequest = {
5
+ /**
6
+ * Gets or sets the grant type.
7
+ */
8
+ grant_type?: string | null;
9
+ /**
10
+ * Gets or sets the client id.
11
+ */
12
+ client_id?: string | null;
13
+ /**
14
+ * Gets or sets the client secret.
15
+ */
16
+ client_secret?: string | null;
17
+ /**
18
+ * Get or sets the subject to act as.
19
+ */
20
+ act_as?: string | null;
21
+ };
@@ -1,28 +1,28 @@
1
- import type { PackageJobMessage } from './PackageJobMessage';
2
- import type { PackageJobStatus } from './PackageJobStatus';
3
- /**
4
- * Describes the status of a package job.
5
- */
6
- export type PackageJob = {
7
- /**
8
- * An unique key that can be used to track the staus of a package job.
9
- */
10
- readonly key?: string;
11
- status?: PackageJobStatus;
12
- /**
13
- * List of messages describing the outcome from the package job.
14
- */
15
- outcomes?: Array<PackageJobMessage>;
16
- /**
17
- * List of error messages from the package job.
18
- */
19
- errors?: Array<PackageJobMessage>;
20
- /**
21
- * List of warning messages from the package job.
22
- */
23
- warnings?: Array<PackageJobMessage>;
24
- /**
25
- * A timestamp indicates when this task was first created.
26
- */
27
- readonly created?: string;
28
- };
1
+ import type { PackageJobMessage } from './PackageJobMessage';
2
+ import type { PackageJobStatus } from './PackageJobStatus';
3
+ /**
4
+ * Describes the status of a package job.
5
+ */
6
+ export type PackageJob = {
7
+ /**
8
+ * An unique key that can be used to track the staus of a package job.
9
+ */
10
+ readonly key?: string;
11
+ status?: PackageJobStatus;
12
+ /**
13
+ * List of messages describing the outcome from the package job.
14
+ */
15
+ outcomes?: Array<PackageJobMessage>;
16
+ /**
17
+ * List of error messages from the package job.
18
+ */
19
+ errors?: Array<PackageJobMessage>;
20
+ /**
21
+ * List of warning messages from the package job.
22
+ */
23
+ warnings?: Array<PackageJobMessage>;
24
+ /**
25
+ * A timestamp indicates when this task was first created.
26
+ */
27
+ readonly created?: string;
28
+ };
@@ -1,17 +1,17 @@
1
- /**
2
- * Describes a status message from a package job.
3
- */
4
- export type PackageJobMessage = {
5
- /**
6
- * The section where the message originated from.
7
- */
8
- readonly section?: string;
9
- /**
10
- * The message describing an outcome.
11
- */
12
- readonly message?: string;
13
- /**
14
- * The identifier of the resource that was the reason for this message to be created.
15
- */
16
- readonly identifier?: string | null;
17
- };
1
+ /**
2
+ * Describes a status message from a package job.
3
+ */
4
+ export type PackageJobMessage = {
5
+ /**
6
+ * The section where the message originated from.
7
+ */
8
+ readonly section?: string;
9
+ /**
10
+ * The message describing an outcome.
11
+ */
12
+ readonly message?: string;
13
+ /**
14
+ * The identifier of the resource that was the reason for this message to be created.
15
+ */
16
+ readonly identifier?: string | null;
17
+ };
@@ -1,4 +1,4 @@
1
- /**
2
- * Represent the status of a package job.
3
- */
4
- export type PackageJobStatus = Record<string, any>;
1
+ /**
2
+ * Represent the status of a package job.
3
+ */
4
+ export type PackageJobStatus = Record<string, any>;
@@ -1 +1 @@
1
- export type ProblemDetails = Record<string, any>;
1
+ export type ProblemDetails = Record<string, any>;
@@ -1,18 +1,18 @@
1
- /**
2
- * Represent the basic type that a PropertyFormat
3
- * is using for data storage and data transport.
4
- */
5
- export declare enum PropertyDataType {
6
- STRING = "string",
7
- URL = "url",
8
- BOOLEAN = "boolean",
9
- INTEGER = "integer",
10
- FLOAT = "float",
11
- DATE_TIME = "dateTime",
12
- CONTENT_REFERENCE = "contentReference",
13
- CONTENT = "content",
14
- BINARY = "binary",
15
- JSON = "json",
16
- ARRAY = "array",
17
- COMPONENT = "component"
18
- }
1
+ /**
2
+ * Represent the basic type that a PropertyFormat
3
+ * is using for data storage and data transport.
4
+ */
5
+ export declare enum PropertyDataType {
6
+ STRING = "string",
7
+ URL = "url",
8
+ BOOLEAN = "boolean",
9
+ INTEGER = "integer",
10
+ FLOAT = "float",
11
+ DATE_TIME = "dateTime",
12
+ CONTENT_REFERENCE = "contentReference",
13
+ CONTENT = "content",
14
+ BINARY = "binary",
15
+ JSON = "json",
16
+ ARRAY = "array",
17
+ COMPONENT = "component"
18
+ }
@@ -1,34 +1,34 @@
1
- import type { PropertyDataType } from './PropertyDataType';
2
- /**
3
- * Represent the definition of semantic property formats for content items.
4
- */
5
- export type PropertyFormat = {
6
- /**
7
- * The key that identifies this PropertyFormat.
8
- */
9
- key?: string;
10
- dataType?: PropertyDataType;
11
- itemType?: PropertyDataType;
12
- /**
13
- * The name and identifier of this PropertyFormat.
14
- */
15
- displayName?: string;
16
- /**
17
- * Editor used for managing properties with this format.
18
- */
19
- editor?: string | null;
20
- deleted?: boolean;
21
- /**
22
- * Settings for the editor.
23
- */
24
- editorSettings?: Record<string, Record<string, any>> | null;
25
- /**
26
- * Enumerations for the format.
27
- */
28
- enum?: {
29
- values?: Array<{
30
- value?: (string | number);
31
- displayName?: string;
32
- }>;
33
- } | null;
34
- };
1
+ import type { PropertyDataType } from './PropertyDataType';
2
+ /**
3
+ * Represent the definition of semantic property formats for content items.
4
+ */
5
+ export type PropertyFormat = {
6
+ /**
7
+ * The key that identifies this PropertyFormat.
8
+ */
9
+ key?: string;
10
+ dataType?: PropertyDataType;
11
+ itemType?: PropertyDataType;
12
+ /**
13
+ * The name and identifier of this PropertyFormat.
14
+ */
15
+ displayName?: string;
16
+ /**
17
+ * Editor used for managing properties with this format.
18
+ */
19
+ editor?: string | null;
20
+ deleted?: boolean;
21
+ /**
22
+ * Settings for the editor.
23
+ */
24
+ editorSettings?: Record<string, Record<string, any>> | null;
25
+ /**
26
+ * Enumerations for the format.
27
+ */
28
+ enum?: {
29
+ values?: Array<{
30
+ value?: (string | number);
31
+ displayName?: string;
32
+ }>;
33
+ } | null;
34
+ };