@remkoj/optimizely-cms-api 6.0.0-pre7 → 6.0.0-pre9
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/LICENSE +12 -12
- package/README.md +3 -5
- package/dist/api-client.d.ts +22 -7
- package/dist/api-client.js +92 -40
- package/dist/client/client/{client.d.ts → client.gen.d.ts} +1 -1
- package/dist/client/client/{client.js → client.gen.js} +88 -29
- package/dist/client/client/index.d.ts +8 -7
- package/dist/client/client/index.js +15 -12
- package/dist/client/client/{types.d.ts → types.gen.d.ts} +18 -13
- package/dist/client/{core/types.js → client/types.gen.js} +1 -0
- package/dist/client/client/{utils.d.ts → utils.gen.d.ts} +8 -20
- package/dist/client/client/{utils.js → utils.gen.js} +61 -116
- package/dist/client/client.gen.d.ts +3 -3
- package/dist/client/client.gen.js +1 -1
- package/dist/client/core/{auth.js → auth.gen.js} +1 -0
- package/dist/client/core/{bodySerializer.d.ts → bodySerializer.gen.d.ts} +1 -1
- package/dist/client/core/{bodySerializer.js → bodySerializer.gen.js} +4 -0
- package/dist/client/core/{params.d.ts → params.gen.d.ts} +10 -0
- package/dist/client/core/{params.js → params.gen.js} +1 -0
- package/dist/client/core/{pathSerializer.js → pathSerializer.gen.js} +1 -0
- package/dist/client/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/client/core/queryKeySerializer.gen.js +105 -0
- package/dist/client/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/client/core/serverSentEvents.gen.js +139 -0
- package/dist/client/core/{types.d.ts → types.gen.d.ts} +19 -14
- package/dist/client/{client/types.js → core/types.gen.js} +1 -0
- package/dist/client/core/utils.gen.d.ts +19 -0
- package/dist/client/core/utils.gen.js +93 -0
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.js +1 -2
- package/dist/client/sdk.gen.d.ts +11 -167
- package/dist/client/sdk.gen.js +17 -421
- package/dist/client/transformers.gen.d.ts +8 -24
- package/dist/client/transformers.gen.js +77 -193
- package/dist/client/types.gen.d.ts +520 -1919
- package/dist/client/types.gen.js +0 -84
- package/dist/client-config.d.ts +5 -2
- package/dist/client-config.js +42 -14
- package/dist/config.d.ts +2 -3
- package/dist/config.js +13 -42
- package/dist/getaccesstoken.d.ts +1 -1
- package/dist/getaccesstoken.js +9 -7
- package/dist/index.d.ts +4 -1
- package/dist/index.js +9 -2
- package/dist/instance.client/client/client.gen.d.ts +2 -0
- package/dist/instance.client/client/client.gen.js +208 -0
- package/dist/instance.client/client/index.d.ts +8 -0
- package/dist/instance.client/client/index.js +17 -0
- package/dist/instance.client/client/types.gen.d.ts +124 -0
- package/dist/instance.client/client/types.gen.js +3 -0
- package/dist/instance.client/client/utils.gen.d.ts +33 -0
- package/dist/instance.client/client/utils.gen.js +241 -0
- package/dist/instance.client/client.gen.d.ts +12 -0
- package/dist/instance.client/client.gen.js +9 -0
- package/dist/instance.client/core/auth.gen.d.ts +18 -0
- package/dist/instance.client/core/auth.gen.js +18 -0
- package/dist/instance.client/core/bodySerializer.gen.d.ts +17 -0
- package/dist/instance.client/core/bodySerializer.gen.js +60 -0
- package/dist/instance.client/core/params.gen.d.ts +33 -0
- package/dist/instance.client/core/params.gen.js +92 -0
- package/dist/instance.client/core/pathSerializer.gen.d.ts +33 -0
- package/dist/instance.client/core/pathSerializer.gen.js +123 -0
- package/dist/instance.client/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/instance.client/core/queryKeySerializer.gen.js +105 -0
- package/dist/instance.client/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/instance.client/core/serverSentEvents.gen.js +139 -0
- package/dist/instance.client/core/types.gen.d.ts +78 -0
- package/dist/instance.client/core/types.gen.js +3 -0
- package/dist/instance.client/core/utils.gen.d.ts +19 -0
- package/dist/instance.client/core/utils.gen.js +93 -0
- package/dist/instance.client/index.d.ts +4 -0
- package/dist/instance.client/index.js +21 -0
- package/dist/instance.client/sdk.gen.d.ts +256 -0
- package/dist/instance.client/sdk.gen.js +638 -0
- package/dist/instance.client/transformers.gen.d.ts +34 -0
- package/dist/instance.client/transformers.gen.js +273 -0
- package/dist/instance.client/types.gen.d.ts +2838 -0
- package/dist/instance.client/types.gen.js +3 -0
- package/dist/types.d.ts +3 -1
- package/dist/types.js +1 -0
- package/dist/version.json +3 -3
- package/package.json +8 -12
- /package/dist/client/core/{auth.d.ts → auth.gen.d.ts} +0 -0
- /package/dist/client/core/{pathSerializer.d.ts → pathSerializer.gen.d.ts} +0 -0
|
@@ -1,292 +1,213 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
*/
|
|
4
|
-
export type BinaryProperty = ContentTypeProperty & {
|
|
5
|
-
type: 'BinaryProperty';
|
|
6
|
-
} & {
|
|
7
|
-
imageDescriptor?: ImageDescriptor;
|
|
8
|
-
};
|
|
9
|
-
/**
|
|
10
|
-
* Describes a property that can contain a boolean value.
|
|
11
|
-
*/
|
|
12
|
-
export type BooleanProperty = ContentTypeProperty & {
|
|
13
|
-
type: 'BooleanProperty';
|
|
14
|
-
} & {
|
|
15
|
-
[key: string]: never;
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseUrl: 'https://api.cms.optimizely.com/preview3' | (string & {});
|
|
16
3
|
};
|
|
17
4
|
/**
|
|
18
|
-
*
|
|
5
|
+
* Describes the list item of a content type property of type 'array'.
|
|
19
6
|
*/
|
|
20
|
-
export type
|
|
7
|
+
export type ArrayItem = {
|
|
21
8
|
/**
|
|
22
|
-
*
|
|
9
|
+
* Gets the data type for the list item property.
|
|
23
10
|
*/
|
|
24
|
-
|
|
11
|
+
type?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'component';
|
|
25
12
|
/**
|
|
26
|
-
* The
|
|
13
|
+
* The key of the PropertyFormat that this property item is an instance of.
|
|
27
14
|
*/
|
|
28
|
-
|
|
15
|
+
format?: string | null;
|
|
29
16
|
/**
|
|
30
|
-
* The
|
|
17
|
+
* The key of the content type that a property with 'type': 'component' may contain.
|
|
31
18
|
*/
|
|
32
|
-
|
|
19
|
+
contentType?: string | null;
|
|
33
20
|
/**
|
|
34
|
-
*
|
|
21
|
+
* The minimum value that properties of this type should be able to contain. Value type must match the type of the array item.
|
|
35
22
|
*/
|
|
36
|
-
|
|
23
|
+
minimum?: number | null | number | string;
|
|
37
24
|
/**
|
|
38
|
-
* The
|
|
25
|
+
* The maximum value that properties of this type should be able to contain. Value type must match the type of the array item.
|
|
39
26
|
*/
|
|
40
|
-
|
|
41
|
-
lastModified?: Date;
|
|
42
|
-
};
|
|
43
|
-
/**
|
|
44
|
-
* Items in an changeset that contains a link to the specific content version.
|
|
45
|
-
*/
|
|
46
|
-
export type ChangesetItem = {
|
|
47
|
-
reference: ContentReference;
|
|
27
|
+
maximum?: number | null | number | string;
|
|
48
28
|
/**
|
|
49
|
-
*
|
|
29
|
+
* The minimum string length that list items of this type should be able to contain.
|
|
50
30
|
*/
|
|
51
|
-
|
|
52
|
-
};
|
|
53
|
-
export type ChangesetItemPage = {
|
|
31
|
+
minLength?: number | null;
|
|
54
32
|
/**
|
|
55
|
-
* The items
|
|
33
|
+
* The maximum string length that list items of this type should be able to contain.
|
|
56
34
|
*/
|
|
57
|
-
|
|
35
|
+
maxLength?: number | null;
|
|
58
36
|
/**
|
|
59
|
-
*
|
|
37
|
+
* Regular expression pattern that limits what strings that list items of this type should be able to contain.
|
|
60
38
|
*/
|
|
61
|
-
|
|
39
|
+
pattern?: string | null;
|
|
62
40
|
/**
|
|
63
|
-
*
|
|
41
|
+
* A list of possible values that properties of this type should be able to contain.
|
|
64
42
|
*/
|
|
65
|
-
|
|
43
|
+
enum?: Array<EnumerationValue> | null;
|
|
66
44
|
/**
|
|
67
|
-
*
|
|
45
|
+
* Specifies which content types and base types this property is allowed to contain.
|
|
68
46
|
*/
|
|
69
|
-
|
|
47
|
+
allowedTypes?: Array<string>;
|
|
48
|
+
/**
|
|
49
|
+
* Specifies which content types and base types this property cannot contain.
|
|
50
|
+
*/
|
|
51
|
+
restrictedTypes?: Array<string>;
|
|
70
52
|
};
|
|
71
|
-
|
|
53
|
+
/**
|
|
54
|
+
* A writable implementation of an ContentType.
|
|
55
|
+
*/
|
|
56
|
+
export type ContentType = {
|
|
72
57
|
/**
|
|
73
|
-
* The
|
|
58
|
+
* The key that identifies this ContentType.
|
|
74
59
|
*/
|
|
75
|
-
|
|
60
|
+
key?: string;
|
|
76
61
|
/**
|
|
77
|
-
* The
|
|
62
|
+
* The display name of this ContentType.
|
|
78
63
|
*/
|
|
79
|
-
|
|
64
|
+
displayName?: string;
|
|
80
65
|
/**
|
|
81
|
-
*
|
|
66
|
+
* A description of this ContentType.
|
|
82
67
|
*/
|
|
83
|
-
|
|
68
|
+
description?: string;
|
|
84
69
|
/**
|
|
85
|
-
* The
|
|
70
|
+
* The base type of this ContentType.
|
|
71
|
+
* Ignored for contracts; required for all other content types.
|
|
86
72
|
*/
|
|
87
|
-
|
|
88
|
-
};
|
|
89
|
-
/**
|
|
90
|
-
* Describes a property list item that can contain a component instance of a specific type.
|
|
91
|
-
*/
|
|
92
|
-
export type ComponentListItem = ListPropertyItem & {
|
|
93
|
-
type: 'ComponentListItem';
|
|
94
|
-
} & {
|
|
73
|
+
baseType?: string | null;
|
|
95
74
|
/**
|
|
96
|
-
*
|
|
75
|
+
* A string that is used to indicate the source of this ContentType.
|
|
97
76
|
*/
|
|
98
|
-
|
|
99
|
-
};
|
|
100
|
-
/**
|
|
101
|
-
* Describes a property that can contain a component instance of a specific type.
|
|
102
|
-
*/
|
|
103
|
-
export type ComponentProperty = ContentTypeProperty & {
|
|
104
|
-
type: 'ComponentProperty';
|
|
105
|
-
} & {
|
|
77
|
+
readonly source?: string;
|
|
106
78
|
/**
|
|
107
|
-
*
|
|
79
|
+
* A value that is used to when sorting ContentType instances.
|
|
108
80
|
*/
|
|
109
|
-
|
|
110
|
-
};
|
|
111
|
-
/**
|
|
112
|
-
* Represent a Composition behavior for a ContentType.
|
|
113
|
-
*/
|
|
114
|
-
export type CompositionBehavior = 'sectionEnabled' | 'elementEnabled';
|
|
115
|
-
/**
|
|
116
|
-
* Represent a Composition behavior for a ContentType.
|
|
117
|
-
*/
|
|
118
|
-
export declare const CompositionBehavior: {
|
|
119
|
-
readonly SECTION_ENABLED: "sectionEnabled";
|
|
120
|
-
readonly ELEMENT_ENABLED: "elementEnabled";
|
|
121
|
-
};
|
|
122
|
-
/**
|
|
123
|
-
* Represent the base type of a ContentType.
|
|
124
|
-
*/
|
|
125
|
-
export type ContentBaseType = 'page' | 'component' | 'media' | 'image' | 'video' | 'folder' | 'experience' | 'section' | 'element';
|
|
126
|
-
/**
|
|
127
|
-
* Represent the base type of a ContentType.
|
|
128
|
-
*/
|
|
129
|
-
export declare const ContentBaseType: {
|
|
130
|
-
readonly PAGE: "page";
|
|
131
|
-
readonly COMPONENT: "component";
|
|
132
|
-
readonly MEDIA: "media";
|
|
133
|
-
readonly IMAGE: "image";
|
|
134
|
-
readonly VIDEO: "video";
|
|
135
|
-
readonly FOLDER: "folder";
|
|
136
|
-
readonly EXPERIENCE: "experience";
|
|
137
|
-
readonly SECTION: "section";
|
|
138
|
-
readonly ELEMENT: "element";
|
|
139
|
-
};
|
|
140
|
-
/**
|
|
141
|
-
* Represents a content component.
|
|
142
|
-
*/
|
|
143
|
-
export type ContentComponent = {
|
|
81
|
+
sortOrder?: number;
|
|
144
82
|
/**
|
|
145
|
-
*
|
|
83
|
+
* Provides a set of content types that can be created in containers of this type
|
|
146
84
|
*/
|
|
147
|
-
|
|
85
|
+
mayContainTypes?: Array<string>;
|
|
148
86
|
/**
|
|
149
|
-
*
|
|
87
|
+
* Provides a set of media file extensions that this content type can handle.
|
|
150
88
|
*/
|
|
151
|
-
|
|
89
|
+
mediaFileExtensions?: Array<string>;
|
|
152
90
|
/**
|
|
153
|
-
*
|
|
91
|
+
* Provides a set of composition behaviors specifying how this content type can be used within compositions.
|
|
154
92
|
*/
|
|
155
|
-
|
|
93
|
+
compositionBehaviors?: Array<'sectionEnabled' | 'elementEnabled' | 'formsElementEnabled'>;
|
|
156
94
|
/**
|
|
157
|
-
*
|
|
95
|
+
* A timestamp indicating when this ContentType was first created.
|
|
158
96
|
*/
|
|
159
|
-
|
|
160
|
-
reference?: string;
|
|
97
|
+
readonly created?: Date;
|
|
161
98
|
/**
|
|
162
|
-
*
|
|
99
|
+
* Indicates the last time this content type was modified.
|
|
163
100
|
*/
|
|
164
|
-
|
|
101
|
+
readonly lastModified?: Date;
|
|
165
102
|
/**
|
|
166
|
-
*
|
|
103
|
+
* The username of the user that made the latest modification to this ContentType.
|
|
167
104
|
*/
|
|
168
|
-
|
|
169
|
-
};
|
|
170
|
-
/**
|
|
171
|
-
* Represents a version of a content item.
|
|
172
|
-
*/
|
|
173
|
-
export type ContentItem = {
|
|
105
|
+
readonly lastModifiedBy?: string;
|
|
174
106
|
/**
|
|
175
|
-
*
|
|
107
|
+
* Dictionary with all custom properties of this ContentType.
|
|
176
108
|
*/
|
|
177
109
|
properties?: {
|
|
178
|
-
[key: string]:
|
|
110
|
+
[key: string]: ContentTypeProperty;
|
|
179
111
|
};
|
|
112
|
+
};
|
|
113
|
+
export type ContentTypePage = {
|
|
180
114
|
/**
|
|
181
|
-
* The
|
|
115
|
+
* The items in this paged collection.
|
|
182
116
|
*/
|
|
183
|
-
readonly
|
|
117
|
+
readonly items?: Array<ContentType>;
|
|
184
118
|
/**
|
|
185
|
-
* The
|
|
119
|
+
* The zero-based index of the current page.
|
|
186
120
|
*/
|
|
187
|
-
readonly
|
|
121
|
+
readonly pageIndex?: number;
|
|
188
122
|
/**
|
|
189
|
-
* The
|
|
123
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
190
124
|
*/
|
|
191
|
-
readonly
|
|
125
|
+
readonly pageSize?: number;
|
|
192
126
|
/**
|
|
193
|
-
* The
|
|
127
|
+
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
194
128
|
*/
|
|
195
|
-
readonly
|
|
129
|
+
readonly totalItemCount?: number;
|
|
130
|
+
};
|
|
131
|
+
/**
|
|
132
|
+
* Describes a property of a ContentType in the CMS.
|
|
133
|
+
*/
|
|
134
|
+
export type ContentTypeProperty = {
|
|
196
135
|
/**
|
|
197
|
-
*
|
|
136
|
+
* Gets the data type for the property.
|
|
198
137
|
*/
|
|
199
|
-
|
|
138
|
+
type?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
200
139
|
/**
|
|
201
|
-
*
|
|
140
|
+
* The key of the PropertyFormat that this ContentTypeProperty is an instance of.
|
|
202
141
|
*/
|
|
203
|
-
|
|
142
|
+
format?: string | null;
|
|
204
143
|
/**
|
|
205
|
-
*
|
|
144
|
+
* The key of the content type that a property with 'type': 'component' may contain.
|
|
206
145
|
*/
|
|
207
|
-
|
|
208
|
-
status?: VersionStatus;
|
|
146
|
+
contentType?: string | null;
|
|
209
147
|
/**
|
|
210
|
-
*
|
|
148
|
+
* The display name of this ContentTypeProperty.
|
|
211
149
|
*/
|
|
212
|
-
|
|
150
|
+
displayName?: string;
|
|
213
151
|
/**
|
|
214
|
-
*
|
|
152
|
+
* A description of this ContentTypeProperty.
|
|
215
153
|
*/
|
|
216
|
-
|
|
154
|
+
description?: string;
|
|
217
155
|
/**
|
|
218
|
-
*
|
|
156
|
+
* Indicates if a property instance of this type should be localized for each locale
|
|
157
|
+
* or if values are shared between all locales.
|
|
219
158
|
*/
|
|
220
|
-
|
|
159
|
+
localized?: boolean;
|
|
221
160
|
/**
|
|
222
|
-
*
|
|
161
|
+
* Indicates if a property instance of this type must always be assigned a value.
|
|
223
162
|
*/
|
|
224
|
-
|
|
225
|
-
lastModified?: Date;
|
|
163
|
+
required?: boolean;
|
|
226
164
|
/**
|
|
227
|
-
*
|
|
165
|
+
* A reference to the PropertyGroup that this ContentTypeProperty is part of.
|
|
166
|
+
* If this value is empty, a group may be assigned by the system.
|
|
228
167
|
*/
|
|
229
|
-
|
|
230
|
-
};
|
|
231
|
-
/**
|
|
232
|
-
* The response object for Page`1 when used ContentType are included.
|
|
233
|
-
*/
|
|
234
|
-
export type ContentItemListWithContentTypes = {
|
|
168
|
+
group?: string;
|
|
235
169
|
/**
|
|
236
|
-
*
|
|
170
|
+
* An value that is used to when sorting ContentTypeProperty instances.
|
|
237
171
|
*/
|
|
238
|
-
|
|
172
|
+
sortOrder?: number;
|
|
239
173
|
/**
|
|
240
|
-
*
|
|
174
|
+
* Indicates how should this property will be indexed in the search engine.
|
|
175
|
+
* If this value is not explicitly set, the property will be indexed using default indexing setting of the search engine.
|
|
241
176
|
*/
|
|
242
|
-
|
|
177
|
+
indexingType?: 'disabled' | 'queryable' | 'searchable';
|
|
243
178
|
/**
|
|
244
|
-
* The
|
|
179
|
+
* The minimum value that properties of this type should be able to contain. Value type must match the type of the property.
|
|
245
180
|
*/
|
|
246
|
-
|
|
181
|
+
minimum?: number | null | number | string;
|
|
247
182
|
/**
|
|
248
|
-
* The
|
|
183
|
+
* The minimum value that properties of this type should be able to contain. Value type must match the type of the property.
|
|
249
184
|
*/
|
|
250
|
-
|
|
185
|
+
maximum?: number | null | number | string;
|
|
251
186
|
/**
|
|
252
|
-
*
|
|
187
|
+
* A list of possible values that properties of this type should be able to contain.
|
|
253
188
|
*/
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
export type ContentItemPage = {
|
|
189
|
+
enum?: Array<EnumerationValue> | null;
|
|
190
|
+
imageDescriptor?: ImageDescriptor;
|
|
257
191
|
/**
|
|
258
|
-
* The
|
|
192
|
+
* The minimum string length that properties of this type should be able to contain.
|
|
259
193
|
*/
|
|
260
|
-
|
|
194
|
+
minLength?: number | null;
|
|
261
195
|
/**
|
|
262
|
-
* The
|
|
196
|
+
* The maximum string length that properties of this type should be able to contain.
|
|
263
197
|
*/
|
|
264
|
-
|
|
198
|
+
maxLength?: number | null;
|
|
265
199
|
/**
|
|
266
|
-
*
|
|
200
|
+
* Regular expression pattern that limits what value that a string type property should be able to contain.
|
|
267
201
|
*/
|
|
268
|
-
|
|
202
|
+
pattern?: string | null;
|
|
269
203
|
/**
|
|
270
|
-
*
|
|
204
|
+
* Optional minimum list length validation.
|
|
271
205
|
*/
|
|
272
|
-
|
|
273
|
-
};
|
|
274
|
-
/**
|
|
275
|
-
* The response object for ContentItem when used ContentType are included.
|
|
276
|
-
*/
|
|
277
|
-
export type ContentItemWithContentTypes = {
|
|
206
|
+
minItems?: number | null;
|
|
278
207
|
/**
|
|
279
|
-
*
|
|
208
|
+
* Optional maximum list length validation.
|
|
280
209
|
*/
|
|
281
|
-
|
|
282
|
-
item?: ContentItem;
|
|
283
|
-
};
|
|
284
|
-
/**
|
|
285
|
-
* Describes a property list item that can hold a content item.
|
|
286
|
-
*/
|
|
287
|
-
export type ContentListItem = ListPropertyItem & {
|
|
288
|
-
type: 'ContentListItem';
|
|
289
|
-
} & {
|
|
210
|
+
maxItems?: number | null;
|
|
290
211
|
/**
|
|
291
212
|
* Specifies which content types and base types these property items are allowed to contain.
|
|
292
213
|
*/
|
|
@@ -295,75 +216,106 @@ export type ContentListItem = ListPropertyItem & {
|
|
|
295
216
|
* Specifies which content types and base types these property items cannot contain.
|
|
296
217
|
*/
|
|
297
218
|
restrictedTypes?: Array<string>;
|
|
219
|
+
items?: ArrayItem;
|
|
298
220
|
};
|
|
299
221
|
/**
|
|
300
|
-
* Describes
|
|
222
|
+
* Describes a setting for a display template.
|
|
301
223
|
*/
|
|
302
|
-
export type
|
|
224
|
+
export type DisplaySetting = {
|
|
303
225
|
/**
|
|
304
|
-
* The display name of
|
|
226
|
+
* The display name of this display setting.
|
|
305
227
|
*/
|
|
306
|
-
|
|
228
|
+
displayName: string;
|
|
307
229
|
/**
|
|
308
|
-
* The
|
|
230
|
+
* The suggested editor for this display setting.
|
|
309
231
|
*/
|
|
310
|
-
|
|
232
|
+
editor?: string;
|
|
311
233
|
/**
|
|
312
|
-
* The
|
|
234
|
+
* The sort order of this display setting within the template.
|
|
313
235
|
*/
|
|
314
|
-
|
|
315
|
-
|
|
236
|
+
sortOrder?: number;
|
|
237
|
+
/**
|
|
238
|
+
* The available choices for this display setting.
|
|
239
|
+
*/
|
|
240
|
+
choices?: {
|
|
241
|
+
[key: string]: DisplaySettingChoice;
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
/**
|
|
245
|
+
* Describes a setting for a display template.
|
|
246
|
+
*/
|
|
247
|
+
export type DisplaySettingChoice = {
|
|
248
|
+
/**
|
|
249
|
+
* The display name of this display setting choice.
|
|
250
|
+
*/
|
|
251
|
+
displayName: string;
|
|
252
|
+
/**
|
|
253
|
+
* The sort order of this choice within the setting.
|
|
254
|
+
*/
|
|
255
|
+
sortOrder?: number;
|
|
316
256
|
};
|
|
317
257
|
/**
|
|
318
|
-
*
|
|
258
|
+
* Describes a display template that can be assigned to content.
|
|
319
259
|
*/
|
|
320
|
-
export type
|
|
260
|
+
export type DisplayTemplate = {
|
|
321
261
|
/**
|
|
322
|
-
* The key that identifies this
|
|
262
|
+
* The key that identifies this display template.
|
|
323
263
|
*/
|
|
324
264
|
key?: string;
|
|
325
265
|
/**
|
|
326
|
-
* The
|
|
266
|
+
* The display name of this display template.
|
|
267
|
+
*/
|
|
268
|
+
displayName: string;
|
|
269
|
+
/**
|
|
270
|
+
* The optional node type this display template is valid for.
|
|
271
|
+
*/
|
|
272
|
+
nodeType?: string | null;
|
|
273
|
+
/**
|
|
274
|
+
* The optional base type this display template is valid for.
|
|
327
275
|
*/
|
|
328
|
-
|
|
276
|
+
baseType?: string | null;
|
|
329
277
|
/**
|
|
330
|
-
*
|
|
278
|
+
* The optional key of the content type this display template is valid for.
|
|
331
279
|
*/
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
280
|
+
contentType?: string | null;
|
|
281
|
+
/**
|
|
282
|
+
* If this is the default display template for the associated base type, node type or content type.
|
|
283
|
+
*/
|
|
284
|
+
isDefault?: boolean;
|
|
335
285
|
/**
|
|
336
|
-
*
|
|
286
|
+
* A timestamp indicating when this display template was first created.
|
|
337
287
|
*/
|
|
338
|
-
|
|
288
|
+
readonly created?: Date;
|
|
339
289
|
/**
|
|
340
|
-
*
|
|
290
|
+
* The username of the user that created this display template.
|
|
341
291
|
*/
|
|
342
|
-
readonly
|
|
292
|
+
readonly createdBy?: string;
|
|
343
293
|
/**
|
|
344
|
-
*
|
|
294
|
+
* A timestamp indicating when this display template was last modified.
|
|
345
295
|
*/
|
|
346
|
-
|
|
296
|
+
readonly lastModified?: Date;
|
|
347
297
|
/**
|
|
348
|
-
*
|
|
298
|
+
* The username of the user that last modified this display template.
|
|
349
299
|
*/
|
|
350
|
-
readonly
|
|
300
|
+
readonly lastModifiedBy?: string;
|
|
351
301
|
/**
|
|
352
|
-
* The
|
|
302
|
+
* The available settings for this display template.
|
|
353
303
|
*/
|
|
354
|
-
|
|
304
|
+
settings?: {
|
|
305
|
+
[key: string]: DisplaySetting;
|
|
306
|
+
};
|
|
355
307
|
};
|
|
356
|
-
export type
|
|
308
|
+
export type DisplayTemplatePage = {
|
|
357
309
|
/**
|
|
358
310
|
* The items in this paged collection.
|
|
359
311
|
*/
|
|
360
|
-
readonly items?: Array<
|
|
312
|
+
readonly items?: Array<DisplayTemplate>;
|
|
361
313
|
/**
|
|
362
314
|
* The zero-based index of the current page.
|
|
363
315
|
*/
|
|
364
316
|
readonly pageIndex?: number;
|
|
365
317
|
/**
|
|
366
|
-
* The number of
|
|
318
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
367
319
|
*/
|
|
368
320
|
readonly pageSize?: number;
|
|
369
321
|
/**
|
|
@@ -372,190 +324,136 @@ export type ContentMetadataPage = {
|
|
|
372
324
|
readonly totalItemCount?: number;
|
|
373
325
|
};
|
|
374
326
|
/**
|
|
375
|
-
* Describes
|
|
327
|
+
* Describes one value in an enumeration of possible values.
|
|
376
328
|
*/
|
|
377
|
-
export type
|
|
378
|
-
type: 'ContentProperty';
|
|
379
|
-
} & {
|
|
329
|
+
export type EnumerationValue = {
|
|
380
330
|
/**
|
|
381
|
-
*
|
|
331
|
+
* The defined enumeration value. Value type must match the property type.
|
|
382
332
|
*/
|
|
383
|
-
|
|
333
|
+
value: number | null | number | string;
|
|
384
334
|
/**
|
|
385
|
-
*
|
|
335
|
+
* The display name of the enumeration value.
|
|
386
336
|
*/
|
|
387
|
-
|
|
337
|
+
displayName: string;
|
|
388
338
|
};
|
|
389
339
|
/**
|
|
390
|
-
*
|
|
340
|
+
* Instruction for generating an alternative image from the main binary of an image content item.
|
|
391
341
|
*/
|
|
392
|
-
export type
|
|
393
|
-
/**
|
|
394
|
-
* The content key that identifies the content.
|
|
395
|
-
*/
|
|
396
|
-
readonly key?: string;
|
|
397
|
-
/**
|
|
398
|
-
* The name of the content locale
|
|
399
|
-
*/
|
|
400
|
-
readonly locale?: string;
|
|
342
|
+
export type ImageDescriptor = {
|
|
401
343
|
/**
|
|
402
|
-
* The
|
|
344
|
+
* The image width in pixels.
|
|
403
345
|
*/
|
|
404
|
-
|
|
405
|
-
};
|
|
406
|
-
/**
|
|
407
|
-
* Describes a property list item that can hold a reference to a content item.
|
|
408
|
-
*/
|
|
409
|
-
export type ContentReferenceListItem = ListPropertyItem & {
|
|
410
|
-
type: 'ContentReferenceListItem';
|
|
411
|
-
} & {
|
|
346
|
+
width?: number;
|
|
412
347
|
/**
|
|
413
|
-
*
|
|
348
|
+
* The image height in pixels.
|
|
414
349
|
*/
|
|
415
|
-
|
|
350
|
+
height?: number;
|
|
416
351
|
/**
|
|
417
|
-
*
|
|
352
|
+
* Indicates if the image should be pre-generated when a new image is uploaded rather than when first requested.
|
|
418
353
|
*/
|
|
419
|
-
|
|
354
|
+
pregenerated?: boolean;
|
|
420
355
|
};
|
|
421
|
-
|
|
422
|
-
* Describes a property that can contain a reference to a content item.
|
|
423
|
-
*/
|
|
424
|
-
export type ContentReferenceProperty = ContentTypeProperty & {
|
|
425
|
-
type: 'ContentReferenceProperty';
|
|
426
|
-
} & {
|
|
427
|
-
/**
|
|
428
|
-
* Specifies which content types and base types this property is allowed to reference.
|
|
429
|
-
*/
|
|
430
|
-
allowedTypes?: Array<string>;
|
|
356
|
+
export type ProblemDetails = {
|
|
431
357
|
/**
|
|
432
|
-
*
|
|
358
|
+
* A URI reference that identifies the problem type.
|
|
433
359
|
*/
|
|
434
|
-
|
|
435
|
-
};
|
|
436
|
-
/**
|
|
437
|
-
* A writable implementation of an ContentType.
|
|
438
|
-
*/
|
|
439
|
-
export type ContentType = {
|
|
360
|
+
type?: string | null;
|
|
440
361
|
/**
|
|
441
|
-
*
|
|
362
|
+
* A short, human-readable summary of the problem type.
|
|
442
363
|
*/
|
|
443
|
-
|
|
364
|
+
title?: string | null;
|
|
444
365
|
/**
|
|
445
|
-
* The
|
|
366
|
+
* The HTTP status code generated by the origin server for this occurrence of the problem.
|
|
446
367
|
*/
|
|
447
|
-
|
|
368
|
+
status?: number | null;
|
|
448
369
|
/**
|
|
449
|
-
* A
|
|
370
|
+
* A human-readable explanation specific to this occurrence of the problem.
|
|
450
371
|
*/
|
|
451
|
-
|
|
452
|
-
baseType?: ContentBaseType;
|
|
372
|
+
detail?: string | null;
|
|
453
373
|
/**
|
|
454
|
-
* A
|
|
374
|
+
* A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
|
|
455
375
|
*/
|
|
456
|
-
|
|
376
|
+
instance?: string | null;
|
|
457
377
|
/**
|
|
458
|
-
*
|
|
378
|
+
* Error code that identifies the problem type.
|
|
459
379
|
*/
|
|
460
|
-
|
|
380
|
+
code?: string | null;
|
|
461
381
|
/**
|
|
462
|
-
*
|
|
463
|
-
* This value is assigned based on the BaseType and cannot be modified.
|
|
382
|
+
* An array of error details with more detailed information about the problem.
|
|
464
383
|
*/
|
|
465
|
-
|
|
384
|
+
errors?: Array<{
|
|
385
|
+
/**
|
|
386
|
+
* A granular explanation of one specific error related to a field, header or query parameter.
|
|
387
|
+
*/
|
|
388
|
+
detail?: string;
|
|
389
|
+
/**
|
|
390
|
+
* A string that may provide a hint to which field that was the source of the error.
|
|
391
|
+
*/
|
|
392
|
+
field?: string | null;
|
|
393
|
+
}> | null;
|
|
394
|
+
[key: string]: unknown | string | null | string | null | number | null | string | null | string | null | string | null | Array<{
|
|
395
|
+
/**
|
|
396
|
+
* A granular explanation of one specific error related to a field, header or query parameter.
|
|
397
|
+
*/
|
|
398
|
+
detail?: string;
|
|
399
|
+
/**
|
|
400
|
+
* A string that may provide a hint to which field that was the source of the error.
|
|
401
|
+
*/
|
|
402
|
+
field?: string | null;
|
|
403
|
+
}> | null | undefined;
|
|
404
|
+
};
|
|
405
|
+
/**
|
|
406
|
+
* Represent the definition of semantic property formats for content items.
|
|
407
|
+
*/
|
|
408
|
+
export type PropertyFormat = {
|
|
466
409
|
/**
|
|
467
|
-
*
|
|
410
|
+
* The key that identifies this PropertyFormat.
|
|
468
411
|
*/
|
|
469
|
-
|
|
412
|
+
key?: string;
|
|
470
413
|
/**
|
|
471
|
-
*
|
|
414
|
+
* The underlying data type used for this PropertyFormat.
|
|
472
415
|
*/
|
|
473
|
-
|
|
416
|
+
dataType?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
474
417
|
/**
|
|
475
|
-
*
|
|
418
|
+
* The underlying item type used for this PropertyFormat.
|
|
476
419
|
*/
|
|
477
|
-
|
|
420
|
+
itemType?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
478
421
|
/**
|
|
479
|
-
*
|
|
422
|
+
* The name and identifier of this PropertyFormat.
|
|
480
423
|
*/
|
|
481
|
-
|
|
424
|
+
displayName?: string;
|
|
482
425
|
/**
|
|
483
|
-
*
|
|
426
|
+
* Indicates if this property format has been deleted.
|
|
427
|
+
*/
|
|
428
|
+
readonly deleted?: boolean;
|
|
429
|
+
/**
|
|
430
|
+
* A timestamp indicating when this display template was first created.
|
|
484
431
|
*/
|
|
485
432
|
readonly created?: Date;
|
|
486
433
|
/**
|
|
487
|
-
*
|
|
434
|
+
* The username of the user that created this display template.
|
|
488
435
|
*/
|
|
489
|
-
readonly
|
|
436
|
+
readonly createdBy?: string;
|
|
490
437
|
/**
|
|
491
|
-
*
|
|
438
|
+
* A timestamp indicating when this display template was last modified.
|
|
492
439
|
*/
|
|
493
|
-
readonly
|
|
440
|
+
readonly lastModified?: Date;
|
|
494
441
|
/**
|
|
495
|
-
*
|
|
442
|
+
* The username of the user that last modified this display template.
|
|
496
443
|
*/
|
|
497
|
-
|
|
498
|
-
[key: string]: (({
|
|
499
|
-
type: 'BinaryProperty';
|
|
500
|
-
} & BinaryProperty) | ({
|
|
501
|
-
type: 'BooleanProperty';
|
|
502
|
-
} & BooleanProperty) | ({
|
|
503
|
-
type: 'ComponentProperty';
|
|
504
|
-
} & ComponentProperty) | ({
|
|
505
|
-
type: 'ContentProperty';
|
|
506
|
-
} & ContentProperty) | ({
|
|
507
|
-
type: 'ContentReferenceProperty';
|
|
508
|
-
} & ContentReferenceProperty) | ({
|
|
509
|
-
type: 'DateTimeProperty';
|
|
510
|
-
} & DateTimeProperty) | ({
|
|
511
|
-
type: 'FloatProperty';
|
|
512
|
-
} & FloatProperty) | ({
|
|
513
|
-
type: 'IntegerProperty';
|
|
514
|
-
} & IntegerProperty) | ({
|
|
515
|
-
type: 'StringProperty';
|
|
516
|
-
} & StringProperty) | ({
|
|
517
|
-
type: 'UrlProperty';
|
|
518
|
-
} & UrlProperty) | ({
|
|
519
|
-
type: 'JsonStringProperty';
|
|
520
|
-
} & JsonStringProperty) | ({
|
|
521
|
-
type: 'ListProperty';
|
|
522
|
-
} & ListProperty)) & {
|
|
523
|
-
/**
|
|
524
|
-
* Settings for the editor.
|
|
525
|
-
*/
|
|
526
|
-
editorSettings?: {
|
|
527
|
-
[key: string]: {
|
|
528
|
-
[key: string]: unknown;
|
|
529
|
-
};
|
|
530
|
-
} | null;
|
|
531
|
-
};
|
|
532
|
-
};
|
|
533
|
-
};
|
|
534
|
-
/**
|
|
535
|
-
* Represent different features that a content type can have.
|
|
536
|
-
*/
|
|
537
|
-
export type ContentTypeFeature = 'localization' | 'versioning' | 'publishPeriod' | 'routing' | 'binary';
|
|
538
|
-
/**
|
|
539
|
-
* Represent different features that a content type can have.
|
|
540
|
-
*/
|
|
541
|
-
export declare const ContentTypeFeature: {
|
|
542
|
-
readonly LOCALIZATION: "localization";
|
|
543
|
-
readonly VERSIONING: "versioning";
|
|
544
|
-
readonly PUBLISH_PERIOD: "publishPeriod";
|
|
545
|
-
readonly ROUTING: "routing";
|
|
546
|
-
readonly BINARY: "binary";
|
|
444
|
+
readonly lastModifiedBy?: string;
|
|
547
445
|
};
|
|
548
|
-
export type
|
|
446
|
+
export type PropertyFormatPage = {
|
|
549
447
|
/**
|
|
550
448
|
* The items in this paged collection.
|
|
551
449
|
*/
|
|
552
|
-
readonly items?: Array<
|
|
450
|
+
readonly items?: Array<PropertyFormat>;
|
|
553
451
|
/**
|
|
554
452
|
* The zero-based index of the current page.
|
|
555
453
|
*/
|
|
556
454
|
readonly pageIndex?: number;
|
|
557
455
|
/**
|
|
558
|
-
* The number of
|
|
456
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
559
457
|
*/
|
|
560
458
|
readonly pageSize?: number;
|
|
561
459
|
/**
|
|
@@ -564,212 +462,50 @@ export type ContentTypePage = {
|
|
|
564
462
|
readonly totalItemCount?: number;
|
|
565
463
|
};
|
|
566
464
|
/**
|
|
567
|
-
* Describes a property of a ContentType in the CMS.
|
|
465
|
+
* Describes a property group of a ContentType in the CMS.
|
|
568
466
|
*/
|
|
569
|
-
export type
|
|
570
|
-
type: PropertyDataType;
|
|
467
|
+
export type PropertyGroup = {
|
|
571
468
|
/**
|
|
572
|
-
* The key
|
|
469
|
+
* The key that identifies this PropertyGroup.
|
|
573
470
|
*/
|
|
574
|
-
|
|
471
|
+
key?: string;
|
|
575
472
|
/**
|
|
576
|
-
* The display name of this
|
|
473
|
+
* The display name of this PropertyGroup.
|
|
577
474
|
*/
|
|
578
475
|
displayName?: string;
|
|
579
476
|
/**
|
|
580
|
-
* A
|
|
581
|
-
*/
|
|
582
|
-
description?: string;
|
|
583
|
-
/**
|
|
584
|
-
* Indicates if a property instance of this type should be localized for each locale
|
|
585
|
-
* or if values are shared between all locales.
|
|
586
|
-
*/
|
|
587
|
-
localized?: boolean;
|
|
588
|
-
/**
|
|
589
|
-
* Indicates if a property instance of this type must always be assigned a value.
|
|
590
|
-
*/
|
|
591
|
-
required?: boolean;
|
|
592
|
-
/**
|
|
593
|
-
* A reference to the PropertyGroup that this ContentTypeProperty is part of.
|
|
594
|
-
* If this value is empty, a group may be assigned by the system.
|
|
595
|
-
*/
|
|
596
|
-
group?: string;
|
|
597
|
-
/**
|
|
598
|
-
* An value that is used to when sorting ContentTypeProperty instances.
|
|
599
|
-
*/
|
|
600
|
-
sortOrder?: number;
|
|
601
|
-
indexingType?: IndexingType;
|
|
602
|
-
/**
|
|
603
|
-
* Editor used for managing this property.
|
|
604
|
-
*/
|
|
605
|
-
editor?: string | null;
|
|
606
|
-
/**
|
|
607
|
-
* Settings for the editor.
|
|
608
|
-
*/
|
|
609
|
-
editorSettings?: {
|
|
610
|
-
[key: string]: {
|
|
611
|
-
[key: string]: unknown;
|
|
612
|
-
};
|
|
613
|
-
} | null;
|
|
614
|
-
};
|
|
615
|
-
/**
|
|
616
|
-
* Represent the usage types for a ContentType.
|
|
617
|
-
*/
|
|
618
|
-
export type ContentTypeUsage = 'property' | 'instance';
|
|
619
|
-
/**
|
|
620
|
-
* Represent the usage types for a ContentType.
|
|
621
|
-
*/
|
|
622
|
-
export declare const ContentTypeUsage: {
|
|
623
|
-
readonly PROPERTY: "property";
|
|
624
|
-
readonly INSTANCE: "instance";
|
|
625
|
-
};
|
|
626
|
-
/**
|
|
627
|
-
* Options for copying content.
|
|
628
|
-
*/
|
|
629
|
-
export type CopyContentOptions = {
|
|
630
|
-
/**
|
|
631
|
-
* Indicates if deleted content could be used as source.
|
|
632
|
-
*/
|
|
633
|
-
allowDeleted?: boolean;
|
|
634
|
-
/**
|
|
635
|
-
* Optional key of the container where the copied content should be placed.
|
|
636
|
-
*/
|
|
637
|
-
container?: string | null;
|
|
638
|
-
/**
|
|
639
|
-
* Optional key of the owner where the copied content should be placed.
|
|
640
|
-
*/
|
|
641
|
-
owner?: string | null;
|
|
642
|
-
/**
|
|
643
|
-
* Indicates if published versions of the content should keep their published status rather than being created as a draft version at the destination.
|
|
644
|
-
*/
|
|
645
|
-
keepPublishedStatus?: boolean;
|
|
646
|
-
};
|
|
647
|
-
/**
|
|
648
|
-
* Describes a property list item that can contain a timestamp.
|
|
649
|
-
*/
|
|
650
|
-
export type DateTimeListItem = ListPropertyItem & {
|
|
651
|
-
type: 'DateTimeListItem';
|
|
652
|
-
} & {
|
|
653
|
-
/**
|
|
654
|
-
* The earliest timestamp that list items of this type should be able to contain.
|
|
655
|
-
*/
|
|
656
|
-
minimum?: Date | null;
|
|
657
|
-
/**
|
|
658
|
-
* The latest timestamp that list items of this type should be able to contain.
|
|
659
|
-
*/
|
|
660
|
-
maximum?: Date | null;
|
|
661
|
-
};
|
|
662
|
-
/**
|
|
663
|
-
* Describes a property that can contain a timestamp.
|
|
664
|
-
*/
|
|
665
|
-
export type DateTimeProperty = ContentTypeProperty & {
|
|
666
|
-
type: 'DateTimeProperty';
|
|
667
|
-
} & {
|
|
668
|
-
/**
|
|
669
|
-
* The earliest timestamp that properties of this type should be able to contain.
|
|
670
|
-
*/
|
|
671
|
-
minimum?: Date | null;
|
|
672
|
-
/**
|
|
673
|
-
* The latest timestamp that properties of this type should be able to contain.
|
|
674
|
-
*/
|
|
675
|
-
maximum?: Date | null;
|
|
676
|
-
};
|
|
677
|
-
/**
|
|
678
|
-
* Describes a setting for a display template.
|
|
679
|
-
*/
|
|
680
|
-
export type DisplaySetting = {
|
|
681
|
-
/**
|
|
682
|
-
* The display name of this display setting.
|
|
683
|
-
*/
|
|
684
|
-
displayName: string;
|
|
685
|
-
/**
|
|
686
|
-
* The suggested editor for this display setting.
|
|
687
|
-
*/
|
|
688
|
-
editor?: string;
|
|
689
|
-
/**
|
|
690
|
-
* The sort order of this display setting within the template.
|
|
691
|
-
*/
|
|
692
|
-
sortOrder?: number;
|
|
693
|
-
/**
|
|
694
|
-
* The available choices for this display setting.
|
|
695
|
-
*/
|
|
696
|
-
choices?: {
|
|
697
|
-
[key: string]: DisplaySettingChoice;
|
|
698
|
-
};
|
|
699
|
-
};
|
|
700
|
-
/**
|
|
701
|
-
* Describes a setting for a display template.
|
|
702
|
-
*/
|
|
703
|
-
export type DisplaySettingChoice = {
|
|
704
|
-
/**
|
|
705
|
-
* The display name of this display setting choice.
|
|
477
|
+
* A string that is used to indicate the source of this PropertyGroup.
|
|
706
478
|
*/
|
|
707
|
-
|
|
479
|
+
readonly source?: string;
|
|
708
480
|
/**
|
|
709
|
-
*
|
|
481
|
+
* An value that is used to when sorting PropertyGroup instances.
|
|
710
482
|
*/
|
|
711
483
|
sortOrder?: number;
|
|
712
|
-
};
|
|
713
|
-
/**
|
|
714
|
-
* Describes a display template that can be assigned to content.
|
|
715
|
-
*/
|
|
716
|
-
export type DisplayTemplate = {
|
|
717
|
-
/**
|
|
718
|
-
* The key that identifies this display template.
|
|
719
|
-
*/
|
|
720
|
-
readonly key: string;
|
|
721
|
-
/**
|
|
722
|
-
* The display name of this display template.
|
|
723
|
-
*/
|
|
724
|
-
displayName: string;
|
|
725
484
|
/**
|
|
726
|
-
*
|
|
727
|
-
*/
|
|
728
|
-
nodeType?: string | null;
|
|
729
|
-
baseType?: ContentBaseType;
|
|
730
|
-
/**
|
|
731
|
-
* The optional key of the content type this display template is valid for.
|
|
732
|
-
*/
|
|
733
|
-
contentType?: string | null;
|
|
734
|
-
/**
|
|
735
|
-
* If this is the default display template for the associated base type,
|
|
736
|
-
* node type or content type.
|
|
737
|
-
*/
|
|
738
|
-
isDefault?: boolean;
|
|
739
|
-
/**
|
|
740
|
-
* A timestamp indicating when this display template was first created.
|
|
485
|
+
* A timestamp indicating when this property group was first created.
|
|
741
486
|
*/
|
|
742
487
|
readonly created?: Date;
|
|
743
488
|
/**
|
|
744
|
-
* The username of the user that created this
|
|
489
|
+
* The username of the user that created this property group.
|
|
745
490
|
*/
|
|
746
491
|
readonly createdBy?: string;
|
|
747
|
-
/**
|
|
748
|
-
* A timestamp indicating when this display template was last modified.
|
|
749
|
-
*/
|
|
750
492
|
readonly lastModified?: Date;
|
|
751
493
|
/**
|
|
752
|
-
* The username of the user that last modified this
|
|
494
|
+
* The username of the user that last modified this property group.
|
|
753
495
|
*/
|
|
754
496
|
readonly lastModifiedBy?: string;
|
|
755
|
-
/**
|
|
756
|
-
* The available settings for this display template.
|
|
757
|
-
*/
|
|
758
|
-
settings?: {
|
|
759
|
-
[key: string]: DisplaySetting;
|
|
760
|
-
};
|
|
761
497
|
};
|
|
762
|
-
export type
|
|
498
|
+
export type PropertyGroupPage = {
|
|
763
499
|
/**
|
|
764
500
|
* The items in this paged collection.
|
|
765
501
|
*/
|
|
766
|
-
readonly items?: Array<
|
|
502
|
+
readonly items?: Array<PropertyGroup>;
|
|
767
503
|
/**
|
|
768
504
|
* The zero-based index of the current page.
|
|
769
505
|
*/
|
|
770
506
|
readonly pageIndex?: number;
|
|
771
507
|
/**
|
|
772
|
-
* The number of
|
|
508
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
773
509
|
*/
|
|
774
510
|
readonly pageSize?: number;
|
|
775
511
|
/**
|
|
@@ -778,1306 +514,134 @@ export type DisplayTemplatePage = {
|
|
|
778
514
|
readonly totalItemCount?: number;
|
|
779
515
|
};
|
|
780
516
|
/**
|
|
781
|
-
*
|
|
517
|
+
* A writable implementation of an ContentType.
|
|
782
518
|
*/
|
|
783
|
-
export type
|
|
519
|
+
export type ContentTypeWritable = {
|
|
784
520
|
/**
|
|
785
|
-
*
|
|
521
|
+
* The key that identifies this ContentType.
|
|
786
522
|
*/
|
|
787
|
-
|
|
788
|
-
};
|
|
789
|
-
/**
|
|
790
|
-
* Describes an enumeration value.
|
|
791
|
-
*/
|
|
792
|
-
export type DoubleEnumerationValue = {
|
|
523
|
+
key?: string;
|
|
793
524
|
/**
|
|
794
|
-
* The display name of
|
|
525
|
+
* The display name of this ContentType.
|
|
795
526
|
*/
|
|
796
527
|
displayName?: string;
|
|
797
528
|
/**
|
|
798
|
-
*
|
|
799
|
-
*/
|
|
800
|
-
value?: number;
|
|
801
|
-
};
|
|
802
|
-
/**
|
|
803
|
-
* Describes a property list item that can contain a float number.
|
|
804
|
-
*/
|
|
805
|
-
export type FloatListItem = ListPropertyItem & {
|
|
806
|
-
type: 'FloatListItem';
|
|
807
|
-
} & {
|
|
808
|
-
/**
|
|
809
|
-
* The minimum value that list items of this type should be able to contain.
|
|
529
|
+
* A description of this ContentType.
|
|
810
530
|
*/
|
|
811
|
-
|
|
531
|
+
description?: string;
|
|
812
532
|
/**
|
|
813
|
-
* The
|
|
533
|
+
* The base type of this ContentType.
|
|
534
|
+
* Ignored for contracts; required for all other content types.
|
|
814
535
|
*/
|
|
815
|
-
|
|
816
|
-
enum?: DoubleEnumerationSettings;
|
|
817
|
-
};
|
|
818
|
-
/**
|
|
819
|
-
* Describes a property that can contain a float number.
|
|
820
|
-
*/
|
|
821
|
-
export type FloatProperty = ContentTypeProperty & {
|
|
822
|
-
type: 'FloatProperty';
|
|
823
|
-
} & {
|
|
536
|
+
baseType?: string | null;
|
|
824
537
|
/**
|
|
825
|
-
*
|
|
538
|
+
* A value that is used to when sorting ContentType instances.
|
|
826
539
|
*/
|
|
827
|
-
|
|
540
|
+
sortOrder?: number;
|
|
828
541
|
/**
|
|
829
|
-
*
|
|
542
|
+
* Provides a set of content types that can be created in containers of this type
|
|
830
543
|
*/
|
|
831
|
-
|
|
832
|
-
enum?: DoubleEnumerationSettings;
|
|
833
|
-
};
|
|
834
|
-
/**
|
|
835
|
-
* Instruction for generating an alternative image from the main binary of an image content item.
|
|
836
|
-
*/
|
|
837
|
-
export type ImageDescriptor = {
|
|
544
|
+
mayContainTypes?: Array<string>;
|
|
838
545
|
/**
|
|
839
|
-
*
|
|
546
|
+
* Provides a set of media file extensions that this content type can handle.
|
|
840
547
|
*/
|
|
841
|
-
|
|
548
|
+
mediaFileExtensions?: Array<string>;
|
|
842
549
|
/**
|
|
843
|
-
*
|
|
550
|
+
* Provides a set of composition behaviors specifying how this content type can be used within compositions.
|
|
844
551
|
*/
|
|
845
|
-
|
|
552
|
+
compositionBehaviors?: Array<'sectionEnabled' | 'elementEnabled' | 'formsElementEnabled'>;
|
|
846
553
|
/**
|
|
847
|
-
*
|
|
554
|
+
* Dictionary with all custom properties of this ContentType.
|
|
848
555
|
*/
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
* Represents the indexing type of a content type property.
|
|
853
|
-
*/
|
|
854
|
-
export type IndexingType = 'disabled' | 'queryable' | 'searchable';
|
|
855
|
-
/**
|
|
856
|
-
* Represents the indexing type of a content type property.
|
|
857
|
-
*/
|
|
858
|
-
export declare const IndexingType: {
|
|
859
|
-
readonly DISABLED: "disabled";
|
|
860
|
-
readonly QUERYABLE: "queryable";
|
|
861
|
-
readonly SEARCHABLE: "searchable";
|
|
556
|
+
properties?: {
|
|
557
|
+
[key: string]: ContentTypeProperty;
|
|
558
|
+
};
|
|
862
559
|
};
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
*/
|
|
866
|
-
export type Int32EnumerationSettings = {
|
|
867
|
-
/**
|
|
868
|
-
* Enumeration values for this property or format.
|
|
869
|
-
*/
|
|
870
|
-
values?: Array<Int32EnumerationValue>;
|
|
560
|
+
export type ContentTypePageWritable = {
|
|
561
|
+
[key: string]: never;
|
|
871
562
|
};
|
|
872
563
|
/**
|
|
873
|
-
* Describes
|
|
564
|
+
* Describes a display template that can be assigned to content.
|
|
874
565
|
*/
|
|
875
|
-
export type
|
|
876
|
-
/**
|
|
877
|
-
* The display name of the value.
|
|
878
|
-
*/
|
|
879
|
-
displayName?: string;
|
|
566
|
+
export type DisplayTemplateWritable = {
|
|
880
567
|
/**
|
|
881
|
-
* The
|
|
568
|
+
* The key that identifies this display template.
|
|
882
569
|
*/
|
|
883
|
-
|
|
884
|
-
};
|
|
885
|
-
/**
|
|
886
|
-
* Describes a property list item that can contain integers.
|
|
887
|
-
*/
|
|
888
|
-
export type IntegerListItem = ListPropertyItem & {
|
|
889
|
-
type: 'IntegerListItem';
|
|
890
|
-
} & {
|
|
570
|
+
key?: string;
|
|
891
571
|
/**
|
|
892
|
-
* The
|
|
572
|
+
* The display name of this display template.
|
|
893
573
|
*/
|
|
894
|
-
|
|
574
|
+
displayName: string;
|
|
895
575
|
/**
|
|
896
|
-
* The
|
|
576
|
+
* The optional node type this display template is valid for.
|
|
897
577
|
*/
|
|
898
|
-
|
|
899
|
-
enum?: Int32EnumerationSettings;
|
|
900
|
-
};
|
|
901
|
-
/**
|
|
902
|
-
* Describes a property that can contain an integer.
|
|
903
|
-
*/
|
|
904
|
-
export type IntegerProperty = ContentTypeProperty & {
|
|
905
|
-
type: 'IntegerProperty';
|
|
906
|
-
} & {
|
|
578
|
+
nodeType?: string | null;
|
|
907
579
|
/**
|
|
908
|
-
* The
|
|
580
|
+
* The optional base type this display template is valid for.
|
|
909
581
|
*/
|
|
910
|
-
|
|
582
|
+
baseType?: string | null;
|
|
911
583
|
/**
|
|
912
|
-
* The
|
|
913
|
-
*/
|
|
914
|
-
maximum?: number | null;
|
|
915
|
-
enum?: Int32EnumerationSettings;
|
|
916
|
-
};
|
|
917
|
-
/**
|
|
918
|
-
* Describes a property that can contain a JSON value in the form of a string.
|
|
919
|
-
*/
|
|
920
|
-
export type JsonStringProperty = ContentTypeProperty & {
|
|
921
|
-
type: 'JsonStringProperty';
|
|
922
|
-
} & {
|
|
923
|
-
[key: string]: never;
|
|
924
|
-
};
|
|
925
|
-
/**
|
|
926
|
-
* A property in the CMS that may hold a list of items.
|
|
927
|
-
*/
|
|
928
|
-
export type ListProperty = ContentTypeProperty & {
|
|
929
|
-
type: 'ListProperty';
|
|
930
|
-
} & {
|
|
931
|
-
/**
|
|
932
|
-
* Specifies the minimum number of items in this array property.
|
|
933
|
-
*/
|
|
934
|
-
minItems?: number | null;
|
|
935
|
-
/**
|
|
936
|
-
* Specifies the maximum number of items in this array property.
|
|
937
|
-
*/
|
|
938
|
-
maxItems?: number | null;
|
|
939
|
-
/**
|
|
940
|
-
* Describes the list item of a ListProperty in the CMS.
|
|
941
|
-
*/
|
|
942
|
-
items: ({
|
|
943
|
-
type: 'ComponentListItem';
|
|
944
|
-
} & ComponentListItem) | ({
|
|
945
|
-
type: 'ContentListItem';
|
|
946
|
-
} & ContentListItem) | ({
|
|
947
|
-
type: 'ContentReferenceListItem';
|
|
948
|
-
} & ContentReferenceListItem) | ({
|
|
949
|
-
type: 'DateTimeListItem';
|
|
950
|
-
} & DateTimeListItem) | ({
|
|
951
|
-
type: 'FloatListItem';
|
|
952
|
-
} & FloatListItem) | ({
|
|
953
|
-
type: 'IntegerListItem';
|
|
954
|
-
} & IntegerListItem) | ({
|
|
955
|
-
type: 'StringListItem';
|
|
956
|
-
} & StringListItem) | ({
|
|
957
|
-
type: 'UrlListItem';
|
|
958
|
-
} & UrlListItem);
|
|
959
|
-
};
|
|
960
|
-
/**
|
|
961
|
-
* Describes the list item of a ListProperty in the CMS.
|
|
962
|
-
*/
|
|
963
|
-
export type ListPropertyItem = {
|
|
964
|
-
type: PropertyDataType;
|
|
965
|
-
/**
|
|
966
|
-
* The key of the PropertyFormat that this property item is an instance of.
|
|
967
|
-
*/
|
|
968
|
-
format?: string | null;
|
|
969
|
-
};
|
|
970
|
-
/**
|
|
971
|
-
* Represent the different status values of a content locale.
|
|
972
|
-
*/
|
|
973
|
-
export type LocaleStatus = 'draft' | 'published';
|
|
974
|
-
/**
|
|
975
|
-
* Represent the different status values of a content locale.
|
|
976
|
-
*/
|
|
977
|
-
export declare const LocaleStatus: {
|
|
978
|
-
readonly DRAFT: "draft";
|
|
979
|
-
readonly PUBLISHED: "published";
|
|
980
|
-
};
|
|
981
|
-
/**
|
|
982
|
-
* Represents an OAuth JSON Web Token (JWT) and
|
|
983
|
-
* its expiry in seconds.
|
|
984
|
-
*/
|
|
985
|
-
export type OauthToken = {
|
|
986
|
-
/**
|
|
987
|
-
* Gets or sets the access token.
|
|
988
|
-
*/
|
|
989
|
-
accessToken?: string | null;
|
|
990
|
-
/**
|
|
991
|
-
* Gets or sets the expiry time in seconds.
|
|
992
|
-
*/
|
|
993
|
-
expiresIn?: number;
|
|
994
|
-
/**
|
|
995
|
-
* Gets or sets the token type.
|
|
996
|
-
*/
|
|
997
|
-
tokenType?: string;
|
|
998
|
-
};
|
|
999
|
-
/**
|
|
1000
|
-
* Represents an OAuth error.
|
|
1001
|
-
*/
|
|
1002
|
-
export type OauthTokenError = {
|
|
1003
|
-
/**
|
|
1004
|
-
* Gets or sets the error.
|
|
1005
|
-
*/
|
|
1006
|
-
error?: string | null;
|
|
1007
|
-
/**
|
|
1008
|
-
* Gets or sets the error description.
|
|
1009
|
-
*/
|
|
1010
|
-
errorDescription?: string | null;
|
|
1011
|
-
};
|
|
1012
|
-
/**
|
|
1013
|
-
* Represents an OAuth token request.
|
|
1014
|
-
*/
|
|
1015
|
-
export type OauthTokenRequest = {
|
|
1016
|
-
/**
|
|
1017
|
-
* Gets or sets the grant type.
|
|
1018
|
-
*/
|
|
1019
|
-
grantType?: string | null;
|
|
1020
|
-
/**
|
|
1021
|
-
* Gets or sets the client id.
|
|
1022
|
-
*/
|
|
1023
|
-
clientId?: string | null;
|
|
1024
|
-
/**
|
|
1025
|
-
* Gets or sets the client secret.
|
|
1026
|
-
*/
|
|
1027
|
-
clientSecret?: string | null;
|
|
1028
|
-
/**
|
|
1029
|
-
* Get or sets the subject to act as.
|
|
1030
|
-
*/
|
|
1031
|
-
actAs?: string | null;
|
|
1032
|
-
};
|
|
1033
|
-
export type ProblemDetails = {
|
|
1034
|
-
type?: string | null;
|
|
1035
|
-
title?: string | null;
|
|
1036
|
-
status?: number | null;
|
|
1037
|
-
detail?: string | null;
|
|
1038
|
-
instance?: string | null;
|
|
1039
|
-
readonly code?: string | null;
|
|
1040
|
-
readonly errors?: {
|
|
1041
|
-
[key: string]: Array<string>;
|
|
1042
|
-
} | null;
|
|
1043
|
-
[key: string]: unknown | (string | null) | (string | null) | (number | null) | (string | null) | (string | null) | (string | null) | ({
|
|
1044
|
-
[key: string]: Array<string>;
|
|
1045
|
-
} | null) | undefined;
|
|
1046
|
-
};
|
|
1047
|
-
/**
|
|
1048
|
-
* Represent the basic type that a PropertyFormat
|
|
1049
|
-
* is using for data storage and data transport.
|
|
1050
|
-
*/
|
|
1051
|
-
export type PropertyDataType = 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'json' | 'array' | 'component';
|
|
1052
|
-
/**
|
|
1053
|
-
* Represent the basic type that a PropertyFormat
|
|
1054
|
-
* is using for data storage and data transport.
|
|
1055
|
-
*/
|
|
1056
|
-
export declare const PropertyDataType: {
|
|
1057
|
-
readonly STRING: "string";
|
|
1058
|
-
readonly URL: "url";
|
|
1059
|
-
readonly BOOLEAN: "boolean";
|
|
1060
|
-
readonly INTEGER: "integer";
|
|
1061
|
-
readonly FLOAT: "float";
|
|
1062
|
-
readonly DATE_TIME: "dateTime";
|
|
1063
|
-
readonly CONTENT_REFERENCE: "contentReference";
|
|
1064
|
-
readonly CONTENT: "content";
|
|
1065
|
-
readonly BINARY: "binary";
|
|
1066
|
-
readonly JSON: "json";
|
|
1067
|
-
readonly ARRAY: "array";
|
|
1068
|
-
readonly COMPONENT: "component";
|
|
1069
|
-
};
|
|
1070
|
-
/**
|
|
1071
|
-
* Represent the definition of semantic property formats for content items.
|
|
1072
|
-
*/
|
|
1073
|
-
export type PropertyFormat = {
|
|
1074
|
-
/**
|
|
1075
|
-
* The key that identifies this PropertyFormat.
|
|
1076
|
-
*/
|
|
1077
|
-
key?: string;
|
|
1078
|
-
dataType?: PropertyDataType;
|
|
1079
|
-
itemType?: PropertyDataType;
|
|
1080
|
-
/**
|
|
1081
|
-
* The name and identifier of this PropertyFormat.
|
|
1082
|
-
*/
|
|
1083
|
-
displayName?: string;
|
|
1084
|
-
/**
|
|
1085
|
-
* Editor used for managing properties with this format.
|
|
1086
|
-
*/
|
|
1087
|
-
editor?: string | null;
|
|
1088
|
-
/**
|
|
1089
|
-
* Indicates if this property format has been deleted.
|
|
1090
|
-
*/
|
|
1091
|
-
deleted?: boolean;
|
|
1092
|
-
/**
|
|
1093
|
-
* Settings for the editor.
|
|
1094
|
-
*/
|
|
1095
|
-
editorSettings?: {
|
|
1096
|
-
[key: string]: {
|
|
1097
|
-
[key: string]: unknown;
|
|
1098
|
-
};
|
|
1099
|
-
} | null;
|
|
1100
|
-
/**
|
|
1101
|
-
* Enumerations for the format.
|
|
1102
|
-
*/
|
|
1103
|
-
enum?: {
|
|
1104
|
-
values?: Array<{
|
|
1105
|
-
value?: string | number | number;
|
|
1106
|
-
displayName?: string;
|
|
1107
|
-
}>;
|
|
1108
|
-
} | null;
|
|
1109
|
-
};
|
|
1110
|
-
export type PropertyFormatPage = {
|
|
1111
|
-
/**
|
|
1112
|
-
* The items in this paged collection.
|
|
1113
|
-
*/
|
|
1114
|
-
readonly items?: Array<PropertyFormat>;
|
|
1115
|
-
/**
|
|
1116
|
-
* The zero-based index of the current page.
|
|
1117
|
-
*/
|
|
1118
|
-
readonly pageIndex?: number;
|
|
1119
|
-
/**
|
|
1120
|
-
* The number of item in each page. Not necessarily the same as the number of items in this page.
|
|
1121
|
-
*/
|
|
1122
|
-
readonly pageSize?: number;
|
|
1123
|
-
/**
|
|
1124
|
-
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
1125
|
-
*/
|
|
1126
|
-
readonly totalItemCount?: number;
|
|
1127
|
-
};
|
|
1128
|
-
/**
|
|
1129
|
-
* Describes a property group of a ContentType in the CMS.
|
|
1130
|
-
*/
|
|
1131
|
-
export type PropertyGroup = {
|
|
1132
|
-
/**
|
|
1133
|
-
* The key that identifies this PropertyGroup.
|
|
1134
|
-
*/
|
|
1135
|
-
readonly key: string;
|
|
1136
|
-
/**
|
|
1137
|
-
* The display name of this PropertyGroup.
|
|
1138
|
-
*/
|
|
1139
|
-
displayName?: string;
|
|
1140
|
-
/**
|
|
1141
|
-
* A string that is used to indicate the source of this PropertyGroup.
|
|
1142
|
-
*/
|
|
1143
|
-
readonly source?: string;
|
|
1144
|
-
/**
|
|
1145
|
-
* An value that is used to when sorting PropertyGroup instances.
|
|
1146
|
-
*/
|
|
1147
|
-
sortOrder?: number;
|
|
1148
|
-
};
|
|
1149
|
-
export type PropertyGroupPage = {
|
|
1150
|
-
/**
|
|
1151
|
-
* The items in this paged collection.
|
|
1152
|
-
*/
|
|
1153
|
-
readonly items?: Array<PropertyGroup>;
|
|
1154
|
-
/**
|
|
1155
|
-
* The zero-based index of the current page.
|
|
1156
|
-
*/
|
|
1157
|
-
readonly pageIndex?: number;
|
|
1158
|
-
/**
|
|
1159
|
-
* The number of item in each page. Not necessarily the same as the number of items in this page.
|
|
1160
|
-
*/
|
|
1161
|
-
readonly pageSize?: number;
|
|
1162
|
-
/**
|
|
1163
|
-
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
1164
|
-
*/
|
|
1165
|
-
readonly totalItemCount?: number;
|
|
1166
|
-
};
|
|
1167
|
-
/**
|
|
1168
|
-
* Enumeration settings for a property or format.
|
|
1169
|
-
*/
|
|
1170
|
-
export type StringEnumerationSettings = {
|
|
1171
|
-
/**
|
|
1172
|
-
* Enumeration values for this property or format.
|
|
1173
|
-
*/
|
|
1174
|
-
values?: Array<StringEnumerationValue>;
|
|
1175
|
-
};
|
|
1176
|
-
/**
|
|
1177
|
-
* Describes an enumeration value.
|
|
1178
|
-
*/
|
|
1179
|
-
export type StringEnumerationValue = {
|
|
1180
|
-
/**
|
|
1181
|
-
* The display name of the value.
|
|
1182
|
-
*/
|
|
1183
|
-
displayName?: string;
|
|
1184
|
-
/**
|
|
1185
|
-
* The underlying enumeration value.
|
|
1186
|
-
*/
|
|
1187
|
-
value?: string;
|
|
1188
|
-
};
|
|
1189
|
-
/**
|
|
1190
|
-
* Describes a property list item that can contain a string.
|
|
1191
|
-
*/
|
|
1192
|
-
export type StringListItem = ListPropertyItem & {
|
|
1193
|
-
type: 'StringListItem';
|
|
1194
|
-
} & {
|
|
1195
|
-
/**
|
|
1196
|
-
* The minimum string length that list items of this type should be able to contain.
|
|
1197
|
-
*/
|
|
1198
|
-
minLength?: number | null;
|
|
1199
|
-
/**
|
|
1200
|
-
* The maximum string length that list items of this type should be able to contain.
|
|
1201
|
-
*/
|
|
1202
|
-
maxLength?: number | null;
|
|
1203
|
-
/**
|
|
1204
|
-
* Regular expression pattern that limits what strings that list items of this type should be able to contain.
|
|
1205
|
-
*/
|
|
1206
|
-
pattern?: string | null;
|
|
1207
|
-
enum?: StringEnumerationSettings;
|
|
1208
|
-
};
|
|
1209
|
-
/**
|
|
1210
|
-
* Describes a property that can contain strings.
|
|
1211
|
-
*/
|
|
1212
|
-
export type StringProperty = ContentTypeProperty & {
|
|
1213
|
-
type: 'StringProperty';
|
|
1214
|
-
} & {
|
|
1215
|
-
/**
|
|
1216
|
-
* The minimum string length that properties of this type should be able to contain.
|
|
1217
|
-
*/
|
|
1218
|
-
minLength?: number | null;
|
|
1219
|
-
/**
|
|
1220
|
-
* The maximum string length that properties of this type should be able to contain.
|
|
1221
|
-
*/
|
|
1222
|
-
maxLength?: number | null;
|
|
1223
|
-
/**
|
|
1224
|
-
* Regular expression pattern that limits what strings that properties of this type should be able to contain.
|
|
1225
|
-
*/
|
|
1226
|
-
pattern?: string | null;
|
|
1227
|
-
enum?: StringEnumerationSettings;
|
|
1228
|
-
};
|
|
1229
|
-
/**
|
|
1230
|
-
* Describes a property list item that can contain a URL.
|
|
1231
|
-
*/
|
|
1232
|
-
export type UrlListItem = ListPropertyItem & {
|
|
1233
|
-
type: 'UrlListItem';
|
|
1234
|
-
} & {
|
|
1235
|
-
[key: string]: never;
|
|
1236
|
-
};
|
|
1237
|
-
/**
|
|
1238
|
-
* Describes a property that can contain URLs.
|
|
1239
|
-
*/
|
|
1240
|
-
export type UrlProperty = ContentTypeProperty & {
|
|
1241
|
-
type: 'UrlProperty';
|
|
1242
|
-
} & {
|
|
1243
|
-
[key: string]: never;
|
|
1244
|
-
};
|
|
1245
|
-
/**
|
|
1246
|
-
* Represent the different status values of a content version.
|
|
1247
|
-
*/
|
|
1248
|
-
export type VersionStatus = 'draft' | 'ready' | 'published' | 'previous' | 'scheduled' | 'rejected' | 'inReview';
|
|
1249
|
-
/**
|
|
1250
|
-
* Represent the different status values of a content version.
|
|
1251
|
-
*/
|
|
1252
|
-
export declare const VersionStatus: {
|
|
1253
|
-
readonly DRAFT: "draft";
|
|
1254
|
-
readonly READY: "ready";
|
|
1255
|
-
readonly PUBLISHED: "published";
|
|
1256
|
-
readonly PREVIOUS: "previous";
|
|
1257
|
-
readonly SCHEDULED: "scheduled";
|
|
1258
|
-
readonly REJECTED: "rejected";
|
|
1259
|
-
readonly IN_REVIEW: "inReview";
|
|
1260
|
-
};
|
|
1261
|
-
export type ChangesetsListData = {
|
|
1262
|
-
body?: never;
|
|
1263
|
-
path?: never;
|
|
1264
|
-
query?: {
|
|
1265
|
-
pageIndex?: number;
|
|
1266
|
-
pageSize?: number;
|
|
1267
|
-
};
|
|
1268
|
-
url: '/changesets';
|
|
1269
|
-
};
|
|
1270
|
-
export type ChangesetsListErrors = {
|
|
1271
|
-
/**
|
|
1272
|
-
* Forbidden
|
|
1273
|
-
*/
|
|
1274
|
-
403: ProblemDetails;
|
|
1275
|
-
};
|
|
1276
|
-
export type ChangesetsListError = ChangesetsListErrors[keyof ChangesetsListErrors];
|
|
1277
|
-
export type ChangesetsListResponses = {
|
|
1278
|
-
/**
|
|
1279
|
-
* OK
|
|
1280
|
-
*/
|
|
1281
|
-
200: ChangesetPage;
|
|
1282
|
-
};
|
|
1283
|
-
export type ChangesetsListResponse = ChangesetsListResponses[keyof ChangesetsListResponses];
|
|
1284
|
-
export type ChangesetsCreateData = {
|
|
1285
|
-
/**
|
|
1286
|
-
* The changeset that should be created.
|
|
1287
|
-
*/
|
|
1288
|
-
body: Changeset;
|
|
1289
|
-
path?: never;
|
|
1290
|
-
query?: never;
|
|
1291
|
-
url: '/changesets';
|
|
1292
|
-
};
|
|
1293
|
-
export type ChangesetsCreateErrors = {
|
|
1294
|
-
/**
|
|
1295
|
-
* Bad Request
|
|
1296
|
-
*/
|
|
1297
|
-
400: ProblemDetails;
|
|
1298
|
-
/**
|
|
1299
|
-
* Forbidden
|
|
1300
|
-
*/
|
|
1301
|
-
403: ProblemDetails;
|
|
1302
|
-
};
|
|
1303
|
-
export type ChangesetsCreateError = ChangesetsCreateErrors[keyof ChangesetsCreateErrors];
|
|
1304
|
-
export type ChangesetsCreateResponses = {
|
|
1305
|
-
/**
|
|
1306
|
-
* OK
|
|
1307
|
-
*/
|
|
1308
|
-
200: Changeset;
|
|
1309
|
-
};
|
|
1310
|
-
export type ChangesetsCreateResponse = ChangesetsCreateResponses[keyof ChangesetsCreateResponses];
|
|
1311
|
-
export type ChangesetsDeleteData = {
|
|
1312
|
-
body?: never;
|
|
1313
|
-
path: {
|
|
1314
|
-
/**
|
|
1315
|
-
* The key of the changeset to delete.
|
|
1316
|
-
*/
|
|
1317
|
-
key: string;
|
|
1318
|
-
};
|
|
1319
|
-
query?: never;
|
|
1320
|
-
url: '/changesets/{key}';
|
|
1321
|
-
};
|
|
1322
|
-
export type ChangesetsDeleteErrors = {
|
|
1323
|
-
/**
|
|
1324
|
-
* Bad Request
|
|
1325
|
-
*/
|
|
1326
|
-
400: ProblemDetails;
|
|
1327
|
-
/**
|
|
1328
|
-
* Forbidden
|
|
1329
|
-
*/
|
|
1330
|
-
403: ProblemDetails;
|
|
1331
|
-
};
|
|
1332
|
-
export type ChangesetsDeleteError = ChangesetsDeleteErrors[keyof ChangesetsDeleteErrors];
|
|
1333
|
-
export type ChangesetsDeleteResponses = {
|
|
1334
|
-
/**
|
|
1335
|
-
* OK
|
|
1336
|
-
*/
|
|
1337
|
-
200: Changeset;
|
|
1338
|
-
};
|
|
1339
|
-
export type ChangesetsDeleteResponse = ChangesetsDeleteResponses[keyof ChangesetsDeleteResponses];
|
|
1340
|
-
export type ChangesetsGetData = {
|
|
1341
|
-
body?: never;
|
|
1342
|
-
path: {
|
|
1343
|
-
/**
|
|
1344
|
-
* The key of the changeset to retrieve.
|
|
1345
|
-
*/
|
|
1346
|
-
key: string;
|
|
1347
|
-
};
|
|
1348
|
-
query?: never;
|
|
1349
|
-
url: '/changesets/{key}';
|
|
1350
|
-
};
|
|
1351
|
-
export type ChangesetsGetErrors = {
|
|
1352
|
-
/**
|
|
1353
|
-
* Forbidden
|
|
1354
|
-
*/
|
|
1355
|
-
403: ProblemDetails;
|
|
1356
|
-
};
|
|
1357
|
-
export type ChangesetsGetError = ChangesetsGetErrors[keyof ChangesetsGetErrors];
|
|
1358
|
-
export type ChangesetsGetResponses = {
|
|
1359
|
-
/**
|
|
1360
|
-
* OK
|
|
1361
|
-
*/
|
|
1362
|
-
200: Changeset;
|
|
1363
|
-
};
|
|
1364
|
-
export type ChangesetsGetResponse = ChangesetsGetResponses[keyof ChangesetsGetResponses];
|
|
1365
|
-
export type ChangesetsPutData = {
|
|
1366
|
-
/**
|
|
1367
|
-
* The values of the created or replaced changeset.
|
|
1368
|
-
*/
|
|
1369
|
-
body: Changeset;
|
|
1370
|
-
path: {
|
|
1371
|
-
/**
|
|
1372
|
-
* The key of the changeset to update or create.
|
|
1373
|
-
*/
|
|
1374
|
-
key: string;
|
|
1375
|
-
};
|
|
1376
|
-
query?: never;
|
|
1377
|
-
url: '/changesets/{key}';
|
|
1378
|
-
};
|
|
1379
|
-
export type ChangesetsPutErrors = {
|
|
1380
|
-
/**
|
|
1381
|
-
* Bad Request
|
|
1382
|
-
*/
|
|
1383
|
-
400: ProblemDetails;
|
|
1384
|
-
/**
|
|
1385
|
-
* Forbidden
|
|
1386
|
-
*/
|
|
1387
|
-
403: ProblemDetails;
|
|
1388
|
-
};
|
|
1389
|
-
export type ChangesetsPutError = ChangesetsPutErrors[keyof ChangesetsPutErrors];
|
|
1390
|
-
export type ChangesetsPutResponses = {
|
|
1391
|
-
/**
|
|
1392
|
-
* OK
|
|
1393
|
-
*/
|
|
1394
|
-
200: Changeset;
|
|
1395
|
-
};
|
|
1396
|
-
export type ChangesetsPutResponse = ChangesetsPutResponses[keyof ChangesetsPutResponses];
|
|
1397
|
-
export type ChangesetsDeleteItemData = {
|
|
1398
|
-
body?: never;
|
|
1399
|
-
path: {
|
|
1400
|
-
/**
|
|
1401
|
-
* The changeset key
|
|
1402
|
-
*/
|
|
1403
|
-
changeset: string;
|
|
1404
|
-
/**
|
|
1405
|
-
* The content key
|
|
1406
|
-
*/
|
|
1407
|
-
key: string;
|
|
1408
|
-
/**
|
|
1409
|
-
* The content version
|
|
1410
|
-
*/
|
|
1411
|
-
version: string;
|
|
1412
|
-
};
|
|
1413
|
-
query?: never;
|
|
1414
|
-
url: '/changesets/{changeset}/items/{key}/versions/{version}';
|
|
1415
|
-
};
|
|
1416
|
-
export type ChangesetsDeleteItemErrors = {
|
|
1417
|
-
/**
|
|
1418
|
-
* Bad Request
|
|
1419
|
-
*/
|
|
1420
|
-
400: ProblemDetails;
|
|
1421
|
-
/**
|
|
1422
|
-
* Forbidden
|
|
1423
|
-
*/
|
|
1424
|
-
403: ProblemDetails;
|
|
1425
|
-
};
|
|
1426
|
-
export type ChangesetsDeleteItemError = ChangesetsDeleteItemErrors[keyof ChangesetsDeleteItemErrors];
|
|
1427
|
-
export type ChangesetsDeleteItemResponses = {
|
|
1428
|
-
/**
|
|
1429
|
-
* OK
|
|
1430
|
-
*/
|
|
1431
|
-
200: ChangesetItem;
|
|
1432
|
-
};
|
|
1433
|
-
export type ChangesetsDeleteItemResponse = ChangesetsDeleteItemResponses[keyof ChangesetsDeleteItemResponses];
|
|
1434
|
-
export type ChangesetsGetItemData = {
|
|
1435
|
-
body?: never;
|
|
1436
|
-
path: {
|
|
1437
|
-
/**
|
|
1438
|
-
* The changeset key
|
|
1439
|
-
*/
|
|
1440
|
-
changeset: string;
|
|
1441
|
-
/**
|
|
1442
|
-
* The content key
|
|
1443
|
-
*/
|
|
1444
|
-
key: string;
|
|
1445
|
-
/**
|
|
1446
|
-
* The content version
|
|
1447
|
-
*/
|
|
1448
|
-
version: string;
|
|
1449
|
-
};
|
|
1450
|
-
query?: never;
|
|
1451
|
-
url: '/changesets/{changeset}/items/{key}/versions/{version}';
|
|
1452
|
-
};
|
|
1453
|
-
export type ChangesetsGetItemErrors = {
|
|
1454
|
-
/**
|
|
1455
|
-
* Forbidden
|
|
1456
|
-
*/
|
|
1457
|
-
403: ProblemDetails;
|
|
1458
|
-
};
|
|
1459
|
-
export type ChangesetsGetItemError = ChangesetsGetItemErrors[keyof ChangesetsGetItemErrors];
|
|
1460
|
-
export type ChangesetsGetItemResponses = {
|
|
1461
|
-
/**
|
|
1462
|
-
* OK
|
|
1463
|
-
*/
|
|
1464
|
-
200: ChangesetItem;
|
|
1465
|
-
};
|
|
1466
|
-
export type ChangesetsGetItemResponse = ChangesetsGetItemResponses[keyof ChangesetsGetItemResponses];
|
|
1467
|
-
export type ChangesetsListItemsData = {
|
|
1468
|
-
body?: never;
|
|
1469
|
-
path: {
|
|
1470
|
-
/**
|
|
1471
|
-
* The changeset key
|
|
1472
|
-
*/
|
|
1473
|
-
changeset: string;
|
|
1474
|
-
};
|
|
1475
|
-
query?: {
|
|
1476
|
-
pageIndex?: number;
|
|
1477
|
-
pageSize?: number;
|
|
1478
|
-
};
|
|
1479
|
-
url: '/changesets/{changeset}/items';
|
|
1480
|
-
};
|
|
1481
|
-
export type ChangesetsListItemsErrors = {
|
|
1482
|
-
/**
|
|
1483
|
-
* Forbidden
|
|
1484
|
-
*/
|
|
1485
|
-
403: ProblemDetails;
|
|
1486
|
-
};
|
|
1487
|
-
export type ChangesetsListItemsError = ChangesetsListItemsErrors[keyof ChangesetsListItemsErrors];
|
|
1488
|
-
export type ChangesetsListItemsResponses = {
|
|
1489
|
-
/**
|
|
1490
|
-
* OK
|
|
1491
|
-
*/
|
|
1492
|
-
200: ChangesetItemPage;
|
|
1493
|
-
};
|
|
1494
|
-
export type ChangesetsListItemsResponse = ChangesetsListItemsResponses[keyof ChangesetsListItemsResponses];
|
|
1495
|
-
export type ChangesetsCreateItemData = {
|
|
1496
|
-
/**
|
|
1497
|
-
* The changeset item
|
|
1498
|
-
*/
|
|
1499
|
-
body: ChangesetItem;
|
|
1500
|
-
path: {
|
|
1501
|
-
/**
|
|
1502
|
-
* The changeset key
|
|
1503
|
-
*/
|
|
1504
|
-
changeset: string;
|
|
1505
|
-
};
|
|
1506
|
-
query?: never;
|
|
1507
|
-
url: '/changesets/{changeset}/items';
|
|
1508
|
-
};
|
|
1509
|
-
export type ChangesetsCreateItemErrors = {
|
|
1510
|
-
/**
|
|
1511
|
-
* Bad Request
|
|
1512
|
-
*/
|
|
1513
|
-
400: ProblemDetails;
|
|
1514
|
-
/**
|
|
1515
|
-
* Forbidden
|
|
1516
|
-
*/
|
|
1517
|
-
403: ProblemDetails;
|
|
1518
|
-
};
|
|
1519
|
-
export type ChangesetsCreateItemError = ChangesetsCreateItemErrors[keyof ChangesetsCreateItemErrors];
|
|
1520
|
-
export type ChangesetsCreateItemResponses = {
|
|
1521
|
-
/**
|
|
1522
|
-
* OK
|
|
1523
|
-
*/
|
|
1524
|
-
200: ChangesetItem;
|
|
1525
|
-
};
|
|
1526
|
-
export type ChangesetsCreateItemResponse = ChangesetsCreateItemResponses[keyof ChangesetsCreateItemResponses];
|
|
1527
|
-
export type ChangesetsUpdateItemData = {
|
|
1528
|
-
/**
|
|
1529
|
-
* The changeset item
|
|
1530
|
-
*/
|
|
1531
|
-
body: ChangesetItem;
|
|
1532
|
-
path: {
|
|
1533
|
-
/**
|
|
1534
|
-
* The changeset key
|
|
1535
|
-
*/
|
|
1536
|
-
changeset: string;
|
|
1537
|
-
/**
|
|
1538
|
-
* The content key
|
|
1539
|
-
*/
|
|
1540
|
-
contentKey: string;
|
|
1541
|
-
/**
|
|
1542
|
-
* The content version
|
|
1543
|
-
*/
|
|
1544
|
-
contentVersion: string;
|
|
1545
|
-
};
|
|
1546
|
-
query?: {
|
|
1547
|
-
/**
|
|
1548
|
-
* Indicates if a new changeset item should be created if it does not exist
|
|
1549
|
-
*/
|
|
1550
|
-
allowCreate?: boolean;
|
|
1551
|
-
};
|
|
1552
|
-
url: '/changesets/{changeset}/items/{contentKey}/versions/{contentVersion}';
|
|
1553
|
-
};
|
|
1554
|
-
export type ChangesetsUpdateItemErrors = {
|
|
1555
|
-
/**
|
|
1556
|
-
* Bad Request
|
|
1557
|
-
*/
|
|
1558
|
-
400: ProblemDetails;
|
|
1559
|
-
/**
|
|
1560
|
-
* Forbidden
|
|
1561
|
-
*/
|
|
1562
|
-
403: ProblemDetails;
|
|
1563
|
-
};
|
|
1564
|
-
export type ChangesetsUpdateItemError = ChangesetsUpdateItemErrors[keyof ChangesetsUpdateItemErrors];
|
|
1565
|
-
export type ChangesetsUpdateItemResponses = {
|
|
1566
|
-
/**
|
|
1567
|
-
* OK
|
|
1568
|
-
*/
|
|
1569
|
-
200: ChangesetItem;
|
|
1570
|
-
};
|
|
1571
|
-
export type ChangesetsUpdateItemResponse = ChangesetsUpdateItemResponses[keyof ChangesetsUpdateItemResponses];
|
|
1572
|
-
export type ContentCreateData = {
|
|
1573
|
-
/**
|
|
1574
|
-
* The content item that should be created.
|
|
1575
|
-
*/
|
|
1576
|
-
body: ContentItem;
|
|
1577
|
-
path?: never;
|
|
1578
|
-
query?: {
|
|
1579
|
-
/**
|
|
1580
|
-
* Indicates that the content validation should be ignored.
|
|
1581
|
-
*/
|
|
1582
|
-
skipValidation?: boolean;
|
|
1583
|
-
};
|
|
1584
|
-
url: '/content';
|
|
1585
|
-
};
|
|
1586
|
-
export type ContentCreateErrors = {
|
|
1587
|
-
/**
|
|
1588
|
-
* Bad Request
|
|
1589
|
-
*/
|
|
1590
|
-
400: ProblemDetails;
|
|
1591
|
-
/**
|
|
1592
|
-
* Forbidden
|
|
1593
|
-
*/
|
|
1594
|
-
403: ProblemDetails;
|
|
1595
|
-
};
|
|
1596
|
-
export type ContentCreateError = ContentCreateErrors[keyof ContentCreateErrors];
|
|
1597
|
-
export type ContentCreateResponses = {
|
|
1598
|
-
/**
|
|
1599
|
-
* Created
|
|
1600
|
-
*/
|
|
1601
|
-
201: ContentItemWithContentTypes;
|
|
1602
|
-
};
|
|
1603
|
-
export type ContentCreateResponse = ContentCreateResponses[keyof ContentCreateResponses];
|
|
1604
|
-
export type ContentDeleteData = {
|
|
1605
|
-
body?: never;
|
|
1606
|
-
path: {
|
|
1607
|
-
/**
|
|
1608
|
-
* The key of the content item to delete.
|
|
1609
|
-
*/
|
|
1610
|
-
key: string;
|
|
1611
|
-
};
|
|
1612
|
-
query?: {
|
|
1613
|
-
/**
|
|
1614
|
-
* Indicates that the content item should be permanently deleted immediately or if it should be soft deleted first.
|
|
1615
|
-
*/
|
|
1616
|
-
permanent?: boolean;
|
|
1617
|
-
};
|
|
1618
|
-
url: '/content/{key}';
|
|
1619
|
-
};
|
|
1620
|
-
export type ContentDeleteErrors = {
|
|
1621
|
-
/**
|
|
1622
|
-
* Bad Request
|
|
1623
|
-
*/
|
|
1624
|
-
400: ProblemDetails;
|
|
1625
|
-
/**
|
|
1626
|
-
* Forbidden
|
|
1627
|
-
*/
|
|
1628
|
-
403: ProblemDetails;
|
|
1629
|
-
};
|
|
1630
|
-
export type ContentDeleteError = ContentDeleteErrors[keyof ContentDeleteErrors];
|
|
1631
|
-
export type ContentDeleteResponses = {
|
|
1632
|
-
/**
|
|
1633
|
-
* OK
|
|
1634
|
-
*/
|
|
1635
|
-
200: ContentMetadata;
|
|
1636
|
-
};
|
|
1637
|
-
export type ContentDeleteResponse = ContentDeleteResponses[keyof ContentDeleteResponses];
|
|
1638
|
-
export type ContentGetMetadataData = {
|
|
1639
|
-
body?: never;
|
|
1640
|
-
path: {
|
|
1641
|
-
/**
|
|
1642
|
-
* The key of the content to retrieve metadata for.
|
|
1643
|
-
*/
|
|
1644
|
-
key: string;
|
|
1645
|
-
};
|
|
1646
|
-
query?: {
|
|
1647
|
-
/**
|
|
1648
|
-
* Indicates that metadata for a deleted content may be returned.
|
|
1649
|
-
*/
|
|
1650
|
-
allowDeleted?: boolean;
|
|
1651
|
-
};
|
|
1652
|
-
url: '/content/{key}';
|
|
1653
|
-
};
|
|
1654
|
-
export type ContentGetMetadataErrors = {
|
|
1655
|
-
/**
|
|
1656
|
-
* Forbidden
|
|
1657
|
-
*/
|
|
1658
|
-
403: ProblemDetails;
|
|
1659
|
-
};
|
|
1660
|
-
export type ContentGetMetadataError = ContentGetMetadataErrors[keyof ContentGetMetadataErrors];
|
|
1661
|
-
export type ContentGetMetadataResponses = {
|
|
1662
|
-
/**
|
|
1663
|
-
* OK
|
|
1664
|
-
*/
|
|
1665
|
-
200: ContentMetadata;
|
|
1666
|
-
};
|
|
1667
|
-
export type ContentGetMetadataResponse = ContentGetMetadataResponses[keyof ContentGetMetadataResponses];
|
|
1668
|
-
export type ContentPatchMetadataData = {
|
|
1669
|
-
/**
|
|
1670
|
-
* The values of the content item that should be updated.
|
|
1671
|
-
*/
|
|
1672
|
-
body: ContentMetadata;
|
|
1673
|
-
path: {
|
|
1674
|
-
/**
|
|
1675
|
-
* The key of the content item to patch.
|
|
1676
|
-
*/
|
|
1677
|
-
key: string;
|
|
1678
|
-
};
|
|
1679
|
-
query?: never;
|
|
1680
|
-
url: '/content/{key}';
|
|
1681
|
-
};
|
|
1682
|
-
export type ContentPatchMetadataErrors = {
|
|
1683
|
-
/**
|
|
1684
|
-
* Bad Request
|
|
1685
|
-
*/
|
|
1686
|
-
400: ProblemDetails;
|
|
1687
|
-
/**
|
|
1688
|
-
* Forbidden
|
|
1689
|
-
*/
|
|
1690
|
-
403: ProblemDetails;
|
|
1691
|
-
};
|
|
1692
|
-
export type ContentPatchMetadataError = ContentPatchMetadataErrors[keyof ContentPatchMetadataErrors];
|
|
1693
|
-
export type ContentPatchMetadataResponses = {
|
|
1694
|
-
/**
|
|
1695
|
-
* OK
|
|
1696
|
-
*/
|
|
1697
|
-
200: ContentMetadata;
|
|
1698
|
-
};
|
|
1699
|
-
export type ContentPatchMetadataResponse = ContentPatchMetadataResponses[keyof ContentPatchMetadataResponses];
|
|
1700
|
-
export type ContentGetPathData = {
|
|
1701
|
-
body?: never;
|
|
1702
|
-
path: {
|
|
1703
|
-
/**
|
|
1704
|
-
* The key of the content path to retrieve.
|
|
1705
|
-
*/
|
|
1706
|
-
key: string;
|
|
1707
|
-
};
|
|
1708
|
-
query?: {
|
|
1709
|
-
pageIndex?: number;
|
|
1710
|
-
pageSize?: number;
|
|
1711
|
-
};
|
|
1712
|
-
url: '/content/{key}/path';
|
|
1713
|
-
};
|
|
1714
|
-
export type ContentGetPathErrors = {
|
|
1715
|
-
/**
|
|
1716
|
-
* Forbidden
|
|
1717
|
-
*/
|
|
1718
|
-
403: ProblemDetails;
|
|
1719
|
-
};
|
|
1720
|
-
export type ContentGetPathError = ContentGetPathErrors[keyof ContentGetPathErrors];
|
|
1721
|
-
export type ContentGetPathResponses = {
|
|
1722
|
-
/**
|
|
1723
|
-
* OK
|
|
1724
|
-
*/
|
|
1725
|
-
200: ContentMetadataPage;
|
|
1726
|
-
};
|
|
1727
|
-
export type ContentGetPathResponse = ContentGetPathResponses[keyof ContentGetPathResponses];
|
|
1728
|
-
export type ContentListItemsData = {
|
|
1729
|
-
body?: never;
|
|
1730
|
-
path: {
|
|
1731
|
-
/**
|
|
1732
|
-
* The key of the content to retrieve items for.
|
|
1733
|
-
*/
|
|
1734
|
-
key: string;
|
|
1735
|
-
};
|
|
1736
|
-
query?: {
|
|
1737
|
-
/**
|
|
1738
|
-
* Indicates which content types or base types to include in the list.
|
|
1739
|
-
*/
|
|
1740
|
-
contentTypes?: Array<string>;
|
|
1741
|
-
pageIndex?: number;
|
|
1742
|
-
pageSize?: number;
|
|
1743
|
-
};
|
|
1744
|
-
url: '/content/{key}/items';
|
|
1745
|
-
};
|
|
1746
|
-
export type ContentListItemsErrors = {
|
|
1747
|
-
/**
|
|
1748
|
-
* Forbidden
|
|
1749
|
-
*/
|
|
1750
|
-
403: ProblemDetails;
|
|
1751
|
-
};
|
|
1752
|
-
export type ContentListItemsError = ContentListItemsErrors[keyof ContentListItemsErrors];
|
|
1753
|
-
export type ContentListItemsResponses = {
|
|
1754
|
-
/**
|
|
1755
|
-
* OK
|
|
1756
|
-
*/
|
|
1757
|
-
200: ContentMetadataPage;
|
|
1758
|
-
};
|
|
1759
|
-
export type ContentListItemsResponse = ContentListItemsResponses[keyof ContentListItemsResponses];
|
|
1760
|
-
export type ContentListAssetsData = {
|
|
1761
|
-
body?: never;
|
|
1762
|
-
path: {
|
|
1763
|
-
/**
|
|
1764
|
-
* The key of the content to retrieve assets for.
|
|
1765
|
-
*/
|
|
1766
|
-
key: string;
|
|
1767
|
-
};
|
|
1768
|
-
query?: {
|
|
1769
|
-
/**
|
|
1770
|
-
* Indicates which content types or base types to include in the list.
|
|
1771
|
-
*/
|
|
1772
|
-
contentTypes?: Array<string>;
|
|
1773
|
-
pageIndex?: number;
|
|
1774
|
-
pageSize?: number;
|
|
1775
|
-
};
|
|
1776
|
-
url: '/content/{key}/assets';
|
|
1777
|
-
};
|
|
1778
|
-
export type ContentListAssetsErrors = {
|
|
1779
|
-
/**
|
|
1780
|
-
* Forbidden
|
|
1781
|
-
*/
|
|
1782
|
-
403: ProblemDetails;
|
|
1783
|
-
};
|
|
1784
|
-
export type ContentListAssetsError = ContentListAssetsErrors[keyof ContentListAssetsErrors];
|
|
1785
|
-
export type ContentListAssetsResponses = {
|
|
1786
|
-
/**
|
|
1787
|
-
* OK
|
|
1788
|
-
*/
|
|
1789
|
-
200: ContentMetadataPage;
|
|
1790
|
-
};
|
|
1791
|
-
export type ContentListAssetsResponse = ContentListAssetsResponses[keyof ContentListAssetsResponses];
|
|
1792
|
-
export type ContentCopyData = {
|
|
1793
|
-
/**
|
|
1794
|
-
* Optional instructions for how to copy content.
|
|
1795
|
-
*/
|
|
1796
|
-
body?: CopyContentOptions;
|
|
1797
|
-
path: {
|
|
1798
|
-
/**
|
|
1799
|
-
* The key of the content item to copy.
|
|
1800
|
-
*/
|
|
1801
|
-
key: string;
|
|
1802
|
-
};
|
|
1803
|
-
query?: never;
|
|
1804
|
-
url: '/content/{key}:copy';
|
|
1805
|
-
};
|
|
1806
|
-
export type ContentCopyErrors = {
|
|
1807
|
-
/**
|
|
1808
|
-
* Bad Request
|
|
1809
|
-
*/
|
|
1810
|
-
400: ProblemDetails;
|
|
1811
|
-
/**
|
|
1812
|
-
* Forbidden
|
|
1813
|
-
*/
|
|
1814
|
-
403: ProblemDetails;
|
|
1815
|
-
};
|
|
1816
|
-
export type ContentCopyError = ContentCopyErrors[keyof ContentCopyErrors];
|
|
1817
|
-
export type ContentCopyResponses = {
|
|
1818
|
-
/**
|
|
1819
|
-
* OK
|
|
1820
|
-
*/
|
|
1821
|
-
200: ContentMetadata;
|
|
1822
|
-
};
|
|
1823
|
-
export type ContentCopyResponse = ContentCopyResponses[keyof ContentCopyResponses];
|
|
1824
|
-
export type ContentUndeleteData = {
|
|
1825
|
-
body?: never;
|
|
1826
|
-
path: {
|
|
1827
|
-
/**
|
|
1828
|
-
* The key of the content item to undelete.
|
|
1829
|
-
*/
|
|
1830
|
-
key: string;
|
|
1831
|
-
};
|
|
1832
|
-
query?: never;
|
|
1833
|
-
url: '/content/{key}:undelete';
|
|
1834
|
-
};
|
|
1835
|
-
export type ContentUndeleteErrors = {
|
|
1836
|
-
/**
|
|
1837
|
-
* Bad Request
|
|
1838
|
-
*/
|
|
1839
|
-
400: ProblemDetails;
|
|
1840
|
-
/**
|
|
1841
|
-
* Forbidden
|
|
1842
|
-
*/
|
|
1843
|
-
403: ProblemDetails;
|
|
1844
|
-
};
|
|
1845
|
-
export type ContentUndeleteError = ContentUndeleteErrors[keyof ContentUndeleteErrors];
|
|
1846
|
-
export type ContentUndeleteResponses = {
|
|
1847
|
-
/**
|
|
1848
|
-
* OK
|
|
1849
|
-
*/
|
|
1850
|
-
200: ContentMetadata;
|
|
1851
|
-
};
|
|
1852
|
-
export type ContentUndeleteResponse = ContentUndeleteResponses[keyof ContentUndeleteResponses];
|
|
1853
|
-
export type ContentListAllVersionsData = {
|
|
1854
|
-
body?: never;
|
|
1855
|
-
path?: never;
|
|
1856
|
-
query?: {
|
|
1857
|
-
/**
|
|
1858
|
-
* Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
|
|
1859
|
-
* Locale must be a valid IETF BCP-47 language tag.
|
|
1860
|
-
*/
|
|
1861
|
-
locales?: Array<string>;
|
|
1862
|
-
/**
|
|
1863
|
-
* Indicates which status content versions must have to be listed.
|
|
1864
|
-
*/
|
|
1865
|
-
statuses?: Array<VersionStatus>;
|
|
1866
|
-
pageIndex?: number;
|
|
1867
|
-
pageSize?: number;
|
|
1868
|
-
};
|
|
1869
|
-
url: '/content/versions';
|
|
1870
|
-
};
|
|
1871
|
-
export type ContentListAllVersionsErrors = {
|
|
1872
|
-
/**
|
|
1873
|
-
* Forbidden
|
|
1874
|
-
*/
|
|
1875
|
-
403: ProblemDetails;
|
|
1876
|
-
};
|
|
1877
|
-
export type ContentListAllVersionsError = ContentListAllVersionsErrors[keyof ContentListAllVersionsErrors];
|
|
1878
|
-
export type ContentListAllVersionsResponses = {
|
|
1879
|
-
/**
|
|
1880
|
-
* OK
|
|
1881
|
-
*/
|
|
1882
|
-
200: ContentItemListWithContentTypes;
|
|
1883
|
-
};
|
|
1884
|
-
export type ContentListAllVersionsResponse = ContentListAllVersionsResponses[keyof ContentListAllVersionsResponses];
|
|
1885
|
-
export type ContentDeleteLocaleData = {
|
|
1886
|
-
body?: never;
|
|
1887
|
-
path: {
|
|
1888
|
-
key: string;
|
|
1889
|
-
};
|
|
1890
|
-
query?: {
|
|
1891
|
-
locale?: string;
|
|
1892
|
-
};
|
|
1893
|
-
url: '/content/{key}/versions';
|
|
1894
|
-
};
|
|
1895
|
-
export type ContentDeleteLocaleErrors = {
|
|
1896
|
-
/**
|
|
1897
|
-
* Bad Request
|
|
1898
|
-
*/
|
|
1899
|
-
400: ProblemDetails;
|
|
1900
|
-
/**
|
|
1901
|
-
* Forbidden
|
|
1902
|
-
*/
|
|
1903
|
-
403: ProblemDetails;
|
|
1904
|
-
};
|
|
1905
|
-
export type ContentDeleteLocaleError = ContentDeleteLocaleErrors[keyof ContentDeleteLocaleErrors];
|
|
1906
|
-
export type ContentDeleteLocaleResponses = {
|
|
1907
|
-
/**
|
|
1908
|
-
* OK
|
|
1909
|
-
*/
|
|
1910
|
-
200: ContentItemWithContentTypes;
|
|
1911
|
-
};
|
|
1912
|
-
export type ContentDeleteLocaleResponse = ContentDeleteLocaleResponses[keyof ContentDeleteLocaleResponses];
|
|
1913
|
-
export type ContentListVersionsData = {
|
|
1914
|
-
body?: never;
|
|
1915
|
-
path: {
|
|
1916
|
-
key: string;
|
|
1917
|
-
};
|
|
1918
|
-
query?: {
|
|
1919
|
-
/**
|
|
1920
|
-
* Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
|
|
1921
|
-
* Locale must be a valid IETF BCP-47 language tag.
|
|
1922
|
-
*/
|
|
1923
|
-
locales?: Array<string>;
|
|
1924
|
-
/**
|
|
1925
|
-
* Indicates which status content versions must have to be listed.
|
|
1926
|
-
*/
|
|
1927
|
-
statuses?: Array<VersionStatus>;
|
|
1928
|
-
pageIndex?: number;
|
|
1929
|
-
pageSize?: number;
|
|
1930
|
-
};
|
|
1931
|
-
url: '/content/{key}/versions';
|
|
1932
|
-
};
|
|
1933
|
-
export type ContentListVersionsErrors = {
|
|
1934
|
-
/**
|
|
1935
|
-
* Forbidden
|
|
1936
|
-
*/
|
|
1937
|
-
403: ProblemDetails;
|
|
1938
|
-
};
|
|
1939
|
-
export type ContentListVersionsError = ContentListVersionsErrors[keyof ContentListVersionsErrors];
|
|
1940
|
-
export type ContentListVersionsResponses = {
|
|
1941
|
-
/**
|
|
1942
|
-
* OK
|
|
1943
|
-
*/
|
|
1944
|
-
200: ContentItemListWithContentTypes;
|
|
1945
|
-
};
|
|
1946
|
-
export type ContentListVersionsResponse = ContentListVersionsResponses[keyof ContentListVersionsResponses];
|
|
1947
|
-
export type ContentCreateVersionData = {
|
|
1948
|
-
/**
|
|
1949
|
-
* The content version that should be created.
|
|
1950
|
-
*/
|
|
1951
|
-
body: ContentItem;
|
|
1952
|
-
path: {
|
|
1953
|
-
/**
|
|
1954
|
-
* The key of the content item for which a new content version should be created.
|
|
1955
|
-
*/
|
|
1956
|
-
key: string;
|
|
1957
|
-
};
|
|
1958
|
-
query?: {
|
|
1959
|
-
/**
|
|
1960
|
-
* Indicates that the content validation should be ignored.
|
|
1961
|
-
*/
|
|
1962
|
-
skipValidation?: boolean;
|
|
1963
|
-
};
|
|
1964
|
-
url: '/content/{key}/versions';
|
|
1965
|
-
};
|
|
1966
|
-
export type ContentCreateVersionErrors = {
|
|
1967
|
-
/**
|
|
1968
|
-
* Bad Request
|
|
584
|
+
* The optional key of the content type this display template is valid for.
|
|
1969
585
|
*/
|
|
1970
|
-
|
|
586
|
+
contentType?: string | null;
|
|
1971
587
|
/**
|
|
1972
|
-
*
|
|
588
|
+
* If this is the default display template for the associated base type, node type or content type.
|
|
1973
589
|
*/
|
|
1974
|
-
|
|
1975
|
-
};
|
|
1976
|
-
export type ContentCreateVersionError = ContentCreateVersionErrors[keyof ContentCreateVersionErrors];
|
|
1977
|
-
export type ContentCreateVersionResponses = {
|
|
590
|
+
isDefault?: boolean;
|
|
1978
591
|
/**
|
|
1979
|
-
*
|
|
592
|
+
* The available settings for this display template.
|
|
1980
593
|
*/
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
export type ContentCreateVersionResponse = ContentCreateVersionResponses[keyof ContentCreateVersionResponses];
|
|
1984
|
-
export type ContentDeleteVersionData = {
|
|
1985
|
-
body?: never;
|
|
1986
|
-
path: {
|
|
1987
|
-
key: string;
|
|
1988
|
-
version: string;
|
|
594
|
+
settings?: {
|
|
595
|
+
[key: string]: DisplaySetting;
|
|
1989
596
|
};
|
|
1990
|
-
query?: never;
|
|
1991
|
-
url: '/content/{key}/versions/{version}';
|
|
1992
597
|
};
|
|
1993
|
-
export type
|
|
598
|
+
export type DisplayTemplatePageWritable = {
|
|
599
|
+
[key: string]: never;
|
|
600
|
+
};
|
|
601
|
+
/**
|
|
602
|
+
* Represent the definition of semantic property formats for content items.
|
|
603
|
+
*/
|
|
604
|
+
export type PropertyFormatWritable = {
|
|
1994
605
|
/**
|
|
1995
|
-
*
|
|
606
|
+
* The key that identifies this PropertyFormat.
|
|
1996
607
|
*/
|
|
1997
|
-
|
|
608
|
+
key?: string;
|
|
1998
609
|
/**
|
|
1999
|
-
*
|
|
610
|
+
* The underlying data type used for this PropertyFormat.
|
|
2000
611
|
*/
|
|
2001
|
-
|
|
2002
|
-
};
|
|
2003
|
-
export type ContentDeleteVersionError = ContentDeleteVersionErrors[keyof ContentDeleteVersionErrors];
|
|
2004
|
-
export type ContentDeleteVersionResponses = {
|
|
612
|
+
dataType?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
2005
613
|
/**
|
|
2006
|
-
*
|
|
614
|
+
* The underlying item type used for this PropertyFormat.
|
|
2007
615
|
*/
|
|
2008
|
-
|
|
2009
|
-
};
|
|
2010
|
-
export type ContentDeleteVersionResponse = ContentDeleteVersionResponses[keyof ContentDeleteVersionResponses];
|
|
2011
|
-
export type ContentGetVersionData = {
|
|
2012
|
-
body?: never;
|
|
2013
|
-
path: {
|
|
2014
|
-
key: string;
|
|
2015
|
-
version: string;
|
|
2016
|
-
};
|
|
2017
|
-
query?: {
|
|
2018
|
-
locale?: string;
|
|
2019
|
-
};
|
|
2020
|
-
url: '/content/{key}/versions/{version}';
|
|
2021
|
-
};
|
|
2022
|
-
export type ContentGetVersionErrors = {
|
|
616
|
+
itemType?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
2023
617
|
/**
|
|
2024
|
-
*
|
|
618
|
+
* The name and identifier of this PropertyFormat.
|
|
2025
619
|
*/
|
|
2026
|
-
|
|
620
|
+
displayName?: string;
|
|
2027
621
|
};
|
|
2028
|
-
export type
|
|
2029
|
-
|
|
2030
|
-
/**
|
|
2031
|
-
* OK
|
|
2032
|
-
*/
|
|
2033
|
-
200: ContentItemWithContentTypes;
|
|
622
|
+
export type PropertyFormatPageWritable = {
|
|
623
|
+
[key: string]: never;
|
|
2034
624
|
};
|
|
2035
|
-
|
|
2036
|
-
|
|
625
|
+
/**
|
|
626
|
+
* Describes a property group of a ContentType in the CMS.
|
|
627
|
+
*/
|
|
628
|
+
export type PropertyGroupWritable = {
|
|
2037
629
|
/**
|
|
2038
|
-
* The
|
|
630
|
+
* The key that identifies this PropertyGroup.
|
|
2039
631
|
*/
|
|
2040
|
-
|
|
2041
|
-
path: {
|
|
2042
|
-
/**
|
|
2043
|
-
* The key of the content item that should be updated.
|
|
2044
|
-
*/
|
|
2045
|
-
key: string;
|
|
2046
|
-
/**
|
|
2047
|
-
* The version of the content that should be updated.
|
|
2048
|
-
*/
|
|
2049
|
-
version: string;
|
|
2050
|
-
};
|
|
2051
|
-
query?: {
|
|
2052
|
-
/**
|
|
2053
|
-
* The locale of the content that should be updated.
|
|
2054
|
-
*/
|
|
2055
|
-
locale?: string;
|
|
2056
|
-
/**
|
|
2057
|
-
* Indicates that the content validation should be ignored.
|
|
2058
|
-
*/
|
|
2059
|
-
skipValidation?: boolean;
|
|
2060
|
-
};
|
|
2061
|
-
url: '/content/{key}/versions/{version}';
|
|
2062
|
-
};
|
|
2063
|
-
export type ContentPatchVersionErrors = {
|
|
632
|
+
key?: string;
|
|
2064
633
|
/**
|
|
2065
|
-
*
|
|
634
|
+
* The display name of this PropertyGroup.
|
|
2066
635
|
*/
|
|
2067
|
-
|
|
636
|
+
displayName?: string;
|
|
2068
637
|
/**
|
|
2069
|
-
*
|
|
638
|
+
* An value that is used to when sorting PropertyGroup instances.
|
|
2070
639
|
*/
|
|
2071
|
-
|
|
640
|
+
sortOrder?: number;
|
|
2072
641
|
};
|
|
2073
|
-
export type
|
|
2074
|
-
|
|
2075
|
-
/**
|
|
2076
|
-
* OK
|
|
2077
|
-
*/
|
|
2078
|
-
200: ContentItemWithContentTypes;
|
|
642
|
+
export type PropertyGroupPageWritable = {
|
|
643
|
+
[key: string]: never;
|
|
2079
644
|
};
|
|
2080
|
-
export type ContentPatchVersionResponse = ContentPatchVersionResponses[keyof ContentPatchVersionResponses];
|
|
2081
645
|
export type ContentTypesListData = {
|
|
2082
646
|
body?: never;
|
|
2083
647
|
path?: never;
|
|
@@ -2088,8 +652,7 @@ export type ContentTypesListData = {
|
|
|
2088
652
|
forContainerType?: string;
|
|
2089
653
|
/**
|
|
2090
654
|
* Indicates which sources should be included when listing content types.
|
|
2091
|
-
* Use
|
|
2092
|
-
* Default to include content types without a specific sources.
|
|
655
|
+
* Use 'DEFAULT' to include content types without a specific source.
|
|
2093
656
|
*/
|
|
2094
657
|
sources?: Array<string>;
|
|
2095
658
|
pageIndex?: number;
|
|
@@ -2113,9 +676,9 @@ export type ContentTypesListResponses = {
|
|
|
2113
676
|
export type ContentTypesListResponse = ContentTypesListResponses[keyof ContentTypesListResponses];
|
|
2114
677
|
export type ContentTypesCreateData = {
|
|
2115
678
|
/**
|
|
2116
|
-
* The content type that should be created.
|
|
679
|
+
* The content type that should be created or replaced.
|
|
2117
680
|
*/
|
|
2118
|
-
body:
|
|
681
|
+
body: ContentTypeWritable;
|
|
2119
682
|
path?: never;
|
|
2120
683
|
query?: never;
|
|
2121
684
|
url: '/contenttypes';
|
|
@@ -2133,13 +696,23 @@ export type ContentTypesCreateErrors = {
|
|
|
2133
696
|
export type ContentTypesCreateError = ContentTypesCreateErrors[keyof ContentTypesCreateErrors];
|
|
2134
697
|
export type ContentTypesCreateResponses = {
|
|
2135
698
|
/**
|
|
2136
|
-
*
|
|
699
|
+
* Created
|
|
2137
700
|
*/
|
|
2138
|
-
|
|
701
|
+
201: ContentType;
|
|
2139
702
|
};
|
|
2140
703
|
export type ContentTypesCreateResponse = ContentTypesCreateResponses[keyof ContentTypesCreateResponses];
|
|
2141
704
|
export type ContentTypesDeleteData = {
|
|
2142
705
|
body?: never;
|
|
706
|
+
headers?: {
|
|
707
|
+
/**
|
|
708
|
+
* If provided, the DELETE request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
|
|
709
|
+
*/
|
|
710
|
+
ifMatch?: string;
|
|
711
|
+
/**
|
|
712
|
+
* If provided, the DELETE request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
|
|
713
|
+
*/
|
|
714
|
+
ifUnmodifiedSince?: string;
|
|
715
|
+
};
|
|
2143
716
|
path: {
|
|
2144
717
|
/**
|
|
2145
718
|
* The key of the content type to delete.
|
|
@@ -2158,6 +731,14 @@ export type ContentTypesDeleteErrors = {
|
|
|
2158
731
|
* Forbidden
|
|
2159
732
|
*/
|
|
2160
733
|
403: ProblemDetails;
|
|
734
|
+
/**
|
|
735
|
+
* Not Found
|
|
736
|
+
*/
|
|
737
|
+
404: ProblemDetails;
|
|
738
|
+
/**
|
|
739
|
+
* Precondition Failed
|
|
740
|
+
*/
|
|
741
|
+
412: ProblemDetails;
|
|
2161
742
|
};
|
|
2162
743
|
export type ContentTypesDeleteError = ContentTypesDeleteErrors[keyof ContentTypesDeleteErrors];
|
|
2163
744
|
export type ContentTypesDeleteResponses = {
|
|
@@ -2169,6 +750,16 @@ export type ContentTypesDeleteResponses = {
|
|
|
2169
750
|
export type ContentTypesDeleteResponse = ContentTypesDeleteResponses[keyof ContentTypesDeleteResponses];
|
|
2170
751
|
export type ContentTypesGetData = {
|
|
2171
752
|
body?: never;
|
|
753
|
+
headers?: {
|
|
754
|
+
/**
|
|
755
|
+
* If provided and the value matches the RFC7232 ETag of the current resource a 304 NotModified response will be returned. Weak ETags will always be ignored.
|
|
756
|
+
*/
|
|
757
|
+
ifNoneMatch?: string;
|
|
758
|
+
/**
|
|
759
|
+
* If provided and the resource has not been modified since the date a 304 NotModified response will be returned. This parameter will be ignored if an 'If-None-Match' parameter is also provided.
|
|
760
|
+
*/
|
|
761
|
+
ifModifiedSince?: string;
|
|
762
|
+
};
|
|
2172
763
|
path: {
|
|
2173
764
|
/**
|
|
2174
765
|
* The key of the content type to retrieve.
|
|
@@ -2183,6 +774,10 @@ export type ContentTypesGetErrors = {
|
|
|
2183
774
|
* Forbidden
|
|
2184
775
|
*/
|
|
2185
776
|
403: ProblemDetails;
|
|
777
|
+
/**
|
|
778
|
+
* Not Found
|
|
779
|
+
*/
|
|
780
|
+
404: ProblemDetails;
|
|
2186
781
|
};
|
|
2187
782
|
export type ContentTypesGetError = ContentTypesGetErrors[keyof ContentTypesGetErrors];
|
|
2188
783
|
export type ContentTypesGetResponses = {
|
|
@@ -2194,21 +789,30 @@ export type ContentTypesGetResponses = {
|
|
|
2194
789
|
export type ContentTypesGetResponse = ContentTypesGetResponses[keyof ContentTypesGetResponses];
|
|
2195
790
|
export type ContentTypesPatchData = {
|
|
2196
791
|
/**
|
|
2197
|
-
* The values of the content type that should be
|
|
792
|
+
* The values of the content type that should be patched formatted according to RFC7396.
|
|
2198
793
|
*/
|
|
2199
|
-
body:
|
|
2200
|
-
|
|
794
|
+
body: ContentTypeWritable;
|
|
795
|
+
headers?: {
|
|
2201
796
|
/**
|
|
2202
|
-
*
|
|
797
|
+
* Patch the content type even though the changes might result in data loss.
|
|
2203
798
|
*/
|
|
2204
|
-
|
|
799
|
+
cmsIgnoreDataLossWarnings?: boolean;
|
|
800
|
+
/**
|
|
801
|
+
* If provided, the PATCH request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
|
|
802
|
+
*/
|
|
803
|
+
ifMatch?: string;
|
|
804
|
+
/**
|
|
805
|
+
* If provided, the PATCH request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
|
|
806
|
+
*/
|
|
807
|
+
ifUnmodifiedSince?: string;
|
|
2205
808
|
};
|
|
2206
|
-
|
|
809
|
+
path: {
|
|
2207
810
|
/**
|
|
2208
|
-
*
|
|
811
|
+
* The key of the content type to patch.
|
|
2209
812
|
*/
|
|
2210
|
-
|
|
813
|
+
key: string;
|
|
2211
814
|
};
|
|
815
|
+
query?: never;
|
|
2212
816
|
url: '/contenttypes/{key}';
|
|
2213
817
|
};
|
|
2214
818
|
export type ContentTypesPatchErrors = {
|
|
@@ -2220,52 +824,23 @@ export type ContentTypesPatchErrors = {
|
|
|
2220
824
|
* Forbidden
|
|
2221
825
|
*/
|
|
2222
826
|
403: ProblemDetails;
|
|
2223
|
-
};
|
|
2224
|
-
export type ContentTypesPatchError = ContentTypesPatchErrors[keyof ContentTypesPatchErrors];
|
|
2225
|
-
export type ContentTypesPatchResponses = {
|
|
2226
|
-
/**
|
|
2227
|
-
* OK
|
|
2228
|
-
*/
|
|
2229
|
-
200: ContentType;
|
|
2230
|
-
};
|
|
2231
|
-
export type ContentTypesPatchResponse = ContentTypesPatchResponses[keyof ContentTypesPatchResponses];
|
|
2232
|
-
export type ContentTypesPutData = {
|
|
2233
|
-
/**
|
|
2234
|
-
* The values of the created or replaced content type.
|
|
2235
|
-
*/
|
|
2236
|
-
body: ContentType;
|
|
2237
|
-
path: {
|
|
2238
|
-
/**
|
|
2239
|
-
* The key of the content type to update or create.
|
|
2240
|
-
*/
|
|
2241
|
-
key: string;
|
|
2242
|
-
};
|
|
2243
|
-
query?: {
|
|
2244
|
-
/**
|
|
2245
|
-
* Update the content type even though the changes might result in data loss.
|
|
2246
|
-
*/
|
|
2247
|
-
ignoreDataLossWarnings?: boolean;
|
|
2248
|
-
};
|
|
2249
|
-
url: '/contenttypes/{key}';
|
|
2250
|
-
};
|
|
2251
|
-
export type ContentTypesPutErrors = {
|
|
2252
827
|
/**
|
|
2253
|
-
*
|
|
828
|
+
* Not Found
|
|
2254
829
|
*/
|
|
2255
|
-
|
|
830
|
+
404: ProblemDetails;
|
|
2256
831
|
/**
|
|
2257
|
-
*
|
|
832
|
+
* Precondition Failed
|
|
2258
833
|
*/
|
|
2259
|
-
|
|
834
|
+
412: ProblemDetails;
|
|
2260
835
|
};
|
|
2261
|
-
export type
|
|
2262
|
-
export type
|
|
836
|
+
export type ContentTypesPatchError = ContentTypesPatchErrors[keyof ContentTypesPatchErrors];
|
|
837
|
+
export type ContentTypesPatchResponses = {
|
|
2263
838
|
/**
|
|
2264
839
|
* OK
|
|
2265
840
|
*/
|
|
2266
841
|
200: ContentType;
|
|
2267
842
|
};
|
|
2268
|
-
export type
|
|
843
|
+
export type ContentTypesPatchResponse = ContentTypesPatchResponses[keyof ContentTypesPatchResponses];
|
|
2269
844
|
export type DisplayTemplatesListData = {
|
|
2270
845
|
body?: never;
|
|
2271
846
|
path?: never;
|
|
@@ -2293,7 +868,7 @@ export type DisplayTemplatesCreateData = {
|
|
|
2293
868
|
/**
|
|
2294
869
|
* The display template that should be created.
|
|
2295
870
|
*/
|
|
2296
|
-
body:
|
|
871
|
+
body: DisplayTemplateWritable;
|
|
2297
872
|
path?: never;
|
|
2298
873
|
query?: never;
|
|
2299
874
|
url: '/displaytemplates';
|
|
@@ -2311,13 +886,23 @@ export type DisplayTemplatesCreateErrors = {
|
|
|
2311
886
|
export type DisplayTemplatesCreateError = DisplayTemplatesCreateErrors[keyof DisplayTemplatesCreateErrors];
|
|
2312
887
|
export type DisplayTemplatesCreateResponses = {
|
|
2313
888
|
/**
|
|
2314
|
-
*
|
|
889
|
+
* Created
|
|
2315
890
|
*/
|
|
2316
|
-
|
|
891
|
+
201: DisplayTemplate;
|
|
2317
892
|
};
|
|
2318
893
|
export type DisplayTemplatesCreateResponse = DisplayTemplatesCreateResponses[keyof DisplayTemplatesCreateResponses];
|
|
2319
894
|
export type DisplayTemplatesDeleteData = {
|
|
2320
895
|
body?: never;
|
|
896
|
+
headers?: {
|
|
897
|
+
/**
|
|
898
|
+
* If provided, the DELETE request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
|
|
899
|
+
*/
|
|
900
|
+
ifMatch?: string;
|
|
901
|
+
/**
|
|
902
|
+
* If provided, the DELETE request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
|
|
903
|
+
*/
|
|
904
|
+
ifUnmodifiedSince?: string;
|
|
905
|
+
};
|
|
2321
906
|
path: {
|
|
2322
907
|
/**
|
|
2323
908
|
* The key of the display template to delete.
|
|
@@ -2336,6 +921,14 @@ export type DisplayTemplatesDeleteErrors = {
|
|
|
2336
921
|
* Forbidden
|
|
2337
922
|
*/
|
|
2338
923
|
403: ProblemDetails;
|
|
924
|
+
/**
|
|
925
|
+
* Not Found
|
|
926
|
+
*/
|
|
927
|
+
404: ProblemDetails;
|
|
928
|
+
/**
|
|
929
|
+
* Precondition Failed
|
|
930
|
+
*/
|
|
931
|
+
412: ProblemDetails;
|
|
2339
932
|
};
|
|
2340
933
|
export type DisplayTemplatesDeleteError = DisplayTemplatesDeleteErrors[keyof DisplayTemplatesDeleteErrors];
|
|
2341
934
|
export type DisplayTemplatesDeleteResponses = {
|
|
@@ -2347,6 +940,16 @@ export type DisplayTemplatesDeleteResponses = {
|
|
|
2347
940
|
export type DisplayTemplatesDeleteResponse = DisplayTemplatesDeleteResponses[keyof DisplayTemplatesDeleteResponses];
|
|
2348
941
|
export type DisplayTemplatesGetData = {
|
|
2349
942
|
body?: never;
|
|
943
|
+
headers?: {
|
|
944
|
+
/**
|
|
945
|
+
* If provided and the value matches the RFC7232 ETag of the current resource a 304 NotModified response will be returned. Weak ETags will always be ignored.
|
|
946
|
+
*/
|
|
947
|
+
ifNoneMatch?: string;
|
|
948
|
+
/**
|
|
949
|
+
* If provided and the resource has not been modified since the date a 304 NotModified response will be returned. This parameter will be ignored if an 'If-None-Match' parameter is also provided.
|
|
950
|
+
*/
|
|
951
|
+
ifModifiedSince?: string;
|
|
952
|
+
};
|
|
2350
953
|
path: {
|
|
2351
954
|
/**
|
|
2352
955
|
* The key of the display template to retrieve.
|
|
@@ -2361,6 +964,10 @@ export type DisplayTemplatesGetErrors = {
|
|
|
2361
964
|
* Forbidden
|
|
2362
965
|
*/
|
|
2363
966
|
403: ProblemDetails;
|
|
967
|
+
/**
|
|
968
|
+
* Not Found
|
|
969
|
+
*/
|
|
970
|
+
404: ProblemDetails;
|
|
2364
971
|
};
|
|
2365
972
|
export type DisplayTemplatesGetError = DisplayTemplatesGetErrors[keyof DisplayTemplatesGetErrors];
|
|
2366
973
|
export type DisplayTemplatesGetResponses = {
|
|
@@ -2372,51 +979,29 @@ export type DisplayTemplatesGetResponses = {
|
|
|
2372
979
|
export type DisplayTemplatesGetResponse = DisplayTemplatesGetResponses[keyof DisplayTemplatesGetResponses];
|
|
2373
980
|
export type DisplayTemplatesPatchData = {
|
|
2374
981
|
/**
|
|
2375
|
-
* The values of the display template that should be
|
|
982
|
+
* The values of the display template that should be patched formatted according to RFC7396.
|
|
2376
983
|
*/
|
|
2377
|
-
body:
|
|
2378
|
-
|
|
984
|
+
body: DisplayTemplateWritable;
|
|
985
|
+
headers?: {
|
|
2379
986
|
/**
|
|
2380
|
-
*
|
|
987
|
+
* If provided, the PATCH request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
|
|
2381
988
|
*/
|
|
2382
|
-
|
|
989
|
+
ifMatch?: string;
|
|
990
|
+
/**
|
|
991
|
+
* If provided, the PATCH request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
|
|
992
|
+
*/
|
|
993
|
+
ifUnmodifiedSince?: string;
|
|
2383
994
|
};
|
|
2384
|
-
query?: never;
|
|
2385
|
-
url: '/displaytemplates/{key}';
|
|
2386
|
-
};
|
|
2387
|
-
export type DisplayTemplatesPatchErrors = {
|
|
2388
|
-
/**
|
|
2389
|
-
* Bad Request
|
|
2390
|
-
*/
|
|
2391
|
-
400: ProblemDetails;
|
|
2392
|
-
/**
|
|
2393
|
-
* Forbidden
|
|
2394
|
-
*/
|
|
2395
|
-
403: ProblemDetails;
|
|
2396
|
-
};
|
|
2397
|
-
export type DisplayTemplatesPatchError = DisplayTemplatesPatchErrors[keyof DisplayTemplatesPatchErrors];
|
|
2398
|
-
export type DisplayTemplatesPatchResponses = {
|
|
2399
|
-
/**
|
|
2400
|
-
* OK
|
|
2401
|
-
*/
|
|
2402
|
-
200: DisplayTemplate;
|
|
2403
|
-
};
|
|
2404
|
-
export type DisplayTemplatesPatchResponse = DisplayTemplatesPatchResponses[keyof DisplayTemplatesPatchResponses];
|
|
2405
|
-
export type DisplayTemplatesPutData = {
|
|
2406
|
-
/**
|
|
2407
|
-
* The values of the created or replaced display template.
|
|
2408
|
-
*/
|
|
2409
|
-
body: DisplayTemplate;
|
|
2410
995
|
path: {
|
|
2411
996
|
/**
|
|
2412
|
-
* The key of the display template to
|
|
997
|
+
* The key of the display template to patch.
|
|
2413
998
|
*/
|
|
2414
999
|
key: string;
|
|
2415
1000
|
};
|
|
2416
1001
|
query?: never;
|
|
2417
1002
|
url: '/displaytemplates/{key}';
|
|
2418
1003
|
};
|
|
2419
|
-
export type
|
|
1004
|
+
export type DisplayTemplatesPatchErrors = {
|
|
2420
1005
|
/**
|
|
2421
1006
|
* Bad Request
|
|
2422
1007
|
*/
|
|
@@ -2425,35 +1010,23 @@ export type DisplayTemplatesPutErrors = {
|
|
|
2425
1010
|
* Forbidden
|
|
2426
1011
|
*/
|
|
2427
1012
|
403: ProblemDetails;
|
|
2428
|
-
};
|
|
2429
|
-
export type DisplayTemplatesPutError = DisplayTemplatesPutErrors[keyof DisplayTemplatesPutErrors];
|
|
2430
|
-
export type DisplayTemplatesPutResponses = {
|
|
2431
1013
|
/**
|
|
2432
|
-
*
|
|
1014
|
+
* Not Found
|
|
2433
1015
|
*/
|
|
2434
|
-
|
|
2435
|
-
};
|
|
2436
|
-
export type DisplayTemplatesPutResponse = DisplayTemplatesPutResponses[keyof DisplayTemplatesPutResponses];
|
|
2437
|
-
export type OauthTokenData = {
|
|
2438
|
-
body: OauthTokenRequest;
|
|
2439
|
-
path?: never;
|
|
2440
|
-
query?: never;
|
|
2441
|
-
url: '/oauth/token';
|
|
2442
|
-
};
|
|
2443
|
-
export type OauthTokenErrors = {
|
|
1016
|
+
404: ProblemDetails;
|
|
2444
1017
|
/**
|
|
2445
|
-
*
|
|
1018
|
+
* Precondition Failed
|
|
2446
1019
|
*/
|
|
2447
|
-
|
|
1020
|
+
412: ProblemDetails;
|
|
2448
1021
|
};
|
|
2449
|
-
export type
|
|
2450
|
-
export type
|
|
1022
|
+
export type DisplayTemplatesPatchError = DisplayTemplatesPatchErrors[keyof DisplayTemplatesPatchErrors];
|
|
1023
|
+
export type DisplayTemplatesPatchResponses = {
|
|
2451
1024
|
/**
|
|
2452
1025
|
* OK
|
|
2453
1026
|
*/
|
|
2454
|
-
200:
|
|
1027
|
+
200: DisplayTemplate;
|
|
2455
1028
|
};
|
|
2456
|
-
export type
|
|
1029
|
+
export type DisplayTemplatesPatchResponse = DisplayTemplatesPatchResponses[keyof DisplayTemplatesPatchResponses];
|
|
2457
1030
|
export type PropertyFormatsListData = {
|
|
2458
1031
|
body?: never;
|
|
2459
1032
|
path?: never;
|
|
@@ -2479,6 +1052,16 @@ export type PropertyFormatsListResponses = {
|
|
|
2479
1052
|
export type PropertyFormatsListResponse = PropertyFormatsListResponses[keyof PropertyFormatsListResponses];
|
|
2480
1053
|
export type PropertyFormatsGetData = {
|
|
2481
1054
|
body?: never;
|
|
1055
|
+
headers?: {
|
|
1056
|
+
/**
|
|
1057
|
+
* If provided and the value matches the RFC7232 ETag of the current resource a 304 NotModified response will be returned. Weak ETags will always be ignored.
|
|
1058
|
+
*/
|
|
1059
|
+
ifNoneMatch?: string;
|
|
1060
|
+
/**
|
|
1061
|
+
* If provided and the resource has not been modified since the date a 304 NotModified response will be returned. This parameter will be ignored if an 'If-None-Match' parameter is also provided.
|
|
1062
|
+
*/
|
|
1063
|
+
ifModifiedSince?: string;
|
|
1064
|
+
};
|
|
2482
1065
|
path: {
|
|
2483
1066
|
/**
|
|
2484
1067
|
* The key of the property format to retrieve.
|
|
@@ -2498,6 +1081,10 @@ export type PropertyFormatsGetErrors = {
|
|
|
2498
1081
|
* Forbidden
|
|
2499
1082
|
*/
|
|
2500
1083
|
403: ProblemDetails;
|
|
1084
|
+
/**
|
|
1085
|
+
* Not Found
|
|
1086
|
+
*/
|
|
1087
|
+
404: ProblemDetails;
|
|
2501
1088
|
};
|
|
2502
1089
|
export type PropertyFormatsGetError = PropertyFormatsGetErrors[keyof PropertyFormatsGetErrors];
|
|
2503
1090
|
export type PropertyFormatsGetResponses = {
|
|
@@ -2512,9 +1099,8 @@ export type PropertyGroupsListData = {
|
|
|
2512
1099
|
path?: never;
|
|
2513
1100
|
query?: {
|
|
2514
1101
|
/**
|
|
2515
|
-
* Indicates which property groups sources
|
|
2516
|
-
* Use
|
|
2517
|
-
* Default to include groups without a specific sources.
|
|
1102
|
+
* Indicates which property groups sources should be listed.
|
|
1103
|
+
* Use 'DEFAULT' to include groups without a specific sources.
|
|
2518
1104
|
*/
|
|
2519
1105
|
sources?: Array<string>;
|
|
2520
1106
|
};
|
|
@@ -2538,7 +1124,7 @@ export type PropertyGroupsCreateData = {
|
|
|
2538
1124
|
/**
|
|
2539
1125
|
* The property group that should be created.
|
|
2540
1126
|
*/
|
|
2541
|
-
body:
|
|
1127
|
+
body: PropertyGroupWritable;
|
|
2542
1128
|
path?: never;
|
|
2543
1129
|
query?: never;
|
|
2544
1130
|
url: '/propertygroups';
|
|
@@ -2556,13 +1142,23 @@ export type PropertyGroupsCreateErrors = {
|
|
|
2556
1142
|
export type PropertyGroupsCreateError = PropertyGroupsCreateErrors[keyof PropertyGroupsCreateErrors];
|
|
2557
1143
|
export type PropertyGroupsCreateResponses = {
|
|
2558
1144
|
/**
|
|
2559
|
-
*
|
|
1145
|
+
* Created
|
|
2560
1146
|
*/
|
|
2561
|
-
|
|
1147
|
+
201: PropertyGroup;
|
|
2562
1148
|
};
|
|
2563
1149
|
export type PropertyGroupsCreateResponse = PropertyGroupsCreateResponses[keyof PropertyGroupsCreateResponses];
|
|
2564
1150
|
export type PropertyGroupsDeleteData = {
|
|
2565
1151
|
body?: never;
|
|
1152
|
+
headers?: {
|
|
1153
|
+
/**
|
|
1154
|
+
* If provided, the DELETE request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
|
|
1155
|
+
*/
|
|
1156
|
+
ifMatch?: string;
|
|
1157
|
+
/**
|
|
1158
|
+
* If provided, the DELETE request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
|
|
1159
|
+
*/
|
|
1160
|
+
ifUnmodifiedSince?: string;
|
|
1161
|
+
};
|
|
2566
1162
|
path: {
|
|
2567
1163
|
/**
|
|
2568
1164
|
* The key of the property group to delete.
|
|
@@ -2581,6 +1177,14 @@ export type PropertyGroupsDeleteErrors = {
|
|
|
2581
1177
|
* Forbidden
|
|
2582
1178
|
*/
|
|
2583
1179
|
403: ProblemDetails;
|
|
1180
|
+
/**
|
|
1181
|
+
* Not Found
|
|
1182
|
+
*/
|
|
1183
|
+
404: ProblemDetails;
|
|
1184
|
+
/**
|
|
1185
|
+
* Precondition Failed
|
|
1186
|
+
*/
|
|
1187
|
+
412: ProblemDetails;
|
|
2584
1188
|
};
|
|
2585
1189
|
export type PropertyGroupsDeleteError = PropertyGroupsDeleteErrors[keyof PropertyGroupsDeleteErrors];
|
|
2586
1190
|
export type PropertyGroupsDeleteResponses = {
|
|
@@ -2592,6 +1196,16 @@ export type PropertyGroupsDeleteResponses = {
|
|
|
2592
1196
|
export type PropertyGroupsDeleteResponse = PropertyGroupsDeleteResponses[keyof PropertyGroupsDeleteResponses];
|
|
2593
1197
|
export type PropertyGroupsGetData = {
|
|
2594
1198
|
body?: never;
|
|
1199
|
+
headers?: {
|
|
1200
|
+
/**
|
|
1201
|
+
* If provided and the value matches the RFC7232 ETag of the current resource a 304 NotModified response will be returned. Weak ETags will always be ignored.
|
|
1202
|
+
*/
|
|
1203
|
+
ifNoneMatch?: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* If provided and the resource has not been modified since the date a 304 NotModified response will be returned. This parameter will be ignored if an 'If-None-Match' parameter is also provided.
|
|
1206
|
+
*/
|
|
1207
|
+
ifModifiedSince?: string;
|
|
1208
|
+
};
|
|
2595
1209
|
path: {
|
|
2596
1210
|
/**
|
|
2597
1211
|
* The key of the property group to retrieve.
|
|
@@ -2606,6 +1220,10 @@ export type PropertyGroupsGetErrors = {
|
|
|
2606
1220
|
* Forbidden
|
|
2607
1221
|
*/
|
|
2608
1222
|
403: ProblemDetails;
|
|
1223
|
+
/**
|
|
1224
|
+
* Not Found
|
|
1225
|
+
*/
|
|
1226
|
+
404: ProblemDetails;
|
|
2609
1227
|
};
|
|
2610
1228
|
export type PropertyGroupsGetError = PropertyGroupsGetErrors[keyof PropertyGroupsGetErrors];
|
|
2611
1229
|
export type PropertyGroupsGetResponses = {
|
|
@@ -2617,9 +1235,19 @@ export type PropertyGroupsGetResponses = {
|
|
|
2617
1235
|
export type PropertyGroupsGetResponse = PropertyGroupsGetResponses[keyof PropertyGroupsGetResponses];
|
|
2618
1236
|
export type PropertyGroupsPatchData = {
|
|
2619
1237
|
/**
|
|
2620
|
-
* The values of the property group that should be
|
|
1238
|
+
* The values of the property group that should be patched formatted according to RFC7396.
|
|
2621
1239
|
*/
|
|
2622
|
-
body:
|
|
1240
|
+
body: PropertyGroupWritable;
|
|
1241
|
+
headers?: {
|
|
1242
|
+
/**
|
|
1243
|
+
* If provided, the PATCH request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
|
|
1244
|
+
*/
|
|
1245
|
+
ifMatch?: string;
|
|
1246
|
+
/**
|
|
1247
|
+
* If provided, the PATCH request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
|
|
1248
|
+
*/
|
|
1249
|
+
ifUnmodifiedSince?: string;
|
|
1250
|
+
};
|
|
2623
1251
|
path: {
|
|
2624
1252
|
/**
|
|
2625
1253
|
* The key of the property group to patch.
|
|
@@ -2638,47 +1266,20 @@ export type PropertyGroupsPatchErrors = {
|
|
|
2638
1266
|
* Forbidden
|
|
2639
1267
|
*/
|
|
2640
1268
|
403: ProblemDetails;
|
|
2641
|
-
};
|
|
2642
|
-
export type PropertyGroupsPatchError = PropertyGroupsPatchErrors[keyof PropertyGroupsPatchErrors];
|
|
2643
|
-
export type PropertyGroupsPatchResponses = {
|
|
2644
|
-
/**
|
|
2645
|
-
* OK
|
|
2646
|
-
*/
|
|
2647
|
-
200: PropertyGroup;
|
|
2648
|
-
};
|
|
2649
|
-
export type PropertyGroupsPatchResponse = PropertyGroupsPatchResponses[keyof PropertyGroupsPatchResponses];
|
|
2650
|
-
export type PropertyGroupsPutData = {
|
|
2651
|
-
/**
|
|
2652
|
-
* The values of the created or replaced property group.
|
|
2653
|
-
*/
|
|
2654
|
-
body: PropertyGroup;
|
|
2655
|
-
path: {
|
|
2656
|
-
/**
|
|
2657
|
-
* The key of the property group to update or create.
|
|
2658
|
-
*/
|
|
2659
|
-
key: string;
|
|
2660
|
-
};
|
|
2661
|
-
query?: never;
|
|
2662
|
-
url: '/propertygroups/{key}';
|
|
2663
|
-
};
|
|
2664
|
-
export type PropertyGroupsPutErrors = {
|
|
2665
1269
|
/**
|
|
2666
|
-
*
|
|
1270
|
+
* Not Found
|
|
2667
1271
|
*/
|
|
2668
|
-
|
|
1272
|
+
404: ProblemDetails;
|
|
2669
1273
|
/**
|
|
2670
|
-
*
|
|
1274
|
+
* Precondition Failed
|
|
2671
1275
|
*/
|
|
2672
|
-
|
|
1276
|
+
412: ProblemDetails;
|
|
2673
1277
|
};
|
|
2674
|
-
export type
|
|
2675
|
-
export type
|
|
1278
|
+
export type PropertyGroupsPatchError = PropertyGroupsPatchErrors[keyof PropertyGroupsPatchErrors];
|
|
1279
|
+
export type PropertyGroupsPatchResponses = {
|
|
2676
1280
|
/**
|
|
2677
1281
|
* OK
|
|
2678
1282
|
*/
|
|
2679
1283
|
200: PropertyGroup;
|
|
2680
1284
|
};
|
|
2681
|
-
export type
|
|
2682
|
-
export type ClientOptions = {
|
|
2683
|
-
baseUrl: `${string}://${string}/_cms/preview2` | (string & {});
|
|
2684
|
-
};
|
|
1285
|
+
export type PropertyGroupsPatchResponse = PropertyGroupsPatchResponses[keyof PropertyGroupsPatchResponses];
|