@remkoj/optimizely-cms-api 6.0.0-pre8 → 6.0.0-rc.1
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 +7 -5
- package/dist/api-client.d.ts +9 -6
- package/dist/api-client.js +45 -40
- package/dist/client/client/{client.d.ts → client.gen.d.ts} +1 -1
- package/dist/client/client/client.gen.js +239 -0
- 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} +17 -19
- package/dist/client/{core/types.js → client/types.gen.js} +1 -0
- package/dist/client/client/{utils.d.ts → utils.gen.d.ts} +9 -21
- package/dist/client/client/{utils.js → utils.gen.js} +67 -124
- package/dist/client/client.gen.d.ts +3 -3
- package/dist/client/client.gen.js +2 -4
- package/dist/client/core/{auth.js → auth.gen.js} +1 -0
- package/dist/client/core/bodySerializer.gen.d.ts +25 -0
- package/dist/client/core/{bodySerializer.js → bodySerializer.gen.js} +5 -1
- package/dist/client/core/{params.d.ts → params.gen.d.ts} +20 -0
- package/dist/client/core/{params.js → params.gen.js} +19 -6
- package/dist/client/core/{pathSerializer.js → pathSerializer.gen.js} +4 -11
- package/dist/client/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/client/core/queryKeySerializer.gen.js +98 -0
- package/dist/client/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/client/core/serverSentEvents.gen.js +137 -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 +4 -4
- package/dist/client/index.js +99 -19
- package/dist/client/sdk.gen.d.ts +124 -70
- package/dist/client/sdk.gen.js +448 -490
- package/dist/client/transformers.gen.d.ts +14 -4
- package/dist/client/transformers.gen.js +143 -59
- package/dist/client/types.gen.d.ts +1231 -856
- 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 +3 -1
- package/dist/index.js +7 -1
- package/dist/types.d.ts +3 -1
- package/dist/types.js +1 -0
- package/dist/version.json +3 -3
- package/package.json +11 -15
- package/dist/client/client/client.js +0 -149
- package/dist/client/core/bodySerializer.d.ts +0 -17
- /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,18 +1,107 @@
|
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseUrl: 'https://api.cms.optimizely.com/preview3' | (string & {});
|
|
3
|
+
};
|
|
1
4
|
/**
|
|
2
|
-
* Describes
|
|
5
|
+
* Describes the list item of a content type property of type 'array'.
|
|
3
6
|
*/
|
|
4
|
-
export type
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
7
|
+
export type ArrayItem = {
|
|
8
|
+
/**
|
|
9
|
+
* Gets the data type for the list item property.
|
|
10
|
+
*/
|
|
11
|
+
type?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'component';
|
|
12
|
+
/**
|
|
13
|
+
* The key of the PropertyFormat that this property item is an instance of.
|
|
14
|
+
*/
|
|
15
|
+
format?: string | null;
|
|
16
|
+
/**
|
|
17
|
+
* The key of the content type that a property with 'type': 'component' may contain.
|
|
18
|
+
*/
|
|
19
|
+
contentType?: string | null;
|
|
20
|
+
/**
|
|
21
|
+
* The minimum value that properties of this type should be able to contain. Value type must match the type of the array item.
|
|
22
|
+
*/
|
|
23
|
+
minimum?: number | null | number | string | Date;
|
|
24
|
+
/**
|
|
25
|
+
* The maximum value that properties of this type should be able to contain. Value type must match the type of the array item.
|
|
26
|
+
*/
|
|
27
|
+
maximum?: number | null | number | string | Date;
|
|
28
|
+
/**
|
|
29
|
+
* The minimum string length that list items of this type should be able to contain.
|
|
30
|
+
*/
|
|
31
|
+
minLength?: number | null;
|
|
32
|
+
/**
|
|
33
|
+
* The maximum string length that list items of this type should be able to contain.
|
|
34
|
+
*/
|
|
35
|
+
maxLength?: number | null;
|
|
36
|
+
/**
|
|
37
|
+
* Regular expression pattern that limits what strings that list items of this type should be able to contain.
|
|
38
|
+
*/
|
|
39
|
+
pattern?: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* A list of possible values that properties of this type should be able to contain.
|
|
42
|
+
*/
|
|
43
|
+
enum?: Array<EnumerationValue> | null;
|
|
44
|
+
/**
|
|
45
|
+
* Specifies which content types and base types this property is allowed to contain.
|
|
46
|
+
*/
|
|
47
|
+
allowedTypes?: Array<string>;
|
|
48
|
+
/**
|
|
49
|
+
* Specifies which content types and base types this property cannot contain.
|
|
50
|
+
*/
|
|
51
|
+
restrictedTypes?: Array<string>;
|
|
8
52
|
};
|
|
9
53
|
/**
|
|
10
|
-
*
|
|
54
|
+
* Represents a blueprint of a content item.
|
|
11
55
|
*/
|
|
12
|
-
export type
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
56
|
+
export type Blueprint = {
|
|
57
|
+
/**
|
|
58
|
+
* The key that identifies this blueprint.
|
|
59
|
+
*/
|
|
60
|
+
readonly key?: string;
|
|
61
|
+
/**
|
|
62
|
+
* The display name of this blueprint.
|
|
63
|
+
*/
|
|
64
|
+
displayName: string;
|
|
65
|
+
/**
|
|
66
|
+
* The content type of this blueprint.
|
|
67
|
+
*/
|
|
68
|
+
readonly contentType?: string;
|
|
69
|
+
lastModified?: Date;
|
|
70
|
+
/**
|
|
71
|
+
* The username of the user that made the latest modification to this blueprint.
|
|
72
|
+
*/
|
|
73
|
+
readonly lastModifiedBy?: string;
|
|
74
|
+
content?: BlueprintData;
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* Represents the data part of a Blueprint.
|
|
78
|
+
*/
|
|
79
|
+
export type BlueprintData = {
|
|
80
|
+
/**
|
|
81
|
+
* Properties as they are defined by corresponding component or content type.
|
|
82
|
+
*/
|
|
83
|
+
properties?: {
|
|
84
|
+
[key: string]: unknown;
|
|
85
|
+
};
|
|
86
|
+
composition?: CompositionNode;
|
|
87
|
+
};
|
|
88
|
+
export type BlueprintPage = {
|
|
89
|
+
/**
|
|
90
|
+
* The items in this paged collection.
|
|
91
|
+
*/
|
|
92
|
+
readonly items?: Array<Blueprint>;
|
|
93
|
+
/**
|
|
94
|
+
* The zero-based index of the current page.
|
|
95
|
+
*/
|
|
96
|
+
readonly pageIndex?: number;
|
|
97
|
+
/**
|
|
98
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
99
|
+
*/
|
|
100
|
+
readonly pageSize?: number;
|
|
101
|
+
/**
|
|
102
|
+
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
103
|
+
*/
|
|
104
|
+
readonly totalItemCount?: number;
|
|
16
105
|
};
|
|
17
106
|
/**
|
|
18
107
|
* Changesets are used to group work on several content items together.
|
|
@@ -21,11 +110,11 @@ export type Changeset = {
|
|
|
21
110
|
/**
|
|
22
111
|
* The unique key of this Changeset.
|
|
23
112
|
*/
|
|
24
|
-
key
|
|
113
|
+
key?: string;
|
|
25
114
|
/**
|
|
26
|
-
* The source of this Changeset
|
|
115
|
+
* The source of this Changeset.
|
|
27
116
|
*/
|
|
28
|
-
source?: string;
|
|
117
|
+
readonly source?: string;
|
|
29
118
|
/**
|
|
30
119
|
* The name of this Changeset.
|
|
31
120
|
*/
|
|
@@ -60,7 +149,7 @@ export type ChangesetItemPage = {
|
|
|
60
149
|
*/
|
|
61
150
|
readonly pageIndex?: number;
|
|
62
151
|
/**
|
|
63
|
-
* The number of
|
|
152
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
64
153
|
*/
|
|
65
154
|
readonly pageSize?: number;
|
|
66
155
|
/**
|
|
@@ -78,7 +167,7 @@ export type ChangesetPage = {
|
|
|
78
167
|
*/
|
|
79
168
|
readonly pageIndex?: number;
|
|
80
169
|
/**
|
|
81
|
-
* The number of
|
|
170
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
82
171
|
*/
|
|
83
172
|
readonly pageSize?: number;
|
|
84
173
|
/**
|
|
@@ -87,81 +176,85 @@ export type ChangesetPage = {
|
|
|
87
176
|
readonly totalItemCount?: number;
|
|
88
177
|
};
|
|
89
178
|
/**
|
|
90
|
-
*
|
|
179
|
+
* Defines display settings for a CompositionNode."/>
|
|
91
180
|
*/
|
|
92
|
-
export type
|
|
93
|
-
type: 'ComponentListItem';
|
|
94
|
-
} & {
|
|
181
|
+
export type CompositionDisplaySettings = {
|
|
95
182
|
/**
|
|
96
|
-
* The key
|
|
183
|
+
* The key for the display template that these settings apply to.
|
|
97
184
|
*/
|
|
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
|
-
} & {
|
|
185
|
+
readonly displayTemplate: string;
|
|
106
186
|
/**
|
|
107
|
-
*
|
|
187
|
+
* Gets/sets the display settings for this CompositionNode.
|
|
108
188
|
*/
|
|
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";
|
|
189
|
+
settings?: {
|
|
190
|
+
[key: string]: string;
|
|
191
|
+
} | null;
|
|
121
192
|
};
|
|
122
193
|
/**
|
|
123
|
-
*
|
|
194
|
+
* Specifies a node in a content composition.
|
|
124
195
|
*/
|
|
125
|
-
export type
|
|
126
|
-
/**
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
readonly
|
|
138
|
-
|
|
196
|
+
export type CompositionNode = {
|
|
197
|
+
/**
|
|
198
|
+
* Specifies the id of this CompositionNode.
|
|
199
|
+
*/
|
|
200
|
+
id?: string | null;
|
|
201
|
+
/**
|
|
202
|
+
* The display name of this ContentType.
|
|
203
|
+
*/
|
|
204
|
+
displayName?: string | null;
|
|
205
|
+
/**
|
|
206
|
+
* Gets the node type of this CompositionNode.
|
|
207
|
+
*/
|
|
208
|
+
readonly nodeType?: string;
|
|
209
|
+
/**
|
|
210
|
+
* Gets the node layout type of this CompositionNode
|
|
211
|
+
*/
|
|
212
|
+
readonly layoutType?: string | null;
|
|
213
|
+
displaySettings?: CompositionDisplaySettings;
|
|
214
|
+
/**
|
|
215
|
+
* Represents a content component.
|
|
216
|
+
*/
|
|
217
|
+
component?: {
|
|
218
|
+
/**
|
|
219
|
+
* Dictionary with all custom properties as specified by associated ContentType
|
|
220
|
+
*/
|
|
221
|
+
properties?: unknown;
|
|
222
|
+
reference?: string;
|
|
223
|
+
/**
|
|
224
|
+
* The key of the content type that this is an embedded instance of.
|
|
225
|
+
*/
|
|
226
|
+
contentType?: string | null;
|
|
227
|
+
};
|
|
228
|
+
/**
|
|
229
|
+
* Gets the available child nodes for this CompositionNode.
|
|
230
|
+
*/
|
|
231
|
+
nodes?: Array<CompositionNode> | null;
|
|
139
232
|
};
|
|
140
233
|
/**
|
|
141
234
|
* Represents a content component.
|
|
142
235
|
*/
|
|
143
236
|
export type ContentComponent = {
|
|
144
|
-
/**
|
|
145
|
-
* The name of the content component. If Reference is set, the name is automatically set to the name of the referenced content.
|
|
146
|
-
*/
|
|
147
|
-
name?: string;
|
|
148
237
|
/**
|
|
149
238
|
* An optional display option for the content component.
|
|
150
239
|
*/
|
|
151
|
-
displayOption?: string;
|
|
240
|
+
displayOption?: string | null;
|
|
152
241
|
/**
|
|
153
242
|
* An optional group for the personalizable component.
|
|
154
243
|
*/
|
|
155
|
-
segmentationGroup?: string;
|
|
244
|
+
segmentationGroup?: string | null;
|
|
156
245
|
/**
|
|
157
246
|
* Specifies the settings for the content component.
|
|
158
247
|
*/
|
|
159
|
-
segments?: Array<string
|
|
248
|
+
segments?: Array<string> | null;
|
|
249
|
+
/**
|
|
250
|
+
* The display name of the content component. If Reference is set, the name is automatically set to the name of the referenced content.
|
|
251
|
+
*/
|
|
252
|
+
name?: string | null;
|
|
160
253
|
reference?: string;
|
|
161
254
|
/**
|
|
162
255
|
* The key of the content type that this is an embedded instance of.
|
|
163
256
|
*/
|
|
164
|
-
contentType?: string;
|
|
257
|
+
contentType?: string | null;
|
|
165
258
|
/**
|
|
166
259
|
* Dictionary with all custom properties as specified by associated ContentType
|
|
167
260
|
*/
|
|
@@ -180,19 +273,24 @@ export type ContentItem = {
|
|
|
180
273
|
/**
|
|
181
274
|
* The key that identifies this content item.
|
|
182
275
|
*/
|
|
183
|
-
readonly key
|
|
276
|
+
readonly key?: string;
|
|
184
277
|
/**
|
|
185
278
|
* The locale of this content instance.
|
|
186
279
|
*/
|
|
187
|
-
|
|
280
|
+
locale?: string;
|
|
188
281
|
/**
|
|
189
282
|
* The version identifier of this content instance.
|
|
190
283
|
*/
|
|
191
284
|
readonly version?: string;
|
|
285
|
+
/**
|
|
286
|
+
* The variation of this content item, if any. Variations are used to represent different states or forms of the same content item.
|
|
287
|
+
* A variation has it's own publish lifecycle. A variation can though not be published before the default version of same local is published.
|
|
288
|
+
*/
|
|
289
|
+
variation?: string | null;
|
|
192
290
|
/**
|
|
193
291
|
* The content type of this content item.
|
|
194
292
|
*/
|
|
195
|
-
|
|
293
|
+
contentType?: string;
|
|
196
294
|
/**
|
|
197
295
|
* The display name of this content item.
|
|
198
296
|
*/
|
|
@@ -205,7 +303,10 @@ export type ContentItem = {
|
|
|
205
303
|
* Indicates a time when this content expired or should expire.
|
|
206
304
|
*/
|
|
207
305
|
expired?: Date | null;
|
|
208
|
-
|
|
306
|
+
/**
|
|
307
|
+
* The status of this version of the content item.
|
|
308
|
+
*/
|
|
309
|
+
status?: 'draft' | 'ready' | 'published' | 'previous' | 'scheduled' | 'rejected' | 'inReview';
|
|
209
310
|
/**
|
|
210
311
|
* Indicates a time when this content version should transition to published status. Must only be assigned when Status is set to Scheduled.
|
|
211
312
|
*/
|
|
@@ -227,31 +328,7 @@ export type ContentItem = {
|
|
|
227
328
|
* The username of the user that made the latest modification to this content instance.
|
|
228
329
|
*/
|
|
229
330
|
readonly lastModifiedBy?: string;
|
|
230
|
-
|
|
231
|
-
/**
|
|
232
|
-
* The response object for Page`1 when used ContentType are included.
|
|
233
|
-
*/
|
|
234
|
-
export type ContentItemListWithContentTypes = {
|
|
235
|
-
/**
|
|
236
|
-
* The content types that are used by the content items in the response.
|
|
237
|
-
*/
|
|
238
|
-
readonly contentTypes?: Array<ContentType>;
|
|
239
|
-
/**
|
|
240
|
-
* The content items in this paged collection.
|
|
241
|
-
*/
|
|
242
|
-
readonly items?: Array<ContentItem>;
|
|
243
|
-
/**
|
|
244
|
-
* The zero-based index of the current page.
|
|
245
|
-
*/
|
|
246
|
-
readonly pageIndex?: number;
|
|
247
|
-
/**
|
|
248
|
-
* The number of item in each page. Not necessarily the same as the number of items in this page.
|
|
249
|
-
*/
|
|
250
|
-
readonly pageSize?: number;
|
|
251
|
-
/**
|
|
252
|
-
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
253
|
-
*/
|
|
254
|
-
readonly totalItemCount?: number;
|
|
331
|
+
composition?: CompositionNode;
|
|
255
332
|
};
|
|
256
333
|
export type ContentItemPage = {
|
|
257
334
|
/**
|
|
@@ -263,7 +340,7 @@ export type ContentItemPage = {
|
|
|
263
340
|
*/
|
|
264
341
|
readonly pageIndex?: number;
|
|
265
342
|
/**
|
|
266
|
-
* The number of
|
|
343
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
267
344
|
*/
|
|
268
345
|
readonly pageSize?: number;
|
|
269
346
|
/**
|
|
@@ -271,31 +348,6 @@ export type ContentItemPage = {
|
|
|
271
348
|
*/
|
|
272
349
|
readonly totalItemCount?: number;
|
|
273
350
|
};
|
|
274
|
-
/**
|
|
275
|
-
* The response object for ContentItem when used ContentType are included.
|
|
276
|
-
*/
|
|
277
|
-
export type ContentItemWithContentTypes = {
|
|
278
|
-
/**
|
|
279
|
-
* The content types that are used by the content item in the response.
|
|
280
|
-
*/
|
|
281
|
-
readonly contentTypes?: Array<ContentType>;
|
|
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
|
-
} & {
|
|
290
|
-
/**
|
|
291
|
-
* Specifies which content types and base types these property items are allowed to contain.
|
|
292
|
-
*/
|
|
293
|
-
allowedTypes?: Array<string>;
|
|
294
|
-
/**
|
|
295
|
-
* Specifies which content types and base types these property items cannot contain.
|
|
296
|
-
*/
|
|
297
|
-
restrictedTypes?: Array<string>;
|
|
298
|
-
};
|
|
299
351
|
/**
|
|
300
352
|
* Describes information about a locale instance of a content item.
|
|
301
353
|
*/
|
|
@@ -312,7 +364,10 @@ export type ContentLocaleInfo = {
|
|
|
312
364
|
* The username of the user that created this locale version of content.
|
|
313
365
|
*/
|
|
314
366
|
readonly createdBy?: string;
|
|
315
|
-
|
|
367
|
+
/**
|
|
368
|
+
* The status of the current locale.
|
|
369
|
+
*/
|
|
370
|
+
status?: 'draft' | 'published';
|
|
316
371
|
};
|
|
317
372
|
/**
|
|
318
373
|
* Represents metadata about a content item.
|
|
@@ -363,7 +418,7 @@ export type ContentMetadataPage = {
|
|
|
363
418
|
*/
|
|
364
419
|
readonly pageIndex?: number;
|
|
365
420
|
/**
|
|
366
|
-
* The number of
|
|
421
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
367
422
|
*/
|
|
368
423
|
readonly pageSize?: number;
|
|
369
424
|
/**
|
|
@@ -371,21 +426,6 @@ export type ContentMetadataPage = {
|
|
|
371
426
|
*/
|
|
372
427
|
readonly totalItemCount?: number;
|
|
373
428
|
};
|
|
374
|
-
/**
|
|
375
|
-
* Describes a property that can contain a content item.
|
|
376
|
-
*/
|
|
377
|
-
export type ContentProperty = ContentTypeProperty & {
|
|
378
|
-
type: 'ContentProperty';
|
|
379
|
-
} & {
|
|
380
|
-
/**
|
|
381
|
-
* Specifies which content types and base types this property is allowed to contain.
|
|
382
|
-
*/
|
|
383
|
-
allowedTypes?: Array<string>;
|
|
384
|
-
/**
|
|
385
|
-
* Specifies which content types and base types this property cannot contain.
|
|
386
|
-
*/
|
|
387
|
-
restrictedTypes?: Array<string>;
|
|
388
|
-
};
|
|
389
429
|
/**
|
|
390
430
|
* A reference to a specific content instance.
|
|
391
431
|
*/
|
|
@@ -403,36 +443,6 @@ export type ContentReference = {
|
|
|
403
443
|
*/
|
|
404
444
|
readonly version?: string;
|
|
405
445
|
};
|
|
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
|
-
} & {
|
|
412
|
-
/**
|
|
413
|
-
* Specifies which content types and base types these list items are allowed to reference.
|
|
414
|
-
*/
|
|
415
|
-
allowedTypes?: Array<string>;
|
|
416
|
-
/**
|
|
417
|
-
* Specifies which content types and base types these list items cannot contain.
|
|
418
|
-
*/
|
|
419
|
-
restrictedTypes?: Array<string>;
|
|
420
|
-
};
|
|
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>;
|
|
431
|
-
/**
|
|
432
|
-
* Specifies which content types and base types this property is restricted from referencing.
|
|
433
|
-
*/
|
|
434
|
-
restrictedTypes?: Array<string>;
|
|
435
|
-
};
|
|
436
446
|
/**
|
|
437
447
|
* A writable implementation of an ContentType.
|
|
438
448
|
*/
|
|
@@ -440,7 +450,7 @@ export type ContentType = {
|
|
|
440
450
|
/**
|
|
441
451
|
* The key that identifies this ContentType.
|
|
442
452
|
*/
|
|
443
|
-
key
|
|
453
|
+
key?: string;
|
|
444
454
|
/**
|
|
445
455
|
* The display name of this ContentType.
|
|
446
456
|
*/
|
|
@@ -449,26 +459,21 @@ export type ContentType = {
|
|
|
449
459
|
* A description of this ContentType.
|
|
450
460
|
*/
|
|
451
461
|
description?: string;
|
|
452
|
-
|
|
462
|
+
/**
|
|
463
|
+
* The base type of this ContentType.
|
|
464
|
+
* Ignored for contracts; required for all other content types.
|
|
465
|
+
*/
|
|
466
|
+
baseType?: string | null;
|
|
453
467
|
/**
|
|
454
468
|
* A string that is used to indicate the source of this ContentType.
|
|
455
469
|
*/
|
|
456
470
|
readonly source?: string;
|
|
457
471
|
/**
|
|
458
|
-
*
|
|
472
|
+
* A value that is used to when sorting ContentType instances.
|
|
459
473
|
*/
|
|
460
474
|
sortOrder?: number;
|
|
461
475
|
/**
|
|
462
|
-
* Provides a set of
|
|
463
|
-
* This value is assigned based on the BaseType and cannot be modified.
|
|
464
|
-
*/
|
|
465
|
-
features?: Array<ContentTypeFeature>;
|
|
466
|
-
/**
|
|
467
|
-
* Specifies how this ContentType can be used.
|
|
468
|
-
*/
|
|
469
|
-
usage?: Array<ContentTypeUsage>;
|
|
470
|
-
/**
|
|
471
|
-
* Provides a set of content types that can be created in container of this type
|
|
476
|
+
* Provides a set of content types that can be created in containers of this type
|
|
472
477
|
*/
|
|
473
478
|
mayContainTypes?: Array<string>;
|
|
474
479
|
/**
|
|
@@ -478,7 +483,7 @@ export type ContentType = {
|
|
|
478
483
|
/**
|
|
479
484
|
* Provides a set of composition behaviors specifying how this content type can be used within compositions.
|
|
480
485
|
*/
|
|
481
|
-
compositionBehaviors?: Array<
|
|
486
|
+
compositionBehaviors?: Array<'sectionEnabled' | 'elementEnabled' | 'formsElementEnabled'>;
|
|
482
487
|
/**
|
|
483
488
|
* A timestamp indicating when this ContentType was first created.
|
|
484
489
|
*/
|
|
@@ -495,56 +500,9 @@ export type ContentType = {
|
|
|
495
500
|
* Dictionary with all custom properties of this ContentType.
|
|
496
501
|
*/
|
|
497
502
|
properties?: {
|
|
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
|
-
};
|
|
503
|
+
[key: string]: ContentTypeProperty;
|
|
532
504
|
};
|
|
533
505
|
};
|
|
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";
|
|
547
|
-
};
|
|
548
506
|
export type ContentTypePage = {
|
|
549
507
|
/**
|
|
550
508
|
* The items in this paged collection.
|
|
@@ -555,7 +513,7 @@ export type ContentTypePage = {
|
|
|
555
513
|
*/
|
|
556
514
|
readonly pageIndex?: number;
|
|
557
515
|
/**
|
|
558
|
-
* The number of
|
|
516
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
559
517
|
*/
|
|
560
518
|
readonly pageSize?: number;
|
|
561
519
|
/**
|
|
@@ -567,11 +525,18 @@ export type ContentTypePage = {
|
|
|
567
525
|
* Describes a property of a ContentType in the CMS.
|
|
568
526
|
*/
|
|
569
527
|
export type ContentTypeProperty = {
|
|
570
|
-
|
|
528
|
+
/**
|
|
529
|
+
* Gets the data type for the property.
|
|
530
|
+
*/
|
|
531
|
+
type?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
571
532
|
/**
|
|
572
533
|
* The key of the PropertyFormat that this ContentTypeProperty is an instance of.
|
|
573
534
|
*/
|
|
574
535
|
format?: string | null;
|
|
536
|
+
/**
|
|
537
|
+
* The key of the content type that a property with 'type': 'component' may contain.
|
|
538
|
+
*/
|
|
539
|
+
contentType?: string | null;
|
|
575
540
|
/**
|
|
576
541
|
* The display name of this ContentTypeProperty.
|
|
577
542
|
*/
|
|
@@ -598,30 +563,53 @@ export type ContentTypeProperty = {
|
|
|
598
563
|
* An value that is used to when sorting ContentTypeProperty instances.
|
|
599
564
|
*/
|
|
600
565
|
sortOrder?: number;
|
|
601
|
-
indexingType?: IndexingType;
|
|
602
566
|
/**
|
|
603
|
-
*
|
|
567
|
+
* Indicates how should this property will be indexed in the search engine.
|
|
568
|
+
* If this value is not explicitly set, the property will be indexed using default indexing setting of the search engine.
|
|
604
569
|
*/
|
|
605
|
-
|
|
570
|
+
indexingType?: 'disabled' | 'queryable' | 'searchable';
|
|
606
571
|
/**
|
|
607
|
-
*
|
|
572
|
+
* The minimum value that properties of this type should be able to contain. Value type must match the type of the property.
|
|
608
573
|
*/
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
/**
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
574
|
+
minimum?: number | null | number | string | Date;
|
|
575
|
+
/**
|
|
576
|
+
* The minimum value that properties of this type should be able to contain. Value type must match the type of the property.
|
|
577
|
+
*/
|
|
578
|
+
maximum?: number | null | number | string | Date;
|
|
579
|
+
/**
|
|
580
|
+
* A list of possible values that properties of this type should be able to contain.
|
|
581
|
+
*/
|
|
582
|
+
enum?: Array<EnumerationValue> | null;
|
|
583
|
+
imageDescriptor?: ImageDescriptor;
|
|
584
|
+
/**
|
|
585
|
+
* The minimum string length that properties of this type should be able to contain.
|
|
586
|
+
*/
|
|
587
|
+
minLength?: number | null;
|
|
588
|
+
/**
|
|
589
|
+
* The maximum string length that properties of this type should be able to contain.
|
|
590
|
+
*/
|
|
591
|
+
maxLength?: number | null;
|
|
592
|
+
/**
|
|
593
|
+
* Regular expression pattern that limits what value that a string type property should be able to contain.
|
|
594
|
+
*/
|
|
595
|
+
pattern?: string | null;
|
|
596
|
+
/**
|
|
597
|
+
* Optional minimum list length validation.
|
|
598
|
+
*/
|
|
599
|
+
minItems?: number | null;
|
|
600
|
+
/**
|
|
601
|
+
* Optional maximum list length validation.
|
|
602
|
+
*/
|
|
603
|
+
maxItems?: number | null;
|
|
604
|
+
/**
|
|
605
|
+
* Specifies which content types and base types these property items are allowed to contain.
|
|
606
|
+
*/
|
|
607
|
+
allowedTypes?: Array<string>;
|
|
608
|
+
/**
|
|
609
|
+
* Specifies which content types and base types these property items cannot contain.
|
|
610
|
+
*/
|
|
611
|
+
restrictedTypes?: Array<string>;
|
|
612
|
+
items?: ArrayItem;
|
|
625
613
|
};
|
|
626
614
|
/**
|
|
627
615
|
* Options for copying content.
|
|
@@ -644,36 +632,6 @@ export type CopyContentOptions = {
|
|
|
644
632
|
*/
|
|
645
633
|
keepPublishedStatus?: boolean;
|
|
646
634
|
};
|
|
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
635
|
/**
|
|
678
636
|
* Describes a setting for a display template.
|
|
679
637
|
*/
|
|
@@ -717,7 +675,7 @@ export type DisplayTemplate = {
|
|
|
717
675
|
/**
|
|
718
676
|
* The key that identifies this display template.
|
|
719
677
|
*/
|
|
720
|
-
|
|
678
|
+
key?: string;
|
|
721
679
|
/**
|
|
722
680
|
* The display name of this display template.
|
|
723
681
|
*/
|
|
@@ -726,14 +684,16 @@ export type DisplayTemplate = {
|
|
|
726
684
|
* The optional node type this display template is valid for.
|
|
727
685
|
*/
|
|
728
686
|
nodeType?: string | null;
|
|
729
|
-
|
|
687
|
+
/**
|
|
688
|
+
* The optional base type this display template is valid for.
|
|
689
|
+
*/
|
|
690
|
+
baseType?: string | null;
|
|
730
691
|
/**
|
|
731
692
|
* The optional key of the content type this display template is valid for.
|
|
732
693
|
*/
|
|
733
694
|
contentType?: string | null;
|
|
734
695
|
/**
|
|
735
|
-
* If this is the default display template for the associated base type,
|
|
736
|
-
* node type or content type.
|
|
696
|
+
* If this is the default display template for the associated base type, node type or content type.
|
|
737
697
|
*/
|
|
738
698
|
isDefault?: boolean;
|
|
739
699
|
/**
|
|
@@ -769,7 +729,7 @@ export type DisplayTemplatePage = {
|
|
|
769
729
|
*/
|
|
770
730
|
readonly pageIndex?: number;
|
|
771
731
|
/**
|
|
772
|
-
* The number of
|
|
732
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
773
733
|
*/
|
|
774
734
|
readonly pageSize?: number;
|
|
775
735
|
/**
|
|
@@ -778,494 +738,731 @@ export type DisplayTemplatePage = {
|
|
|
778
738
|
readonly totalItemCount?: number;
|
|
779
739
|
};
|
|
780
740
|
/**
|
|
781
|
-
*
|
|
741
|
+
* Describes one value in an enumeration of possible values.
|
|
782
742
|
*/
|
|
783
|
-
export type
|
|
743
|
+
export type EnumerationValue = {
|
|
784
744
|
/**
|
|
785
|
-
*
|
|
745
|
+
* The defined enumeration value. Value type must match the property type.
|
|
786
746
|
*/
|
|
787
|
-
|
|
747
|
+
value: number | null | number | string | Date;
|
|
748
|
+
/**
|
|
749
|
+
* The display name of the enumeration value.
|
|
750
|
+
*/
|
|
751
|
+
displayName: string;
|
|
788
752
|
};
|
|
789
753
|
/**
|
|
790
|
-
*
|
|
754
|
+
* Instruction for generating an alternative image from the main binary of an image content item.
|
|
791
755
|
*/
|
|
792
|
-
export type
|
|
756
|
+
export type ImageDescriptor = {
|
|
793
757
|
/**
|
|
794
|
-
* The
|
|
758
|
+
* The image width in pixels.
|
|
795
759
|
*/
|
|
796
|
-
|
|
760
|
+
width?: number;
|
|
797
761
|
/**
|
|
798
|
-
* The
|
|
762
|
+
* The image height in pixels.
|
|
799
763
|
*/
|
|
800
|
-
|
|
764
|
+
height?: number;
|
|
765
|
+
/**
|
|
766
|
+
* Indicates if the image should be pre-generated when a new image is uploaded rather than when first requested.
|
|
767
|
+
*/
|
|
768
|
+
pregenerated?: boolean;
|
|
801
769
|
};
|
|
802
770
|
/**
|
|
803
|
-
*
|
|
771
|
+
* Represents a hyperlink.
|
|
804
772
|
*/
|
|
805
|
-
export type
|
|
806
|
-
|
|
807
|
-
|
|
773
|
+
export type Link = {
|
|
774
|
+
/**
|
|
775
|
+
* Gets or sets the URL.
|
|
776
|
+
*/
|
|
777
|
+
url?: string | null;
|
|
778
|
+
/**
|
|
779
|
+
* Gets or sets where to display the URL in a browsing context.
|
|
780
|
+
*/
|
|
781
|
+
target?: string;
|
|
808
782
|
/**
|
|
809
|
-
*
|
|
783
|
+
* Gets or sets the title of the link.
|
|
810
784
|
*/
|
|
811
|
-
|
|
785
|
+
title?: string;
|
|
812
786
|
/**
|
|
813
|
-
*
|
|
787
|
+
* Gets or sets the content inside a link.
|
|
814
788
|
*/
|
|
815
|
-
|
|
816
|
-
enum?: DoubleEnumerationSettings;
|
|
789
|
+
text?: string;
|
|
817
790
|
};
|
|
818
791
|
/**
|
|
819
|
-
*
|
|
792
|
+
* Represents a preview URL for a content item.
|
|
820
793
|
*/
|
|
821
|
-
export type
|
|
822
|
-
type: 'FloatProperty';
|
|
823
|
-
} & {
|
|
794
|
+
export type Preview = {
|
|
824
795
|
/**
|
|
825
|
-
* The
|
|
796
|
+
* The application that this preview URL is associated with.
|
|
826
797
|
*/
|
|
827
|
-
|
|
798
|
+
application?: string;
|
|
828
799
|
/**
|
|
829
|
-
*
|
|
800
|
+
* Gets or sets the preview URL (may be relative or absolute).
|
|
830
801
|
*/
|
|
831
|
-
|
|
832
|
-
enum?: DoubleEnumerationSettings;
|
|
802
|
+
url?: string;
|
|
833
803
|
};
|
|
834
|
-
|
|
835
|
-
* Instruction for generating an alternative image from the main binary of an image content item.
|
|
836
|
-
*/
|
|
837
|
-
export type ImageDescriptor = {
|
|
804
|
+
export type ProblemDetails = {
|
|
838
805
|
/**
|
|
839
|
-
*
|
|
806
|
+
* A URI reference that identifies the problem type.
|
|
840
807
|
*/
|
|
841
|
-
|
|
808
|
+
type?: string | null;
|
|
842
809
|
/**
|
|
843
|
-
*
|
|
810
|
+
* A short, human-readable summary of the problem type.
|
|
844
811
|
*/
|
|
845
|
-
|
|
812
|
+
title?: string | null;
|
|
846
813
|
/**
|
|
847
|
-
*
|
|
814
|
+
* The HTTP status code generated by the origin server for this occurrence of the problem.
|
|
848
815
|
*/
|
|
849
|
-
|
|
816
|
+
status?: number | null;
|
|
817
|
+
/**
|
|
818
|
+
* A human-readable explanation specific to this occurrence of the problem.
|
|
819
|
+
*/
|
|
820
|
+
detail?: string | null;
|
|
821
|
+
/**
|
|
822
|
+
* A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
|
|
823
|
+
*/
|
|
824
|
+
instance?: string | null;
|
|
825
|
+
/**
|
|
826
|
+
* Error code that identifies the problem type.
|
|
827
|
+
*/
|
|
828
|
+
code?: string | null;
|
|
829
|
+
/**
|
|
830
|
+
* An array of error details with more detailed information about the problem.
|
|
831
|
+
*/
|
|
832
|
+
errors?: Array<{
|
|
833
|
+
/**
|
|
834
|
+
* A granular explanation of one specific error related to a field, header or query parameter.
|
|
835
|
+
*/
|
|
836
|
+
detail?: string;
|
|
837
|
+
/**
|
|
838
|
+
* A string that may provide a hint to which field that was the source of the error.
|
|
839
|
+
*/
|
|
840
|
+
field?: string | null;
|
|
841
|
+
}> | null;
|
|
842
|
+
[key: string]: unknown;
|
|
850
843
|
};
|
|
851
844
|
/**
|
|
852
|
-
*
|
|
853
|
-
*/
|
|
854
|
-
export type IndexingType = 'disabled' | 'queryable' | 'searchable';
|
|
855
|
-
/**
|
|
856
|
-
* Represents the indexing type of a content type property.
|
|
845
|
+
* Represent the definition of semantic property formats for content items.
|
|
857
846
|
*/
|
|
858
|
-
export
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
847
|
+
export type PropertyFormat = {
|
|
848
|
+
/**
|
|
849
|
+
* The key that identifies this PropertyFormat.
|
|
850
|
+
*/
|
|
851
|
+
key?: string;
|
|
852
|
+
/**
|
|
853
|
+
* The underlying data type used for this PropertyFormat.
|
|
854
|
+
*/
|
|
855
|
+
dataType?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
856
|
+
/**
|
|
857
|
+
* The underlying item type used for this PropertyFormat.
|
|
858
|
+
*/
|
|
859
|
+
itemType?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
860
|
+
/**
|
|
861
|
+
* The name and identifier of this PropertyFormat.
|
|
862
|
+
*/
|
|
863
|
+
displayName?: string;
|
|
864
|
+
/**
|
|
865
|
+
* Indicates if this property format has been deleted.
|
|
866
|
+
*/
|
|
867
|
+
readonly deleted?: boolean;
|
|
868
|
+
/**
|
|
869
|
+
* A timestamp indicating when this display template was first created.
|
|
870
|
+
*/
|
|
871
|
+
readonly created?: Date;
|
|
872
|
+
/**
|
|
873
|
+
* The username of the user that created this display template.
|
|
874
|
+
*/
|
|
875
|
+
readonly createdBy?: string;
|
|
876
|
+
/**
|
|
877
|
+
* A timestamp indicating when this display template was last modified.
|
|
878
|
+
*/
|
|
879
|
+
readonly lastModified?: Date;
|
|
880
|
+
/**
|
|
881
|
+
* The username of the user that last modified this display template.
|
|
882
|
+
*/
|
|
883
|
+
readonly lastModifiedBy?: string;
|
|
862
884
|
};
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
885
|
+
export type PropertyFormatPage = {
|
|
886
|
+
/**
|
|
887
|
+
* The items in this paged collection.
|
|
888
|
+
*/
|
|
889
|
+
readonly items?: Array<PropertyFormat>;
|
|
890
|
+
/**
|
|
891
|
+
* The zero-based index of the current page.
|
|
892
|
+
*/
|
|
893
|
+
readonly pageIndex?: number;
|
|
894
|
+
/**
|
|
895
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
896
|
+
*/
|
|
897
|
+
readonly pageSize?: number;
|
|
867
898
|
/**
|
|
868
|
-
*
|
|
899
|
+
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
869
900
|
*/
|
|
870
|
-
|
|
901
|
+
readonly totalItemCount?: number;
|
|
871
902
|
};
|
|
872
903
|
/**
|
|
873
|
-
* Describes
|
|
904
|
+
* Describes a property group of a ContentType in the CMS.
|
|
874
905
|
*/
|
|
875
|
-
export type
|
|
906
|
+
export type PropertyGroup = {
|
|
907
|
+
/**
|
|
908
|
+
* The key that identifies this PropertyGroup.
|
|
909
|
+
*/
|
|
910
|
+
key?: string;
|
|
876
911
|
/**
|
|
877
|
-
* The display name of
|
|
912
|
+
* The display name of this PropertyGroup.
|
|
878
913
|
*/
|
|
879
914
|
displayName?: string;
|
|
880
915
|
/**
|
|
881
|
-
*
|
|
916
|
+
* A string that is used to indicate the source of this PropertyGroup.
|
|
882
917
|
*/
|
|
883
|
-
|
|
918
|
+
readonly source?: string;
|
|
919
|
+
/**
|
|
920
|
+
* An value that is used to when sorting PropertyGroup instances.
|
|
921
|
+
*/
|
|
922
|
+
sortOrder?: number;
|
|
923
|
+
/**
|
|
924
|
+
* A timestamp indicating when this property group was first created.
|
|
925
|
+
*/
|
|
926
|
+
readonly created?: Date;
|
|
927
|
+
/**
|
|
928
|
+
* The username of the user that created this property group.
|
|
929
|
+
*/
|
|
930
|
+
readonly createdBy?: string;
|
|
931
|
+
readonly lastModified?: Date;
|
|
932
|
+
/**
|
|
933
|
+
* The username of the user that last modified this property group.
|
|
934
|
+
*/
|
|
935
|
+
readonly lastModifiedBy?: string;
|
|
884
936
|
};
|
|
885
|
-
|
|
886
|
-
* Describes a property list item that can contain integers.
|
|
887
|
-
*/
|
|
888
|
-
export type IntegerListItem = ListPropertyItem & {
|
|
889
|
-
type: 'IntegerListItem';
|
|
890
|
-
} & {
|
|
937
|
+
export type PropertyGroupPage = {
|
|
891
938
|
/**
|
|
892
|
-
* The
|
|
939
|
+
* The items in this paged collection.
|
|
893
940
|
*/
|
|
894
|
-
|
|
941
|
+
readonly items?: Array<PropertyGroup>;
|
|
942
|
+
/**
|
|
943
|
+
* The zero-based index of the current page.
|
|
944
|
+
*/
|
|
945
|
+
readonly pageIndex?: number;
|
|
895
946
|
/**
|
|
896
|
-
* The
|
|
947
|
+
* The number of items in each page. Not necessarily the same as the number of items in this page.
|
|
948
|
+
*/
|
|
949
|
+
readonly pageSize?: number;
|
|
950
|
+
/**
|
|
951
|
+
* The estimated total number of items in the collection. May be omitted if the total item count is unknown.
|
|
897
952
|
*/
|
|
898
|
-
|
|
899
|
-
enum?: Int32EnumerationSettings;
|
|
953
|
+
readonly totalItemCount?: number;
|
|
900
954
|
};
|
|
901
955
|
/**
|
|
902
|
-
*
|
|
956
|
+
* Represents a blueprint of a content item.
|
|
903
957
|
*/
|
|
904
|
-
export type
|
|
905
|
-
type: 'IntegerProperty';
|
|
906
|
-
} & {
|
|
907
|
-
/**
|
|
908
|
-
* The minimum value that properties of this type should be able to contain.
|
|
909
|
-
*/
|
|
910
|
-
minimum?: number | null;
|
|
958
|
+
export type BlueprintWritable = {
|
|
911
959
|
/**
|
|
912
|
-
* The
|
|
960
|
+
* The display name of this blueprint.
|
|
913
961
|
*/
|
|
914
|
-
|
|
915
|
-
|
|
962
|
+
displayName: string;
|
|
963
|
+
lastModified?: Date;
|
|
964
|
+
content?: BlueprintDataWritable;
|
|
916
965
|
};
|
|
917
966
|
/**
|
|
918
|
-
*
|
|
967
|
+
* Represents the data part of a Blueprint.
|
|
919
968
|
*/
|
|
920
|
-
export type
|
|
921
|
-
|
|
922
|
-
|
|
969
|
+
export type BlueprintDataWritable = {
|
|
970
|
+
/**
|
|
971
|
+
* Properties as they are defined by corresponding component or content type.
|
|
972
|
+
*/
|
|
973
|
+
properties?: {
|
|
974
|
+
[key: string]: unknown;
|
|
975
|
+
};
|
|
976
|
+
composition?: CompositionNodeWritable;
|
|
977
|
+
};
|
|
978
|
+
export type BlueprintPageWritable = {
|
|
923
979
|
[key: string]: never;
|
|
924
980
|
};
|
|
925
981
|
/**
|
|
926
|
-
*
|
|
982
|
+
* Changesets are used to group work on several content items together.
|
|
927
983
|
*/
|
|
928
|
-
export type
|
|
929
|
-
type: 'ListProperty';
|
|
930
|
-
} & {
|
|
984
|
+
export type ChangesetWritable = {
|
|
931
985
|
/**
|
|
932
|
-
*
|
|
986
|
+
* The unique key of this Changeset.
|
|
933
987
|
*/
|
|
934
|
-
|
|
988
|
+
key?: string;
|
|
935
989
|
/**
|
|
936
|
-
*
|
|
990
|
+
* The name of this Changeset.
|
|
937
991
|
*/
|
|
938
|
-
|
|
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);
|
|
992
|
+
displayName: string;
|
|
993
|
+
lastModified?: Date;
|
|
959
994
|
};
|
|
960
995
|
/**
|
|
961
|
-
*
|
|
996
|
+
* Items in an changeset that contains a link to the specific content version.
|
|
962
997
|
*/
|
|
963
|
-
export type
|
|
964
|
-
type: PropertyDataType;
|
|
998
|
+
export type ChangesetItemWritable = {
|
|
965
999
|
/**
|
|
966
|
-
*
|
|
1000
|
+
* Gets/sets the changeset item category.
|
|
967
1001
|
*/
|
|
968
|
-
|
|
1002
|
+
category?: string;
|
|
1003
|
+
};
|
|
1004
|
+
export type ChangesetItemPageWritable = {
|
|
1005
|
+
[key: string]: never;
|
|
1006
|
+
};
|
|
1007
|
+
export type ChangesetPageWritable = {
|
|
1008
|
+
[key: string]: never;
|
|
969
1009
|
};
|
|
970
1010
|
/**
|
|
971
|
-
*
|
|
972
|
-
*/
|
|
973
|
-
export type LocaleStatus = 'draft' | 'published';
|
|
974
|
-
/**
|
|
975
|
-
* Represent the different status values of a content locale.
|
|
1011
|
+
* Defines display settings for a CompositionNode."/>
|
|
976
1012
|
*/
|
|
977
|
-
export
|
|
978
|
-
|
|
979
|
-
|
|
1013
|
+
export type CompositionDisplaySettingsWritable = {
|
|
1014
|
+
/**
|
|
1015
|
+
* Gets/sets the display settings for this CompositionNode.
|
|
1016
|
+
*/
|
|
1017
|
+
settings?: {
|
|
1018
|
+
[key: string]: string;
|
|
1019
|
+
} | null;
|
|
980
1020
|
};
|
|
981
1021
|
/**
|
|
982
|
-
*
|
|
983
|
-
* its expiry in seconds.
|
|
1022
|
+
* Specifies a node in a content composition.
|
|
984
1023
|
*/
|
|
985
|
-
export type
|
|
1024
|
+
export type CompositionNodeWritable = {
|
|
1025
|
+
/**
|
|
1026
|
+
* Specifies the id of this CompositionNode.
|
|
1027
|
+
*/
|
|
1028
|
+
id?: string | null;
|
|
986
1029
|
/**
|
|
987
|
-
*
|
|
1030
|
+
* The display name of this ContentType.
|
|
988
1031
|
*/
|
|
989
|
-
|
|
1032
|
+
displayName?: string | null;
|
|
1033
|
+
displaySettings?: CompositionDisplaySettingsWritable;
|
|
990
1034
|
/**
|
|
991
|
-
*
|
|
1035
|
+
* Represents a content component.
|
|
992
1036
|
*/
|
|
993
|
-
|
|
1037
|
+
component?: {
|
|
1038
|
+
/**
|
|
1039
|
+
* Dictionary with all custom properties as specified by associated ContentType
|
|
1040
|
+
*/
|
|
1041
|
+
properties?: unknown;
|
|
1042
|
+
reference?: string;
|
|
1043
|
+
/**
|
|
1044
|
+
* The key of the content type that this is an embedded instance of.
|
|
1045
|
+
*/
|
|
1046
|
+
contentType?: string | null;
|
|
1047
|
+
};
|
|
994
1048
|
/**
|
|
995
|
-
* Gets
|
|
1049
|
+
* Gets the available child nodes for this CompositionNode.
|
|
996
1050
|
*/
|
|
997
|
-
|
|
1051
|
+
nodes?: Array<CompositionNodeWritable> | null;
|
|
998
1052
|
};
|
|
999
1053
|
/**
|
|
1000
|
-
* Represents
|
|
1054
|
+
* Represents a version of a content item.
|
|
1001
1055
|
*/
|
|
1002
|
-
export type
|
|
1056
|
+
export type ContentItemWritable = {
|
|
1003
1057
|
/**
|
|
1004
|
-
*
|
|
1058
|
+
* Properties as they are defined by corresponding component or content type.
|
|
1005
1059
|
*/
|
|
1006
|
-
|
|
1060
|
+
properties?: {
|
|
1061
|
+
[key: string]: unknown;
|
|
1062
|
+
};
|
|
1063
|
+
/**
|
|
1064
|
+
* The locale of this content instance.
|
|
1065
|
+
*/
|
|
1066
|
+
locale?: string;
|
|
1007
1067
|
/**
|
|
1008
|
-
*
|
|
1068
|
+
* The variation of this content item, if any. Variations are used to represent different states or forms of the same content item.
|
|
1069
|
+
* A variation has it's own publish lifecycle. A variation can though not be published before the default version of same local is published.
|
|
1009
1070
|
*/
|
|
1010
|
-
|
|
1071
|
+
variation?: string | null;
|
|
1072
|
+
/**
|
|
1073
|
+
* The content type of this content item.
|
|
1074
|
+
*/
|
|
1075
|
+
contentType?: string;
|
|
1076
|
+
/**
|
|
1077
|
+
* The display name of this content item.
|
|
1078
|
+
*/
|
|
1079
|
+
displayName: string;
|
|
1080
|
+
/**
|
|
1081
|
+
* Indicates a time when this content was published or should be published.
|
|
1082
|
+
*/
|
|
1083
|
+
published?: Date | null;
|
|
1084
|
+
/**
|
|
1085
|
+
* Indicates a time when this content expired or should expire.
|
|
1086
|
+
*/
|
|
1087
|
+
expired?: Date | null;
|
|
1088
|
+
/**
|
|
1089
|
+
* The status of this version of the content item.
|
|
1090
|
+
*/
|
|
1091
|
+
status?: 'draft' | 'ready' | 'published' | 'previous' | 'scheduled' | 'rejected' | 'inReview';
|
|
1092
|
+
/**
|
|
1093
|
+
* Indicates a time when this content version should transition to published status. Must only be assigned when Status is set to Scheduled.
|
|
1094
|
+
*/
|
|
1095
|
+
delayPublishUntil?: Date | null;
|
|
1096
|
+
/**
|
|
1097
|
+
* The key that identifies the container content that this content item belongs to.
|
|
1098
|
+
*/
|
|
1099
|
+
container?: string | null;
|
|
1100
|
+
/**
|
|
1101
|
+
* The key that identifies the owner of this content. Content that is own by another content is also known as an asset.
|
|
1102
|
+
*/
|
|
1103
|
+
owner?: string | null;
|
|
1104
|
+
/**
|
|
1105
|
+
* A string that represents the segment that should be used when routing or generate routes to the current content instance.
|
|
1106
|
+
*/
|
|
1107
|
+
routeSegment?: string | null;
|
|
1108
|
+
lastModified?: Date;
|
|
1109
|
+
composition?: CompositionNodeWritable;
|
|
1110
|
+
};
|
|
1111
|
+
export type ContentItemPageWritable = {
|
|
1112
|
+
[key: string]: never;
|
|
1011
1113
|
};
|
|
1012
1114
|
/**
|
|
1013
|
-
* Represents
|
|
1115
|
+
* Represents metadata about a content item.
|
|
1014
1116
|
*/
|
|
1015
|
-
export type
|
|
1117
|
+
export type ContentMetadataWritable = {
|
|
1016
1118
|
/**
|
|
1017
|
-
*
|
|
1119
|
+
* The key that identifies this content.
|
|
1018
1120
|
*/
|
|
1019
|
-
|
|
1121
|
+
key?: string;
|
|
1020
1122
|
/**
|
|
1021
|
-
*
|
|
1123
|
+
* The content type of this content.
|
|
1022
1124
|
*/
|
|
1023
|
-
|
|
1125
|
+
contentType?: string;
|
|
1024
1126
|
/**
|
|
1025
|
-
*
|
|
1127
|
+
* The key that identifies the container content that this content belongs to.
|
|
1026
1128
|
*/
|
|
1027
|
-
|
|
1129
|
+
container?: string | null;
|
|
1028
1130
|
/**
|
|
1029
|
-
*
|
|
1131
|
+
* The key that identifies the owner of this content. Content that is own by another content is also known as an asset.
|
|
1030
1132
|
*/
|
|
1031
|
-
|
|
1133
|
+
owner?: string | null;
|
|
1032
1134
|
};
|
|
1033
|
-
export type
|
|
1034
|
-
|
|
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;
|
|
1135
|
+
export type ContentMetadataPageWritable = {
|
|
1136
|
+
[key: string]: never;
|
|
1046
1137
|
};
|
|
1047
1138
|
/**
|
|
1048
|
-
*
|
|
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.
|
|
1139
|
+
* A writable implementation of an ContentType.
|
|
1055
1140
|
*/
|
|
1056
|
-
export
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1141
|
+
export type ContentTypeWritable = {
|
|
1142
|
+
/**
|
|
1143
|
+
* The key that identifies this ContentType.
|
|
1144
|
+
*/
|
|
1145
|
+
key?: string;
|
|
1146
|
+
/**
|
|
1147
|
+
* The display name of this ContentType.
|
|
1148
|
+
*/
|
|
1149
|
+
displayName?: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* A description of this ContentType.
|
|
1152
|
+
*/
|
|
1153
|
+
description?: string;
|
|
1154
|
+
/**
|
|
1155
|
+
* The base type of this ContentType.
|
|
1156
|
+
* Ignored for contracts; required for all other content types.
|
|
1157
|
+
*/
|
|
1158
|
+
baseType?: string | null;
|
|
1159
|
+
/**
|
|
1160
|
+
* A value that is used to when sorting ContentType instances.
|
|
1161
|
+
*/
|
|
1162
|
+
sortOrder?: number;
|
|
1163
|
+
/**
|
|
1164
|
+
* Provides a set of content types that can be created in containers of this type
|
|
1165
|
+
*/
|
|
1166
|
+
mayContainTypes?: Array<string>;
|
|
1167
|
+
/**
|
|
1168
|
+
* Provides a set of media file extensions that this content type can handle.
|
|
1169
|
+
*/
|
|
1170
|
+
mediaFileExtensions?: Array<string>;
|
|
1171
|
+
/**
|
|
1172
|
+
* Provides a set of composition behaviors specifying how this content type can be used within compositions.
|
|
1173
|
+
*/
|
|
1174
|
+
compositionBehaviors?: Array<'sectionEnabled' | 'elementEnabled' | 'formsElementEnabled'>;
|
|
1175
|
+
/**
|
|
1176
|
+
* Dictionary with all custom properties of this ContentType.
|
|
1177
|
+
*/
|
|
1178
|
+
properties?: {
|
|
1179
|
+
[key: string]: ContentTypeProperty;
|
|
1180
|
+
};
|
|
1181
|
+
};
|
|
1182
|
+
export type ContentTypePageWritable = {
|
|
1183
|
+
[key: string]: never;
|
|
1069
1184
|
};
|
|
1070
1185
|
/**
|
|
1071
|
-
*
|
|
1186
|
+
* Describes a display template that can be assigned to content.
|
|
1072
1187
|
*/
|
|
1073
|
-
export type
|
|
1188
|
+
export type DisplayTemplateWritable = {
|
|
1074
1189
|
/**
|
|
1075
|
-
* The key that identifies this
|
|
1190
|
+
* The key that identifies this display template.
|
|
1076
1191
|
*/
|
|
1077
1192
|
key?: string;
|
|
1078
|
-
dataType?: PropertyDataType;
|
|
1079
|
-
itemType?: PropertyDataType;
|
|
1080
1193
|
/**
|
|
1081
|
-
* The name
|
|
1194
|
+
* The display name of this display template.
|
|
1082
1195
|
*/
|
|
1083
|
-
displayName
|
|
1196
|
+
displayName: string;
|
|
1084
1197
|
/**
|
|
1085
|
-
*
|
|
1198
|
+
* The optional node type this display template is valid for.
|
|
1086
1199
|
*/
|
|
1087
|
-
|
|
1200
|
+
nodeType?: string | null;
|
|
1088
1201
|
/**
|
|
1089
|
-
*
|
|
1202
|
+
* The optional base type this display template is valid for.
|
|
1090
1203
|
*/
|
|
1091
|
-
|
|
1204
|
+
baseType?: string | null;
|
|
1092
1205
|
/**
|
|
1093
|
-
*
|
|
1206
|
+
* The optional key of the content type this display template is valid for.
|
|
1094
1207
|
*/
|
|
1095
|
-
|
|
1096
|
-
[key: string]: {
|
|
1097
|
-
[key: string]: unknown;
|
|
1098
|
-
};
|
|
1099
|
-
} | null;
|
|
1208
|
+
contentType?: string | null;
|
|
1100
1209
|
/**
|
|
1101
|
-
*
|
|
1210
|
+
* If this is the default display template for the associated base type, node type or content type.
|
|
1102
1211
|
*/
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1212
|
+
isDefault?: boolean;
|
|
1213
|
+
/**
|
|
1214
|
+
* The available settings for this display template.
|
|
1215
|
+
*/
|
|
1216
|
+
settings?: {
|
|
1217
|
+
[key: string]: DisplaySetting;
|
|
1218
|
+
};
|
|
1219
|
+
};
|
|
1220
|
+
export type DisplayTemplatePageWritable = {
|
|
1221
|
+
[key: string]: never;
|
|
1109
1222
|
};
|
|
1110
|
-
|
|
1223
|
+
/**
|
|
1224
|
+
* Represent the definition of semantic property formats for content items.
|
|
1225
|
+
*/
|
|
1226
|
+
export type PropertyFormatWritable = {
|
|
1111
1227
|
/**
|
|
1112
|
-
* The
|
|
1228
|
+
* The key that identifies this PropertyFormat.
|
|
1113
1229
|
*/
|
|
1114
|
-
|
|
1230
|
+
key?: string;
|
|
1115
1231
|
/**
|
|
1116
|
-
* The
|
|
1232
|
+
* The underlying data type used for this PropertyFormat.
|
|
1117
1233
|
*/
|
|
1118
|
-
|
|
1234
|
+
dataType?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
1119
1235
|
/**
|
|
1120
|
-
* The
|
|
1236
|
+
* The underlying item type used for this PropertyFormat.
|
|
1121
1237
|
*/
|
|
1122
|
-
|
|
1238
|
+
itemType?: 'string' | 'url' | 'boolean' | 'integer' | 'float' | 'dateTime' | 'contentReference' | 'content' | 'binary' | 'link' | 'richText' | 'json' | 'array' | 'component';
|
|
1123
1239
|
/**
|
|
1124
|
-
* The
|
|
1240
|
+
* The name and identifier of this PropertyFormat.
|
|
1125
1241
|
*/
|
|
1126
|
-
|
|
1242
|
+
displayName?: string;
|
|
1243
|
+
};
|
|
1244
|
+
export type PropertyFormatPageWritable = {
|
|
1245
|
+
[key: string]: never;
|
|
1127
1246
|
};
|
|
1128
1247
|
/**
|
|
1129
1248
|
* Describes a property group of a ContentType in the CMS.
|
|
1130
1249
|
*/
|
|
1131
|
-
export type
|
|
1250
|
+
export type PropertyGroupWritable = {
|
|
1132
1251
|
/**
|
|
1133
1252
|
* The key that identifies this PropertyGroup.
|
|
1134
1253
|
*/
|
|
1135
|
-
|
|
1254
|
+
key?: string;
|
|
1136
1255
|
/**
|
|
1137
1256
|
* The display name of this PropertyGroup.
|
|
1138
1257
|
*/
|
|
1139
1258
|
displayName?: string;
|
|
1140
|
-
/**
|
|
1141
|
-
* A string that is used to indicate the source of this PropertyGroup.
|
|
1142
|
-
*/
|
|
1143
|
-
readonly source?: string;
|
|
1144
1259
|
/**
|
|
1145
1260
|
* An value that is used to when sorting PropertyGroup instances.
|
|
1146
1261
|
*/
|
|
1147
1262
|
sortOrder?: number;
|
|
1148
1263
|
};
|
|
1149
|
-
export type
|
|
1264
|
+
export type PropertyGroupPageWritable = {
|
|
1265
|
+
[key: string]: never;
|
|
1266
|
+
};
|
|
1267
|
+
export type BlueprintsListData = {
|
|
1268
|
+
body?: never;
|
|
1269
|
+
path?: never;
|
|
1270
|
+
query?: {
|
|
1271
|
+
pageIndex?: number;
|
|
1272
|
+
pageSize?: number;
|
|
1273
|
+
};
|
|
1274
|
+
url: '/experimental/blueprints';
|
|
1275
|
+
};
|
|
1276
|
+
export type BlueprintsListErrors = {
|
|
1150
1277
|
/**
|
|
1151
|
-
*
|
|
1278
|
+
* Forbidden
|
|
1152
1279
|
*/
|
|
1153
|
-
|
|
1280
|
+
403: ProblemDetails;
|
|
1281
|
+
};
|
|
1282
|
+
export type BlueprintsListError = BlueprintsListErrors[keyof BlueprintsListErrors];
|
|
1283
|
+
export type BlueprintsListResponses = {
|
|
1154
1284
|
/**
|
|
1155
|
-
*
|
|
1285
|
+
* OK
|
|
1156
1286
|
*/
|
|
1157
|
-
|
|
1287
|
+
200: BlueprintPage;
|
|
1288
|
+
};
|
|
1289
|
+
export type BlueprintsListResponse = BlueprintsListResponses[keyof BlueprintsListResponses];
|
|
1290
|
+
export type BlueprintsCreateData = {
|
|
1158
1291
|
/**
|
|
1159
|
-
* The
|
|
1292
|
+
* The blueprint that should be created.
|
|
1160
1293
|
*/
|
|
1161
|
-
|
|
1294
|
+
body: BlueprintWritable;
|
|
1295
|
+
path?: never;
|
|
1296
|
+
query?: never;
|
|
1297
|
+
url: '/experimental/blueprints';
|
|
1298
|
+
};
|
|
1299
|
+
export type BlueprintsCreateErrors = {
|
|
1162
1300
|
/**
|
|
1163
|
-
*
|
|
1301
|
+
* Bad Request
|
|
1164
1302
|
*/
|
|
1165
|
-
|
|
1303
|
+
400: ProblemDetails;
|
|
1304
|
+
/**
|
|
1305
|
+
* Forbidden
|
|
1306
|
+
*/
|
|
1307
|
+
403: ProblemDetails;
|
|
1166
1308
|
};
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
*/
|
|
1170
|
-
export type StringEnumerationSettings = {
|
|
1309
|
+
export type BlueprintsCreateError = BlueprintsCreateErrors[keyof BlueprintsCreateErrors];
|
|
1310
|
+
export type BlueprintsCreateResponses = {
|
|
1171
1311
|
/**
|
|
1172
|
-
*
|
|
1312
|
+
* Created
|
|
1173
1313
|
*/
|
|
1174
|
-
|
|
1314
|
+
201: Blueprint;
|
|
1175
1315
|
};
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1316
|
+
export type BlueprintsCreateResponse = BlueprintsCreateResponses[keyof BlueprintsCreateResponses];
|
|
1317
|
+
export type BlueprintsDeleteData = {
|
|
1318
|
+
body?: never;
|
|
1319
|
+
headers?: {
|
|
1320
|
+
/**
|
|
1321
|
+
* 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.
|
|
1322
|
+
*/
|
|
1323
|
+
'If-Match'?: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* 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.
|
|
1326
|
+
*/
|
|
1327
|
+
'If-Unmodified-Since'?: string;
|
|
1328
|
+
};
|
|
1329
|
+
path: {
|
|
1330
|
+
/**
|
|
1331
|
+
* The key of the blueprint to delete.
|
|
1332
|
+
*/
|
|
1333
|
+
key: string;
|
|
1334
|
+
};
|
|
1335
|
+
query?: never;
|
|
1336
|
+
url: '/experimental/blueprints/{key}';
|
|
1337
|
+
};
|
|
1338
|
+
export type BlueprintsDeleteErrors = {
|
|
1180
1339
|
/**
|
|
1181
|
-
*
|
|
1340
|
+
* Bad Request
|
|
1182
1341
|
*/
|
|
1183
|
-
|
|
1342
|
+
400: ProblemDetails;
|
|
1184
1343
|
/**
|
|
1185
|
-
*
|
|
1344
|
+
* Forbidden
|
|
1186
1345
|
*/
|
|
1187
|
-
|
|
1188
|
-
};
|
|
1189
|
-
/**
|
|
1190
|
-
* Describes a property list item that can contain a string.
|
|
1191
|
-
*/
|
|
1192
|
-
export type StringListItem = ListPropertyItem & {
|
|
1193
|
-
type: 'StringListItem';
|
|
1194
|
-
} & {
|
|
1346
|
+
403: ProblemDetails;
|
|
1195
1347
|
/**
|
|
1196
|
-
*
|
|
1348
|
+
* Not Found
|
|
1197
1349
|
*/
|
|
1198
|
-
|
|
1350
|
+
404: ProblemDetails;
|
|
1199
1351
|
/**
|
|
1200
|
-
*
|
|
1352
|
+
* Precondition Failed
|
|
1201
1353
|
*/
|
|
1202
|
-
|
|
1354
|
+
412: ProblemDetails;
|
|
1355
|
+
};
|
|
1356
|
+
export type BlueprintsDeleteError = BlueprintsDeleteErrors[keyof BlueprintsDeleteErrors];
|
|
1357
|
+
export type BlueprintsDeleteResponses = {
|
|
1203
1358
|
/**
|
|
1204
|
-
*
|
|
1359
|
+
* OK
|
|
1205
1360
|
*/
|
|
1206
|
-
|
|
1207
|
-
enum?: StringEnumerationSettings;
|
|
1361
|
+
200: Blueprint;
|
|
1208
1362
|
};
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1363
|
+
export type BlueprintsDeleteResponse = BlueprintsDeleteResponses[keyof BlueprintsDeleteResponses];
|
|
1364
|
+
export type BlueprintsGetData = {
|
|
1365
|
+
body?: never;
|
|
1366
|
+
headers?: {
|
|
1367
|
+
/**
|
|
1368
|
+
* 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.
|
|
1369
|
+
*/
|
|
1370
|
+
'If-None-Match'?: string;
|
|
1371
|
+
/**
|
|
1372
|
+
* 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.
|
|
1373
|
+
*/
|
|
1374
|
+
'If-Modified-Since'?: string;
|
|
1375
|
+
};
|
|
1376
|
+
path: {
|
|
1377
|
+
/**
|
|
1378
|
+
* The key of the blueprint to retrieve.
|
|
1379
|
+
*/
|
|
1380
|
+
key: string;
|
|
1381
|
+
};
|
|
1382
|
+
query?: never;
|
|
1383
|
+
url: '/experimental/blueprints/{key}';
|
|
1384
|
+
};
|
|
1385
|
+
export type BlueprintsGetErrors = {
|
|
1215
1386
|
/**
|
|
1216
|
-
*
|
|
1387
|
+
* Forbidden
|
|
1217
1388
|
*/
|
|
1218
|
-
|
|
1389
|
+
403: ProblemDetails;
|
|
1219
1390
|
/**
|
|
1220
|
-
*
|
|
1391
|
+
* Not Found
|
|
1221
1392
|
*/
|
|
1222
|
-
|
|
1393
|
+
404: ProblemDetails;
|
|
1394
|
+
};
|
|
1395
|
+
export type BlueprintsGetError = BlueprintsGetErrors[keyof BlueprintsGetErrors];
|
|
1396
|
+
export type BlueprintsGetResponses = {
|
|
1223
1397
|
/**
|
|
1224
|
-
*
|
|
1398
|
+
* OK
|
|
1225
1399
|
*/
|
|
1226
|
-
|
|
1227
|
-
enum?: StringEnumerationSettings;
|
|
1400
|
+
200: Blueprint;
|
|
1228
1401
|
};
|
|
1229
|
-
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
|
|
1402
|
+
export type BlueprintsGetResponse = BlueprintsGetResponses[keyof BlueprintsGetResponses];
|
|
1403
|
+
export type BlueprintsPatchData = {
|
|
1404
|
+
/**
|
|
1405
|
+
* The values of the blueprint that should be patched formatted according to RFC7396.
|
|
1406
|
+
*/
|
|
1407
|
+
body: BlueprintWritable;
|
|
1408
|
+
headers?: {
|
|
1409
|
+
/**
|
|
1410
|
+
* 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.
|
|
1411
|
+
*/
|
|
1412
|
+
'If-Match'?: string;
|
|
1413
|
+
/**
|
|
1414
|
+
* 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.
|
|
1415
|
+
*/
|
|
1416
|
+
'If-Unmodified-Since'?: string;
|
|
1417
|
+
};
|
|
1418
|
+
path: {
|
|
1419
|
+
/**
|
|
1420
|
+
* The key of the blueprint to patch.
|
|
1421
|
+
*/
|
|
1422
|
+
key: string;
|
|
1423
|
+
};
|
|
1424
|
+
query?: never;
|
|
1425
|
+
url: '/experimental/blueprints/{key}';
|
|
1236
1426
|
};
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1427
|
+
export type BlueprintsPatchErrors = {
|
|
1428
|
+
/**
|
|
1429
|
+
* Bad Request
|
|
1430
|
+
*/
|
|
1431
|
+
400: ProblemDetails;
|
|
1432
|
+
/**
|
|
1433
|
+
* Forbidden
|
|
1434
|
+
*/
|
|
1435
|
+
403: ProblemDetails;
|
|
1436
|
+
/**
|
|
1437
|
+
* Not Found
|
|
1438
|
+
*/
|
|
1439
|
+
404: ProblemDetails;
|
|
1440
|
+
/**
|
|
1441
|
+
* Precondition Failed
|
|
1442
|
+
*/
|
|
1443
|
+
412: ProblemDetails;
|
|
1244
1444
|
};
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
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";
|
|
1445
|
+
export type BlueprintsPatchError = BlueprintsPatchErrors[keyof BlueprintsPatchErrors];
|
|
1446
|
+
export type BlueprintsPatchResponses = {
|
|
1447
|
+
/**
|
|
1448
|
+
* OK
|
|
1449
|
+
*/
|
|
1450
|
+
200: Blueprint;
|
|
1260
1451
|
};
|
|
1452
|
+
export type BlueprintsPatchResponse = BlueprintsPatchResponses[keyof BlueprintsPatchResponses];
|
|
1261
1453
|
export type ChangesetsListData = {
|
|
1262
1454
|
body?: never;
|
|
1263
1455
|
path?: never;
|
|
1264
1456
|
query?: {
|
|
1457
|
+
/**
|
|
1458
|
+
* Indicates which sources should be included when listing changesets.
|
|
1459
|
+
* Use Default to include changesets without a specific sources.
|
|
1460
|
+
*/
|
|
1461
|
+
sources?: Array<string>;
|
|
1265
1462
|
pageIndex?: number;
|
|
1266
1463
|
pageSize?: number;
|
|
1267
1464
|
};
|
|
1268
|
-
url: '/changesets';
|
|
1465
|
+
url: '/experimental/changesets';
|
|
1269
1466
|
};
|
|
1270
1467
|
export type ChangesetsListErrors = {
|
|
1271
1468
|
/**
|
|
@@ -1285,10 +1482,10 @@ export type ChangesetsCreateData = {
|
|
|
1285
1482
|
/**
|
|
1286
1483
|
* The changeset that should be created.
|
|
1287
1484
|
*/
|
|
1288
|
-
body:
|
|
1485
|
+
body: ChangesetWritable;
|
|
1289
1486
|
path?: never;
|
|
1290
1487
|
query?: never;
|
|
1291
|
-
url: '/changesets';
|
|
1488
|
+
url: '/experimental/changesets';
|
|
1292
1489
|
};
|
|
1293
1490
|
export type ChangesetsCreateErrors = {
|
|
1294
1491
|
/**
|
|
@@ -1303,9 +1500,9 @@ export type ChangesetsCreateErrors = {
|
|
|
1303
1500
|
export type ChangesetsCreateError = ChangesetsCreateErrors[keyof ChangesetsCreateErrors];
|
|
1304
1501
|
export type ChangesetsCreateResponses = {
|
|
1305
1502
|
/**
|
|
1306
|
-
*
|
|
1503
|
+
* Created
|
|
1307
1504
|
*/
|
|
1308
|
-
|
|
1505
|
+
201: Changeset;
|
|
1309
1506
|
};
|
|
1310
1507
|
export type ChangesetsCreateResponse = ChangesetsCreateResponses[keyof ChangesetsCreateResponses];
|
|
1311
1508
|
export type ChangesetsDeleteData = {
|
|
@@ -1317,7 +1514,7 @@ export type ChangesetsDeleteData = {
|
|
|
1317
1514
|
key: string;
|
|
1318
1515
|
};
|
|
1319
1516
|
query?: never;
|
|
1320
|
-
url: '/changesets/{key}';
|
|
1517
|
+
url: '/experimental/changesets/{key}';
|
|
1321
1518
|
};
|
|
1322
1519
|
export type ChangesetsDeleteErrors = {
|
|
1323
1520
|
/**
|
|
@@ -1328,6 +1525,10 @@ export type ChangesetsDeleteErrors = {
|
|
|
1328
1525
|
* Forbidden
|
|
1329
1526
|
*/
|
|
1330
1527
|
403: ProblemDetails;
|
|
1528
|
+
/**
|
|
1529
|
+
* Not Found
|
|
1530
|
+
*/
|
|
1531
|
+
404: ProblemDetails;
|
|
1331
1532
|
};
|
|
1332
1533
|
export type ChangesetsDeleteError = ChangesetsDeleteErrors[keyof ChangesetsDeleteErrors];
|
|
1333
1534
|
export type ChangesetsDeleteResponses = {
|
|
@@ -1339,6 +1540,16 @@ export type ChangesetsDeleteResponses = {
|
|
|
1339
1540
|
export type ChangesetsDeleteResponse = ChangesetsDeleteResponses[keyof ChangesetsDeleteResponses];
|
|
1340
1541
|
export type ChangesetsGetData = {
|
|
1341
1542
|
body?: never;
|
|
1543
|
+
headers?: {
|
|
1544
|
+
/**
|
|
1545
|
+
* 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.
|
|
1546
|
+
*/
|
|
1547
|
+
'If-None-Match'?: string;
|
|
1548
|
+
/**
|
|
1549
|
+
* 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.
|
|
1550
|
+
*/
|
|
1551
|
+
'If-Modified-Since'?: string;
|
|
1552
|
+
};
|
|
1342
1553
|
path: {
|
|
1343
1554
|
/**
|
|
1344
1555
|
* The key of the changeset to retrieve.
|
|
@@ -1346,13 +1557,17 @@ export type ChangesetsGetData = {
|
|
|
1346
1557
|
key: string;
|
|
1347
1558
|
};
|
|
1348
1559
|
query?: never;
|
|
1349
|
-
url: '/changesets/{key}';
|
|
1560
|
+
url: '/experimental/changesets/{key}';
|
|
1350
1561
|
};
|
|
1351
1562
|
export type ChangesetsGetErrors = {
|
|
1352
1563
|
/**
|
|
1353
1564
|
* Forbidden
|
|
1354
1565
|
*/
|
|
1355
1566
|
403: ProblemDetails;
|
|
1567
|
+
/**
|
|
1568
|
+
* Not Found
|
|
1569
|
+
*/
|
|
1570
|
+
404: ProblemDetails;
|
|
1356
1571
|
};
|
|
1357
1572
|
export type ChangesetsGetError = ChangesetsGetErrors[keyof ChangesetsGetErrors];
|
|
1358
1573
|
export type ChangesetsGetResponses = {
|
|
@@ -1362,21 +1577,21 @@ export type ChangesetsGetResponses = {
|
|
|
1362
1577
|
200: Changeset;
|
|
1363
1578
|
};
|
|
1364
1579
|
export type ChangesetsGetResponse = ChangesetsGetResponses[keyof ChangesetsGetResponses];
|
|
1365
|
-
export type
|
|
1580
|
+
export type ChangesetsPatchData = {
|
|
1366
1581
|
/**
|
|
1367
|
-
* The values of the
|
|
1582
|
+
* The values of the changeset that should be patched formatted according to RFC7396.
|
|
1368
1583
|
*/
|
|
1369
|
-
body:
|
|
1584
|
+
body: ChangesetWritable;
|
|
1370
1585
|
path: {
|
|
1371
1586
|
/**
|
|
1372
|
-
* The key of the changeset to
|
|
1587
|
+
* The key of the changeset to patch.
|
|
1373
1588
|
*/
|
|
1374
1589
|
key: string;
|
|
1375
1590
|
};
|
|
1376
1591
|
query?: never;
|
|
1377
|
-
url: '/changesets/{key}';
|
|
1592
|
+
url: '/experimental/changesets/{key}';
|
|
1378
1593
|
};
|
|
1379
|
-
export type
|
|
1594
|
+
export type ChangesetsPatchErrors = {
|
|
1380
1595
|
/**
|
|
1381
1596
|
* Bad Request
|
|
1382
1597
|
*/
|
|
@@ -1385,15 +1600,19 @@ export type ChangesetsPutErrors = {
|
|
|
1385
1600
|
* Forbidden
|
|
1386
1601
|
*/
|
|
1387
1602
|
403: ProblemDetails;
|
|
1603
|
+
/**
|
|
1604
|
+
* Not Found
|
|
1605
|
+
*/
|
|
1606
|
+
404: ProblemDetails;
|
|
1388
1607
|
};
|
|
1389
|
-
export type
|
|
1390
|
-
export type
|
|
1608
|
+
export type ChangesetsPatchError = ChangesetsPatchErrors[keyof ChangesetsPatchErrors];
|
|
1609
|
+
export type ChangesetsPatchResponses = {
|
|
1391
1610
|
/**
|
|
1392
1611
|
* OK
|
|
1393
1612
|
*/
|
|
1394
1613
|
200: Changeset;
|
|
1395
1614
|
};
|
|
1396
|
-
export type
|
|
1615
|
+
export type ChangesetsPatchResponse = ChangesetsPatchResponses[keyof ChangesetsPatchResponses];
|
|
1397
1616
|
export type ChangesetsDeleteItemData = {
|
|
1398
1617
|
body?: never;
|
|
1399
1618
|
path: {
|
|
@@ -1411,7 +1630,7 @@ export type ChangesetsDeleteItemData = {
|
|
|
1411
1630
|
version: string;
|
|
1412
1631
|
};
|
|
1413
1632
|
query?: never;
|
|
1414
|
-
url: '/changesets/{changeset}/items/{key}/versions/{version}';
|
|
1633
|
+
url: '/experimental/changesets/{changeset}/items/{key}/versions/{version}';
|
|
1415
1634
|
};
|
|
1416
1635
|
export type ChangesetsDeleteItemErrors = {
|
|
1417
1636
|
/**
|
|
@@ -1422,6 +1641,10 @@ export type ChangesetsDeleteItemErrors = {
|
|
|
1422
1641
|
* Forbidden
|
|
1423
1642
|
*/
|
|
1424
1643
|
403: ProblemDetails;
|
|
1644
|
+
/**
|
|
1645
|
+
* Not Found
|
|
1646
|
+
*/
|
|
1647
|
+
404: ProblemDetails;
|
|
1425
1648
|
};
|
|
1426
1649
|
export type ChangesetsDeleteItemError = ChangesetsDeleteItemErrors[keyof ChangesetsDeleteItemErrors];
|
|
1427
1650
|
export type ChangesetsDeleteItemResponses = {
|
|
@@ -1448,13 +1671,17 @@ export type ChangesetsGetItemData = {
|
|
|
1448
1671
|
version: string;
|
|
1449
1672
|
};
|
|
1450
1673
|
query?: never;
|
|
1451
|
-
url: '/changesets/{changeset}/items/{key}/versions/{version}';
|
|
1674
|
+
url: '/experimental/changesets/{changeset}/items/{key}/versions/{version}';
|
|
1452
1675
|
};
|
|
1453
1676
|
export type ChangesetsGetItemErrors = {
|
|
1454
1677
|
/**
|
|
1455
1678
|
* Forbidden
|
|
1456
1679
|
*/
|
|
1457
1680
|
403: ProblemDetails;
|
|
1681
|
+
/**
|
|
1682
|
+
* Not Found
|
|
1683
|
+
*/
|
|
1684
|
+
404: ProblemDetails;
|
|
1458
1685
|
};
|
|
1459
1686
|
export type ChangesetsGetItemError = ChangesetsGetItemErrors[keyof ChangesetsGetItemErrors];
|
|
1460
1687
|
export type ChangesetsGetItemResponses = {
|
|
@@ -1464,6 +1691,50 @@ export type ChangesetsGetItemResponses = {
|
|
|
1464
1691
|
200: ChangesetItem;
|
|
1465
1692
|
};
|
|
1466
1693
|
export type ChangesetsGetItemResponse = ChangesetsGetItemResponses[keyof ChangesetsGetItemResponses];
|
|
1694
|
+
export type ChangesetsPatchItemData = {
|
|
1695
|
+
/**
|
|
1696
|
+
* The values of the changeset item that should be patched formatted according to RFC7396.
|
|
1697
|
+
*/
|
|
1698
|
+
body: ChangesetItemWritable;
|
|
1699
|
+
path: {
|
|
1700
|
+
/**
|
|
1701
|
+
* The changeset key
|
|
1702
|
+
*/
|
|
1703
|
+
changeset: string;
|
|
1704
|
+
/**
|
|
1705
|
+
* The content key
|
|
1706
|
+
*/
|
|
1707
|
+
key: string;
|
|
1708
|
+
/**
|
|
1709
|
+
* The content version
|
|
1710
|
+
*/
|
|
1711
|
+
version: string;
|
|
1712
|
+
};
|
|
1713
|
+
query?: never;
|
|
1714
|
+
url: '/experimental/changesets/{changeset}/items/{key}/versions/{version}';
|
|
1715
|
+
};
|
|
1716
|
+
export type ChangesetsPatchItemErrors = {
|
|
1717
|
+
/**
|
|
1718
|
+
* Bad Request
|
|
1719
|
+
*/
|
|
1720
|
+
400: ProblemDetails;
|
|
1721
|
+
/**
|
|
1722
|
+
* Forbidden
|
|
1723
|
+
*/
|
|
1724
|
+
403: ProblemDetails;
|
|
1725
|
+
/**
|
|
1726
|
+
* Not Found
|
|
1727
|
+
*/
|
|
1728
|
+
404: ProblemDetails;
|
|
1729
|
+
};
|
|
1730
|
+
export type ChangesetsPatchItemError = ChangesetsPatchItemErrors[keyof ChangesetsPatchItemErrors];
|
|
1731
|
+
export type ChangesetsPatchItemResponses = {
|
|
1732
|
+
/**
|
|
1733
|
+
* OK
|
|
1734
|
+
*/
|
|
1735
|
+
200: ChangesetItem;
|
|
1736
|
+
};
|
|
1737
|
+
export type ChangesetsPatchItemResponse = ChangesetsPatchItemResponses[keyof ChangesetsPatchItemResponses];
|
|
1467
1738
|
export type ChangesetsListItemsData = {
|
|
1468
1739
|
body?: never;
|
|
1469
1740
|
path: {
|
|
@@ -1476,13 +1747,17 @@ export type ChangesetsListItemsData = {
|
|
|
1476
1747
|
pageIndex?: number;
|
|
1477
1748
|
pageSize?: number;
|
|
1478
1749
|
};
|
|
1479
|
-
url: '/changesets/{changeset}/items';
|
|
1750
|
+
url: '/experimental/changesets/{changeset}/items';
|
|
1480
1751
|
};
|
|
1481
1752
|
export type ChangesetsListItemsErrors = {
|
|
1482
1753
|
/**
|
|
1483
1754
|
* Forbidden
|
|
1484
1755
|
*/
|
|
1485
1756
|
403: ProblemDetails;
|
|
1757
|
+
/**
|
|
1758
|
+
* Not Found
|
|
1759
|
+
*/
|
|
1760
|
+
404: ProblemDetails;
|
|
1486
1761
|
};
|
|
1487
1762
|
export type ChangesetsListItemsError = ChangesetsListItemsErrors[keyof ChangesetsListItemsErrors];
|
|
1488
1763
|
export type ChangesetsListItemsResponses = {
|
|
@@ -1496,7 +1771,7 @@ export type ChangesetsCreateItemData = {
|
|
|
1496
1771
|
/**
|
|
1497
1772
|
* The changeset item
|
|
1498
1773
|
*/
|
|
1499
|
-
body:
|
|
1774
|
+
body: ChangesetItemWritable;
|
|
1500
1775
|
path: {
|
|
1501
1776
|
/**
|
|
1502
1777
|
* The changeset key
|
|
@@ -1504,7 +1779,7 @@ export type ChangesetsCreateItemData = {
|
|
|
1504
1779
|
changeset: string;
|
|
1505
1780
|
};
|
|
1506
1781
|
query?: never;
|
|
1507
|
-
url: '/changesets/{changeset}/items';
|
|
1782
|
+
url: '/experimental/changesets/{changeset}/items';
|
|
1508
1783
|
};
|
|
1509
1784
|
export type ChangesetsCreateItemErrors = {
|
|
1510
1785
|
/**
|
|
@@ -1515,73 +1790,33 @@ export type ChangesetsCreateItemErrors = {
|
|
|
1515
1790
|
* Forbidden
|
|
1516
1791
|
*/
|
|
1517
1792
|
403: ProblemDetails;
|
|
1793
|
+
/**
|
|
1794
|
+
* Not Found
|
|
1795
|
+
*/
|
|
1796
|
+
404: ProblemDetails;
|
|
1518
1797
|
};
|
|
1519
1798
|
export type ChangesetsCreateItemError = ChangesetsCreateItemErrors[keyof ChangesetsCreateItemErrors];
|
|
1520
1799
|
export type ChangesetsCreateItemResponses = {
|
|
1521
1800
|
/**
|
|
1522
|
-
*
|
|
1801
|
+
* Created
|
|
1523
1802
|
*/
|
|
1524
|
-
|
|
1803
|
+
201: ChangesetItem;
|
|
1525
1804
|
};
|
|
1526
1805
|
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
1806
|
export type ContentCreateData = {
|
|
1573
1807
|
/**
|
|
1574
1808
|
* The content item that should be created.
|
|
1575
1809
|
*/
|
|
1576
|
-
body:
|
|
1577
|
-
|
|
1578
|
-
query?: {
|
|
1810
|
+
body: ContentItemWritable;
|
|
1811
|
+
headers?: {
|
|
1579
1812
|
/**
|
|
1580
1813
|
* Indicates that the content validation should be ignored.
|
|
1581
1814
|
*/
|
|
1582
|
-
|
|
1815
|
+
'cms-skip-validation'?: boolean;
|
|
1583
1816
|
};
|
|
1584
|
-
|
|
1817
|
+
path?: never;
|
|
1818
|
+
query?: never;
|
|
1819
|
+
url: '/experimental/content';
|
|
1585
1820
|
};
|
|
1586
1821
|
export type ContentCreateErrors = {
|
|
1587
1822
|
/**
|
|
@@ -1598,24 +1833,25 @@ export type ContentCreateResponses = {
|
|
|
1598
1833
|
/**
|
|
1599
1834
|
* Created
|
|
1600
1835
|
*/
|
|
1601
|
-
201:
|
|
1836
|
+
201: ContentItem;
|
|
1602
1837
|
};
|
|
1603
1838
|
export type ContentCreateResponse = ContentCreateResponses[keyof ContentCreateResponses];
|
|
1604
1839
|
export type ContentDeleteData = {
|
|
1605
1840
|
body?: never;
|
|
1606
|
-
|
|
1841
|
+
headers?: {
|
|
1607
1842
|
/**
|
|
1608
|
-
*
|
|
1843
|
+
* Indicates that the content item should be permanently deleted immediately or if it should be soft deleted first.
|
|
1609
1844
|
*/
|
|
1610
|
-
|
|
1845
|
+
'cms-permanent-delete'?: boolean;
|
|
1611
1846
|
};
|
|
1612
|
-
|
|
1847
|
+
path: {
|
|
1613
1848
|
/**
|
|
1614
|
-
*
|
|
1849
|
+
* The key of the content item to delete.
|
|
1615
1850
|
*/
|
|
1616
|
-
|
|
1851
|
+
key: string;
|
|
1617
1852
|
};
|
|
1618
|
-
|
|
1853
|
+
query?: never;
|
|
1854
|
+
url: '/experimental/content/{key}';
|
|
1619
1855
|
};
|
|
1620
1856
|
export type ContentDeleteErrors = {
|
|
1621
1857
|
/**
|
|
@@ -1626,6 +1862,10 @@ export type ContentDeleteErrors = {
|
|
|
1626
1862
|
* Forbidden
|
|
1627
1863
|
*/
|
|
1628
1864
|
403: ProblemDetails;
|
|
1865
|
+
/**
|
|
1866
|
+
* Not Found
|
|
1867
|
+
*/
|
|
1868
|
+
404: ProblemDetails;
|
|
1629
1869
|
};
|
|
1630
1870
|
export type ContentDeleteError = ContentDeleteErrors[keyof ContentDeleteErrors];
|
|
1631
1871
|
export type ContentDeleteResponses = {
|
|
@@ -1649,13 +1889,17 @@ export type ContentGetMetadataData = {
|
|
|
1649
1889
|
*/
|
|
1650
1890
|
allowDeleted?: boolean;
|
|
1651
1891
|
};
|
|
1652
|
-
url: '/content/{key}';
|
|
1892
|
+
url: '/experimental/content/{key}';
|
|
1653
1893
|
};
|
|
1654
1894
|
export type ContentGetMetadataErrors = {
|
|
1655
1895
|
/**
|
|
1656
1896
|
* Forbidden
|
|
1657
1897
|
*/
|
|
1658
1898
|
403: ProblemDetails;
|
|
1899
|
+
/**
|
|
1900
|
+
* Not Found
|
|
1901
|
+
*/
|
|
1902
|
+
404: ProblemDetails;
|
|
1659
1903
|
};
|
|
1660
1904
|
export type ContentGetMetadataError = ContentGetMetadataErrors[keyof ContentGetMetadataErrors];
|
|
1661
1905
|
export type ContentGetMetadataResponses = {
|
|
@@ -1667,9 +1911,9 @@ export type ContentGetMetadataResponses = {
|
|
|
1667
1911
|
export type ContentGetMetadataResponse = ContentGetMetadataResponses[keyof ContentGetMetadataResponses];
|
|
1668
1912
|
export type ContentPatchMetadataData = {
|
|
1669
1913
|
/**
|
|
1670
|
-
* The values of the content item that should be
|
|
1914
|
+
* The values of the content item that should be patched.
|
|
1671
1915
|
*/
|
|
1672
|
-
body:
|
|
1916
|
+
body: ContentMetadataWritable;
|
|
1673
1917
|
path: {
|
|
1674
1918
|
/**
|
|
1675
1919
|
* The key of the content item to patch.
|
|
@@ -1677,7 +1921,7 @@ export type ContentPatchMetadataData = {
|
|
|
1677
1921
|
key: string;
|
|
1678
1922
|
};
|
|
1679
1923
|
query?: never;
|
|
1680
|
-
url: '/content/{key}';
|
|
1924
|
+
url: '/experimental/content/{key}';
|
|
1681
1925
|
};
|
|
1682
1926
|
export type ContentPatchMetadataErrors = {
|
|
1683
1927
|
/**
|
|
@@ -1688,6 +1932,10 @@ export type ContentPatchMetadataErrors = {
|
|
|
1688
1932
|
* Forbidden
|
|
1689
1933
|
*/
|
|
1690
1934
|
403: ProblemDetails;
|
|
1935
|
+
/**
|
|
1936
|
+
* Not Found
|
|
1937
|
+
*/
|
|
1938
|
+
404: ProblemDetails;
|
|
1691
1939
|
};
|
|
1692
1940
|
export type ContentPatchMetadataError = ContentPatchMetadataErrors[keyof ContentPatchMetadataErrors];
|
|
1693
1941
|
export type ContentPatchMetadataResponses = {
|
|
@@ -1709,13 +1957,17 @@ export type ContentGetPathData = {
|
|
|
1709
1957
|
pageIndex?: number;
|
|
1710
1958
|
pageSize?: number;
|
|
1711
1959
|
};
|
|
1712
|
-
url: '/content/{key}/path';
|
|
1960
|
+
url: '/experimental/content/{key}/path';
|
|
1713
1961
|
};
|
|
1714
1962
|
export type ContentGetPathErrors = {
|
|
1715
1963
|
/**
|
|
1716
1964
|
* Forbidden
|
|
1717
1965
|
*/
|
|
1718
1966
|
403: ProblemDetails;
|
|
1967
|
+
/**
|
|
1968
|
+
* Not Found
|
|
1969
|
+
*/
|
|
1970
|
+
404: ProblemDetails;
|
|
1719
1971
|
};
|
|
1720
1972
|
export type ContentGetPathError = ContentGetPathErrors[keyof ContentGetPathErrors];
|
|
1721
1973
|
export type ContentGetPathResponses = {
|
|
@@ -1741,13 +1993,17 @@ export type ContentListItemsData = {
|
|
|
1741
1993
|
pageIndex?: number;
|
|
1742
1994
|
pageSize?: number;
|
|
1743
1995
|
};
|
|
1744
|
-
url: '/content/{key}/items';
|
|
1996
|
+
url: '/experimental/content/{key}/items';
|
|
1745
1997
|
};
|
|
1746
1998
|
export type ContentListItemsErrors = {
|
|
1747
1999
|
/**
|
|
1748
2000
|
* Forbidden
|
|
1749
2001
|
*/
|
|
1750
2002
|
403: ProblemDetails;
|
|
2003
|
+
/**
|
|
2004
|
+
* Not Found
|
|
2005
|
+
*/
|
|
2006
|
+
404: ProblemDetails;
|
|
1751
2007
|
};
|
|
1752
2008
|
export type ContentListItemsError = ContentListItemsErrors[keyof ContentListItemsErrors];
|
|
1753
2009
|
export type ContentListItemsResponses = {
|
|
@@ -1773,13 +2029,17 @@ export type ContentListAssetsData = {
|
|
|
1773
2029
|
pageIndex?: number;
|
|
1774
2030
|
pageSize?: number;
|
|
1775
2031
|
};
|
|
1776
|
-
url: '/content/{key}/assets';
|
|
2032
|
+
url: '/experimental/content/{key}/assets';
|
|
1777
2033
|
};
|
|
1778
2034
|
export type ContentListAssetsErrors = {
|
|
1779
2035
|
/**
|
|
1780
2036
|
* Forbidden
|
|
1781
2037
|
*/
|
|
1782
2038
|
403: ProblemDetails;
|
|
2039
|
+
/**
|
|
2040
|
+
* Not Found
|
|
2041
|
+
*/
|
|
2042
|
+
404: ProblemDetails;
|
|
1783
2043
|
};
|
|
1784
2044
|
export type ContentListAssetsError = ContentListAssetsErrors[keyof ContentListAssetsErrors];
|
|
1785
2045
|
export type ContentListAssetsResponses = {
|
|
@@ -1801,7 +2061,7 @@ export type ContentCopyData = {
|
|
|
1801
2061
|
key: string;
|
|
1802
2062
|
};
|
|
1803
2063
|
query?: never;
|
|
1804
|
-
url: '/content/{key}:copy';
|
|
2064
|
+
url: '/experimental/content/{key}:copy';
|
|
1805
2065
|
};
|
|
1806
2066
|
export type ContentCopyErrors = {
|
|
1807
2067
|
/**
|
|
@@ -1812,6 +2072,10 @@ export type ContentCopyErrors = {
|
|
|
1812
2072
|
* Forbidden
|
|
1813
2073
|
*/
|
|
1814
2074
|
403: ProblemDetails;
|
|
2075
|
+
/**
|
|
2076
|
+
* Not Found
|
|
2077
|
+
*/
|
|
2078
|
+
404: ProblemDetails;
|
|
1815
2079
|
};
|
|
1816
2080
|
export type ContentCopyError = ContentCopyErrors[keyof ContentCopyErrors];
|
|
1817
2081
|
export type ContentCopyResponses = {
|
|
@@ -1830,7 +2094,7 @@ export type ContentUndeleteData = {
|
|
|
1830
2094
|
key: string;
|
|
1831
2095
|
};
|
|
1832
2096
|
query?: never;
|
|
1833
|
-
url: '/content/{key}:undelete';
|
|
2097
|
+
url: '/experimental/content/{key}:undelete';
|
|
1834
2098
|
};
|
|
1835
2099
|
export type ContentUndeleteErrors = {
|
|
1836
2100
|
/**
|
|
@@ -1841,6 +2105,10 @@ export type ContentUndeleteErrors = {
|
|
|
1841
2105
|
* Forbidden
|
|
1842
2106
|
*/
|
|
1843
2107
|
403: ProblemDetails;
|
|
2108
|
+
/**
|
|
2109
|
+
* Not Found
|
|
2110
|
+
*/
|
|
2111
|
+
404: ProblemDetails;
|
|
1844
2112
|
};
|
|
1845
2113
|
export type ContentUndeleteError = ContentUndeleteErrors[keyof ContentUndeleteErrors];
|
|
1846
2114
|
export type ContentUndeleteResponses = {
|
|
@@ -1862,11 +2130,11 @@ export type ContentListAllVersionsData = {
|
|
|
1862
2130
|
/**
|
|
1863
2131
|
* Indicates which status content versions must have to be listed.
|
|
1864
2132
|
*/
|
|
1865
|
-
statuses?: Array<
|
|
2133
|
+
statuses?: Array<'draft' | 'ready' | 'published' | 'previous' | 'scheduled' | 'rejected' | 'inReview'>;
|
|
1866
2134
|
pageIndex?: number;
|
|
1867
2135
|
pageSize?: number;
|
|
1868
2136
|
};
|
|
1869
|
-
url: '/content/versions';
|
|
2137
|
+
url: '/experimental/content/versions';
|
|
1870
2138
|
};
|
|
1871
2139
|
export type ContentListAllVersionsErrors = {
|
|
1872
2140
|
/**
|
|
@@ -1879,7 +2147,7 @@ export type ContentListAllVersionsResponses = {
|
|
|
1879
2147
|
/**
|
|
1880
2148
|
* OK
|
|
1881
2149
|
*/
|
|
1882
|
-
200:
|
|
2150
|
+
200: ContentItemPage;
|
|
1883
2151
|
};
|
|
1884
2152
|
export type ContentListAllVersionsResponse = ContentListAllVersionsResponses[keyof ContentListAllVersionsResponses];
|
|
1885
2153
|
export type ContentDeleteLocaleData = {
|
|
@@ -1890,7 +2158,7 @@ export type ContentDeleteLocaleData = {
|
|
|
1890
2158
|
query?: {
|
|
1891
2159
|
locale?: string;
|
|
1892
2160
|
};
|
|
1893
|
-
url: '/content/{key}/versions';
|
|
2161
|
+
url: '/experimental/content/{key}/versions';
|
|
1894
2162
|
};
|
|
1895
2163
|
export type ContentDeleteLocaleErrors = {
|
|
1896
2164
|
/**
|
|
@@ -1901,13 +2169,17 @@ export type ContentDeleteLocaleErrors = {
|
|
|
1901
2169
|
* Forbidden
|
|
1902
2170
|
*/
|
|
1903
2171
|
403: ProblemDetails;
|
|
2172
|
+
/**
|
|
2173
|
+
* Not Found
|
|
2174
|
+
*/
|
|
2175
|
+
404: ProblemDetails;
|
|
1904
2176
|
};
|
|
1905
2177
|
export type ContentDeleteLocaleError = ContentDeleteLocaleErrors[keyof ContentDeleteLocaleErrors];
|
|
1906
2178
|
export type ContentDeleteLocaleResponses = {
|
|
1907
2179
|
/**
|
|
1908
2180
|
* OK
|
|
1909
2181
|
*/
|
|
1910
|
-
200:
|
|
2182
|
+
200: ContentItem;
|
|
1911
2183
|
};
|
|
1912
2184
|
export type ContentDeleteLocaleResponse = ContentDeleteLocaleResponses[keyof ContentDeleteLocaleResponses];
|
|
1913
2185
|
export type ContentListVersionsData = {
|
|
@@ -1924,44 +2196,49 @@ export type ContentListVersionsData = {
|
|
|
1924
2196
|
/**
|
|
1925
2197
|
* Indicates which status content versions must have to be listed.
|
|
1926
2198
|
*/
|
|
1927
|
-
statuses?: Array<
|
|
2199
|
+
statuses?: Array<'draft' | 'ready' | 'published' | 'previous' | 'scheduled' | 'rejected' | 'inReview'>;
|
|
1928
2200
|
pageIndex?: number;
|
|
1929
2201
|
pageSize?: number;
|
|
1930
2202
|
};
|
|
1931
|
-
url: '/content/{key}/versions';
|
|
2203
|
+
url: '/experimental/content/{key}/versions';
|
|
1932
2204
|
};
|
|
1933
2205
|
export type ContentListVersionsErrors = {
|
|
1934
2206
|
/**
|
|
1935
2207
|
* Forbidden
|
|
1936
2208
|
*/
|
|
1937
2209
|
403: ProblemDetails;
|
|
2210
|
+
/**
|
|
2211
|
+
* Not Found
|
|
2212
|
+
*/
|
|
2213
|
+
404: ProblemDetails;
|
|
1938
2214
|
};
|
|
1939
2215
|
export type ContentListVersionsError = ContentListVersionsErrors[keyof ContentListVersionsErrors];
|
|
1940
2216
|
export type ContentListVersionsResponses = {
|
|
1941
2217
|
/**
|
|
1942
2218
|
* OK
|
|
1943
2219
|
*/
|
|
1944
|
-
200:
|
|
2220
|
+
200: ContentItemPage;
|
|
1945
2221
|
};
|
|
1946
2222
|
export type ContentListVersionsResponse = ContentListVersionsResponses[keyof ContentListVersionsResponses];
|
|
1947
2223
|
export type ContentCreateVersionData = {
|
|
1948
2224
|
/**
|
|
1949
2225
|
* The content version that should be created.
|
|
1950
2226
|
*/
|
|
1951
|
-
body:
|
|
1952
|
-
|
|
2227
|
+
body: ContentItemWritable;
|
|
2228
|
+
headers?: {
|
|
1953
2229
|
/**
|
|
1954
|
-
*
|
|
2230
|
+
* Indicates that the content validation should be ignored.
|
|
1955
2231
|
*/
|
|
1956
|
-
|
|
2232
|
+
'cms-skip-validation'?: boolean;
|
|
1957
2233
|
};
|
|
1958
|
-
|
|
2234
|
+
path: {
|
|
1959
2235
|
/**
|
|
1960
|
-
*
|
|
2236
|
+
* The key of the content item for which a new content version should be created.
|
|
1961
2237
|
*/
|
|
1962
|
-
|
|
2238
|
+
key: string;
|
|
1963
2239
|
};
|
|
1964
|
-
|
|
2240
|
+
query?: never;
|
|
2241
|
+
url: '/experimental/content/{key}/versions';
|
|
1965
2242
|
};
|
|
1966
2243
|
export type ContentCreateVersionErrors = {
|
|
1967
2244
|
/**
|
|
@@ -1972,13 +2249,17 @@ export type ContentCreateVersionErrors = {
|
|
|
1972
2249
|
* Forbidden
|
|
1973
2250
|
*/
|
|
1974
2251
|
403: ProblemDetails;
|
|
2252
|
+
/**
|
|
2253
|
+
* Not Found
|
|
2254
|
+
*/
|
|
2255
|
+
404: ProblemDetails;
|
|
1975
2256
|
};
|
|
1976
2257
|
export type ContentCreateVersionError = ContentCreateVersionErrors[keyof ContentCreateVersionErrors];
|
|
1977
2258
|
export type ContentCreateVersionResponses = {
|
|
1978
2259
|
/**
|
|
1979
2260
|
* Created
|
|
1980
2261
|
*/
|
|
1981
|
-
201:
|
|
2262
|
+
201: ContentItem;
|
|
1982
2263
|
};
|
|
1983
2264
|
export type ContentCreateVersionResponse = ContentCreateVersionResponses[keyof ContentCreateVersionResponses];
|
|
1984
2265
|
export type ContentDeleteVersionData = {
|
|
@@ -1988,7 +2269,7 @@ export type ContentDeleteVersionData = {
|
|
|
1988
2269
|
version: string;
|
|
1989
2270
|
};
|
|
1990
2271
|
query?: never;
|
|
1991
|
-
url: '/content/{key}/versions/{version}';
|
|
2272
|
+
url: '/experimental/content/{key}/versions/{version}';
|
|
1992
2273
|
};
|
|
1993
2274
|
export type ContentDeleteVersionErrors = {
|
|
1994
2275
|
/**
|
|
@@ -1999,17 +2280,31 @@ export type ContentDeleteVersionErrors = {
|
|
|
1999
2280
|
* Forbidden
|
|
2000
2281
|
*/
|
|
2001
2282
|
403: ProblemDetails;
|
|
2283
|
+
/**
|
|
2284
|
+
* Not Found
|
|
2285
|
+
*/
|
|
2286
|
+
404: ProblemDetails;
|
|
2002
2287
|
};
|
|
2003
2288
|
export type ContentDeleteVersionError = ContentDeleteVersionErrors[keyof ContentDeleteVersionErrors];
|
|
2004
2289
|
export type ContentDeleteVersionResponses = {
|
|
2005
2290
|
/**
|
|
2006
2291
|
* OK
|
|
2007
2292
|
*/
|
|
2008
|
-
200:
|
|
2293
|
+
200: ContentItem;
|
|
2009
2294
|
};
|
|
2010
2295
|
export type ContentDeleteVersionResponse = ContentDeleteVersionResponses[keyof ContentDeleteVersionResponses];
|
|
2011
2296
|
export type ContentGetVersionData = {
|
|
2012
2297
|
body?: never;
|
|
2298
|
+
headers?: {
|
|
2299
|
+
/**
|
|
2300
|
+
* 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.
|
|
2301
|
+
*/
|
|
2302
|
+
'If-None-Match'?: string;
|
|
2303
|
+
/**
|
|
2304
|
+
* 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.
|
|
2305
|
+
*/
|
|
2306
|
+
'If-Modified-Since'?: string;
|
|
2307
|
+
};
|
|
2013
2308
|
path: {
|
|
2014
2309
|
key: string;
|
|
2015
2310
|
version: string;
|
|
@@ -2017,48 +2312,54 @@ export type ContentGetVersionData = {
|
|
|
2017
2312
|
query?: {
|
|
2018
2313
|
locale?: string;
|
|
2019
2314
|
};
|
|
2020
|
-
url: '/content/{key}/versions/{version}';
|
|
2315
|
+
url: '/experimental/content/{key}/versions/{version}';
|
|
2021
2316
|
};
|
|
2022
2317
|
export type ContentGetVersionErrors = {
|
|
2023
2318
|
/**
|
|
2024
2319
|
* Forbidden
|
|
2025
2320
|
*/
|
|
2026
2321
|
403: ProblemDetails;
|
|
2322
|
+
/**
|
|
2323
|
+
* Not Found
|
|
2324
|
+
*/
|
|
2325
|
+
404: ProblemDetails;
|
|
2027
2326
|
};
|
|
2028
2327
|
export type ContentGetVersionError = ContentGetVersionErrors[keyof ContentGetVersionErrors];
|
|
2029
2328
|
export type ContentGetVersionResponses = {
|
|
2030
2329
|
/**
|
|
2031
2330
|
* OK
|
|
2032
2331
|
*/
|
|
2033
|
-
200:
|
|
2332
|
+
200: ContentItem;
|
|
2034
2333
|
};
|
|
2035
2334
|
export type ContentGetVersionResponse = ContentGetVersionResponses[keyof ContentGetVersionResponses];
|
|
2036
2335
|
export type ContentPatchVersionData = {
|
|
2037
2336
|
/**
|
|
2038
|
-
* The content information that should be
|
|
2337
|
+
* The content information that should be patched.
|
|
2039
2338
|
*/
|
|
2040
|
-
body:
|
|
2339
|
+
body: ContentItemWritable;
|
|
2340
|
+
headers?: {
|
|
2341
|
+
/**
|
|
2342
|
+
* Indicates that the content validation should be ignored.
|
|
2343
|
+
*/
|
|
2344
|
+
'cms-skip-validation'?: boolean;
|
|
2345
|
+
};
|
|
2041
2346
|
path: {
|
|
2042
2347
|
/**
|
|
2043
|
-
* The key of the content item that should be
|
|
2348
|
+
* The key of the content item that should be patched.
|
|
2044
2349
|
*/
|
|
2045
2350
|
key: string;
|
|
2046
2351
|
/**
|
|
2047
|
-
* The version of the content that should be
|
|
2352
|
+
* The version of the content that should be patched.
|
|
2048
2353
|
*/
|
|
2049
2354
|
version: string;
|
|
2050
2355
|
};
|
|
2051
2356
|
query?: {
|
|
2052
2357
|
/**
|
|
2053
|
-
* The locale of the content that should be
|
|
2358
|
+
* The locale of the content that should be patched.
|
|
2054
2359
|
*/
|
|
2055
2360
|
locale?: string;
|
|
2056
|
-
/**
|
|
2057
|
-
* Indicates that the content validation should be ignored.
|
|
2058
|
-
*/
|
|
2059
|
-
skipValidation?: boolean;
|
|
2060
2361
|
};
|
|
2061
|
-
url: '/content/{key}/versions/{version}';
|
|
2362
|
+
url: '/experimental/content/{key}/versions/{version}';
|
|
2062
2363
|
};
|
|
2063
2364
|
export type ContentPatchVersionErrors = {
|
|
2064
2365
|
/**
|
|
@@ -2069,15 +2370,52 @@ export type ContentPatchVersionErrors = {
|
|
|
2069
2370
|
* Forbidden
|
|
2070
2371
|
*/
|
|
2071
2372
|
403: ProblemDetails;
|
|
2373
|
+
/**
|
|
2374
|
+
* Not Found
|
|
2375
|
+
*/
|
|
2376
|
+
404: ProblemDetails;
|
|
2072
2377
|
};
|
|
2073
2378
|
export type ContentPatchVersionError = ContentPatchVersionErrors[keyof ContentPatchVersionErrors];
|
|
2074
2379
|
export type ContentPatchVersionResponses = {
|
|
2075
2380
|
/**
|
|
2076
2381
|
* OK
|
|
2077
2382
|
*/
|
|
2078
|
-
200:
|
|
2383
|
+
200: ContentItem;
|
|
2079
2384
|
};
|
|
2080
2385
|
export type ContentPatchVersionResponse = ContentPatchVersionResponses[keyof ContentPatchVersionResponses];
|
|
2386
|
+
export type ContentGetPreviewsData = {
|
|
2387
|
+
body?: never;
|
|
2388
|
+
path: {
|
|
2389
|
+
/**
|
|
2390
|
+
* The key of the content item.
|
|
2391
|
+
*/
|
|
2392
|
+
key: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* The version of the content item.
|
|
2395
|
+
*/
|
|
2396
|
+
version: string;
|
|
2397
|
+
};
|
|
2398
|
+
query?: never;
|
|
2399
|
+
url: '/experimental/content/{key}/versions/{version}/previews';
|
|
2400
|
+
};
|
|
2401
|
+
export type ContentGetPreviewsErrors = {
|
|
2402
|
+
/**
|
|
2403
|
+
* Forbidden
|
|
2404
|
+
*/
|
|
2405
|
+
403: ProblemDetails;
|
|
2406
|
+
/**
|
|
2407
|
+
* Not Found
|
|
2408
|
+
*/
|
|
2409
|
+
404: ProblemDetails;
|
|
2410
|
+
};
|
|
2411
|
+
export type ContentGetPreviewsError = ContentGetPreviewsErrors[keyof ContentGetPreviewsErrors];
|
|
2412
|
+
export type ContentGetPreviewsResponses = {
|
|
2413
|
+
/**
|
|
2414
|
+
* OK
|
|
2415
|
+
*/
|
|
2416
|
+
200: Array<Preview>;
|
|
2417
|
+
};
|
|
2418
|
+
export type ContentGetPreviewsResponse = ContentGetPreviewsResponses[keyof ContentGetPreviewsResponses];
|
|
2081
2419
|
export type ContentTypesListData = {
|
|
2082
2420
|
body?: never;
|
|
2083
2421
|
path?: never;
|
|
@@ -2088,8 +2426,7 @@ export type ContentTypesListData = {
|
|
|
2088
2426
|
forContainerType?: string;
|
|
2089
2427
|
/**
|
|
2090
2428
|
* Indicates which sources should be included when listing content types.
|
|
2091
|
-
* Use
|
|
2092
|
-
* Default to include content types without a specific sources.
|
|
2429
|
+
* Use 'DEFAULT' to include content types without a specific source.
|
|
2093
2430
|
*/
|
|
2094
2431
|
sources?: Array<string>;
|
|
2095
2432
|
pageIndex?: number;
|
|
@@ -2113,9 +2450,9 @@ export type ContentTypesListResponses = {
|
|
|
2113
2450
|
export type ContentTypesListResponse = ContentTypesListResponses[keyof ContentTypesListResponses];
|
|
2114
2451
|
export type ContentTypesCreateData = {
|
|
2115
2452
|
/**
|
|
2116
|
-
* The content type that should be created.
|
|
2453
|
+
* The content type that should be created or replaced.
|
|
2117
2454
|
*/
|
|
2118
|
-
body:
|
|
2455
|
+
body: ContentTypeWritable;
|
|
2119
2456
|
path?: never;
|
|
2120
2457
|
query?: never;
|
|
2121
2458
|
url: '/contenttypes';
|
|
@@ -2133,13 +2470,23 @@ export type ContentTypesCreateErrors = {
|
|
|
2133
2470
|
export type ContentTypesCreateError = ContentTypesCreateErrors[keyof ContentTypesCreateErrors];
|
|
2134
2471
|
export type ContentTypesCreateResponses = {
|
|
2135
2472
|
/**
|
|
2136
|
-
*
|
|
2473
|
+
* Created
|
|
2137
2474
|
*/
|
|
2138
|
-
|
|
2475
|
+
201: ContentType;
|
|
2139
2476
|
};
|
|
2140
2477
|
export type ContentTypesCreateResponse = ContentTypesCreateResponses[keyof ContentTypesCreateResponses];
|
|
2141
2478
|
export type ContentTypesDeleteData = {
|
|
2142
2479
|
body?: never;
|
|
2480
|
+
headers?: {
|
|
2481
|
+
/**
|
|
2482
|
+
* 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.
|
|
2483
|
+
*/
|
|
2484
|
+
'If-Match'?: string;
|
|
2485
|
+
/**
|
|
2486
|
+
* 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.
|
|
2487
|
+
*/
|
|
2488
|
+
'If-Unmodified-Since'?: string;
|
|
2489
|
+
};
|
|
2143
2490
|
path: {
|
|
2144
2491
|
/**
|
|
2145
2492
|
* The key of the content type to delete.
|
|
@@ -2158,6 +2505,14 @@ export type ContentTypesDeleteErrors = {
|
|
|
2158
2505
|
* Forbidden
|
|
2159
2506
|
*/
|
|
2160
2507
|
403: ProblemDetails;
|
|
2508
|
+
/**
|
|
2509
|
+
* Not Found
|
|
2510
|
+
*/
|
|
2511
|
+
404: ProblemDetails;
|
|
2512
|
+
/**
|
|
2513
|
+
* Precondition Failed
|
|
2514
|
+
*/
|
|
2515
|
+
412: ProblemDetails;
|
|
2161
2516
|
};
|
|
2162
2517
|
export type ContentTypesDeleteError = ContentTypesDeleteErrors[keyof ContentTypesDeleteErrors];
|
|
2163
2518
|
export type ContentTypesDeleteResponses = {
|
|
@@ -2169,6 +2524,16 @@ export type ContentTypesDeleteResponses = {
|
|
|
2169
2524
|
export type ContentTypesDeleteResponse = ContentTypesDeleteResponses[keyof ContentTypesDeleteResponses];
|
|
2170
2525
|
export type ContentTypesGetData = {
|
|
2171
2526
|
body?: never;
|
|
2527
|
+
headers?: {
|
|
2528
|
+
/**
|
|
2529
|
+
* 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.
|
|
2530
|
+
*/
|
|
2531
|
+
'If-None-Match'?: string;
|
|
2532
|
+
/**
|
|
2533
|
+
* 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.
|
|
2534
|
+
*/
|
|
2535
|
+
'If-Modified-Since'?: string;
|
|
2536
|
+
};
|
|
2172
2537
|
path: {
|
|
2173
2538
|
/**
|
|
2174
2539
|
* The key of the content type to retrieve.
|
|
@@ -2183,6 +2548,10 @@ export type ContentTypesGetErrors = {
|
|
|
2183
2548
|
* Forbidden
|
|
2184
2549
|
*/
|
|
2185
2550
|
403: ProblemDetails;
|
|
2551
|
+
/**
|
|
2552
|
+
* Not Found
|
|
2553
|
+
*/
|
|
2554
|
+
404: ProblemDetails;
|
|
2186
2555
|
};
|
|
2187
2556
|
export type ContentTypesGetError = ContentTypesGetErrors[keyof ContentTypesGetErrors];
|
|
2188
2557
|
export type ContentTypesGetResponses = {
|
|
@@ -2194,21 +2563,30 @@ export type ContentTypesGetResponses = {
|
|
|
2194
2563
|
export type ContentTypesGetResponse = ContentTypesGetResponses[keyof ContentTypesGetResponses];
|
|
2195
2564
|
export type ContentTypesPatchData = {
|
|
2196
2565
|
/**
|
|
2197
|
-
* The values of the content type that should be
|
|
2566
|
+
* The values of the content type that should be patched formatted according to RFC7396.
|
|
2198
2567
|
*/
|
|
2199
|
-
body:
|
|
2200
|
-
|
|
2568
|
+
body: ContentTypeWritable;
|
|
2569
|
+
headers?: {
|
|
2201
2570
|
/**
|
|
2202
|
-
*
|
|
2571
|
+
* Patch the content type even though the changes might result in data loss.
|
|
2203
2572
|
*/
|
|
2204
|
-
|
|
2573
|
+
'cms-ignore-data-loss-warnings'?: boolean;
|
|
2574
|
+
/**
|
|
2575
|
+
* 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.
|
|
2576
|
+
*/
|
|
2577
|
+
'If-Match'?: string;
|
|
2578
|
+
/**
|
|
2579
|
+
* 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.
|
|
2580
|
+
*/
|
|
2581
|
+
'If-Unmodified-Since'?: string;
|
|
2205
2582
|
};
|
|
2206
|
-
|
|
2583
|
+
path: {
|
|
2207
2584
|
/**
|
|
2208
|
-
*
|
|
2585
|
+
* The key of the content type to patch.
|
|
2209
2586
|
*/
|
|
2210
|
-
|
|
2587
|
+
key: string;
|
|
2211
2588
|
};
|
|
2589
|
+
query?: never;
|
|
2212
2590
|
url: '/contenttypes/{key}';
|
|
2213
2591
|
};
|
|
2214
2592
|
export type ContentTypesPatchErrors = {
|
|
@@ -2220,52 +2598,23 @@ export type ContentTypesPatchErrors = {
|
|
|
2220
2598
|
* Forbidden
|
|
2221
2599
|
*/
|
|
2222
2600
|
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
2601
|
/**
|
|
2253
|
-
*
|
|
2602
|
+
* Not Found
|
|
2254
2603
|
*/
|
|
2255
|
-
|
|
2604
|
+
404: ProblemDetails;
|
|
2256
2605
|
/**
|
|
2257
|
-
*
|
|
2606
|
+
* Precondition Failed
|
|
2258
2607
|
*/
|
|
2259
|
-
|
|
2608
|
+
412: ProblemDetails;
|
|
2260
2609
|
};
|
|
2261
|
-
export type
|
|
2262
|
-
export type
|
|
2610
|
+
export type ContentTypesPatchError = ContentTypesPatchErrors[keyof ContentTypesPatchErrors];
|
|
2611
|
+
export type ContentTypesPatchResponses = {
|
|
2263
2612
|
/**
|
|
2264
2613
|
* OK
|
|
2265
2614
|
*/
|
|
2266
2615
|
200: ContentType;
|
|
2267
2616
|
};
|
|
2268
|
-
export type
|
|
2617
|
+
export type ContentTypesPatchResponse = ContentTypesPatchResponses[keyof ContentTypesPatchResponses];
|
|
2269
2618
|
export type DisplayTemplatesListData = {
|
|
2270
2619
|
body?: never;
|
|
2271
2620
|
path?: never;
|
|
@@ -2293,7 +2642,7 @@ export type DisplayTemplatesCreateData = {
|
|
|
2293
2642
|
/**
|
|
2294
2643
|
* The display template that should be created.
|
|
2295
2644
|
*/
|
|
2296
|
-
body:
|
|
2645
|
+
body: DisplayTemplateWritable;
|
|
2297
2646
|
path?: never;
|
|
2298
2647
|
query?: never;
|
|
2299
2648
|
url: '/displaytemplates';
|
|
@@ -2311,13 +2660,23 @@ export type DisplayTemplatesCreateErrors = {
|
|
|
2311
2660
|
export type DisplayTemplatesCreateError = DisplayTemplatesCreateErrors[keyof DisplayTemplatesCreateErrors];
|
|
2312
2661
|
export type DisplayTemplatesCreateResponses = {
|
|
2313
2662
|
/**
|
|
2314
|
-
*
|
|
2663
|
+
* Created
|
|
2315
2664
|
*/
|
|
2316
|
-
|
|
2665
|
+
201: DisplayTemplate;
|
|
2317
2666
|
};
|
|
2318
2667
|
export type DisplayTemplatesCreateResponse = DisplayTemplatesCreateResponses[keyof DisplayTemplatesCreateResponses];
|
|
2319
2668
|
export type DisplayTemplatesDeleteData = {
|
|
2320
2669
|
body?: never;
|
|
2670
|
+
headers?: {
|
|
2671
|
+
/**
|
|
2672
|
+
* 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.
|
|
2673
|
+
*/
|
|
2674
|
+
'If-Match'?: string;
|
|
2675
|
+
/**
|
|
2676
|
+
* 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.
|
|
2677
|
+
*/
|
|
2678
|
+
'If-Unmodified-Since'?: string;
|
|
2679
|
+
};
|
|
2321
2680
|
path: {
|
|
2322
2681
|
/**
|
|
2323
2682
|
* The key of the display template to delete.
|
|
@@ -2336,6 +2695,14 @@ export type DisplayTemplatesDeleteErrors = {
|
|
|
2336
2695
|
* Forbidden
|
|
2337
2696
|
*/
|
|
2338
2697
|
403: ProblemDetails;
|
|
2698
|
+
/**
|
|
2699
|
+
* Not Found
|
|
2700
|
+
*/
|
|
2701
|
+
404: ProblemDetails;
|
|
2702
|
+
/**
|
|
2703
|
+
* Precondition Failed
|
|
2704
|
+
*/
|
|
2705
|
+
412: ProblemDetails;
|
|
2339
2706
|
};
|
|
2340
2707
|
export type DisplayTemplatesDeleteError = DisplayTemplatesDeleteErrors[keyof DisplayTemplatesDeleteErrors];
|
|
2341
2708
|
export type DisplayTemplatesDeleteResponses = {
|
|
@@ -2347,6 +2714,16 @@ export type DisplayTemplatesDeleteResponses = {
|
|
|
2347
2714
|
export type DisplayTemplatesDeleteResponse = DisplayTemplatesDeleteResponses[keyof DisplayTemplatesDeleteResponses];
|
|
2348
2715
|
export type DisplayTemplatesGetData = {
|
|
2349
2716
|
body?: never;
|
|
2717
|
+
headers?: {
|
|
2718
|
+
/**
|
|
2719
|
+
* 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.
|
|
2720
|
+
*/
|
|
2721
|
+
'If-None-Match'?: string;
|
|
2722
|
+
/**
|
|
2723
|
+
* 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.
|
|
2724
|
+
*/
|
|
2725
|
+
'If-Modified-Since'?: string;
|
|
2726
|
+
};
|
|
2350
2727
|
path: {
|
|
2351
2728
|
/**
|
|
2352
2729
|
* The key of the display template to retrieve.
|
|
@@ -2361,6 +2738,10 @@ export type DisplayTemplatesGetErrors = {
|
|
|
2361
2738
|
* Forbidden
|
|
2362
2739
|
*/
|
|
2363
2740
|
403: ProblemDetails;
|
|
2741
|
+
/**
|
|
2742
|
+
* Not Found
|
|
2743
|
+
*/
|
|
2744
|
+
404: ProblemDetails;
|
|
2364
2745
|
};
|
|
2365
2746
|
export type DisplayTemplatesGetError = DisplayTemplatesGetErrors[keyof DisplayTemplatesGetErrors];
|
|
2366
2747
|
export type DisplayTemplatesGetResponses = {
|
|
@@ -2372,51 +2753,29 @@ export type DisplayTemplatesGetResponses = {
|
|
|
2372
2753
|
export type DisplayTemplatesGetResponse = DisplayTemplatesGetResponses[keyof DisplayTemplatesGetResponses];
|
|
2373
2754
|
export type DisplayTemplatesPatchData = {
|
|
2374
2755
|
/**
|
|
2375
|
-
* The values of the display template that should be
|
|
2756
|
+
* The values of the display template that should be patched formatted according to RFC7396.
|
|
2376
2757
|
*/
|
|
2377
|
-
body:
|
|
2378
|
-
|
|
2758
|
+
body: DisplayTemplateWritable;
|
|
2759
|
+
headers?: {
|
|
2379
2760
|
/**
|
|
2380
|
-
*
|
|
2761
|
+
* 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
2762
|
*/
|
|
2382
|
-
|
|
2763
|
+
'If-Match'?: string;
|
|
2764
|
+
/**
|
|
2765
|
+
* 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.
|
|
2766
|
+
*/
|
|
2767
|
+
'If-Unmodified-Since'?: string;
|
|
2383
2768
|
};
|
|
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
2769
|
path: {
|
|
2411
2770
|
/**
|
|
2412
|
-
* The key of the display template to
|
|
2771
|
+
* The key of the display template to patch.
|
|
2413
2772
|
*/
|
|
2414
2773
|
key: string;
|
|
2415
2774
|
};
|
|
2416
2775
|
query?: never;
|
|
2417
2776
|
url: '/displaytemplates/{key}';
|
|
2418
2777
|
};
|
|
2419
|
-
export type
|
|
2778
|
+
export type DisplayTemplatesPatchErrors = {
|
|
2420
2779
|
/**
|
|
2421
2780
|
* Bad Request
|
|
2422
2781
|
*/
|
|
@@ -2425,35 +2784,23 @@ export type DisplayTemplatesPutErrors = {
|
|
|
2425
2784
|
* Forbidden
|
|
2426
2785
|
*/
|
|
2427
2786
|
403: ProblemDetails;
|
|
2428
|
-
};
|
|
2429
|
-
export type DisplayTemplatesPutError = DisplayTemplatesPutErrors[keyof DisplayTemplatesPutErrors];
|
|
2430
|
-
export type DisplayTemplatesPutResponses = {
|
|
2431
2787
|
/**
|
|
2432
|
-
*
|
|
2788
|
+
* Not Found
|
|
2433
2789
|
*/
|
|
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 = {
|
|
2790
|
+
404: ProblemDetails;
|
|
2444
2791
|
/**
|
|
2445
|
-
*
|
|
2792
|
+
* Precondition Failed
|
|
2446
2793
|
*/
|
|
2447
|
-
|
|
2794
|
+
412: ProblemDetails;
|
|
2448
2795
|
};
|
|
2449
|
-
export type
|
|
2450
|
-
export type
|
|
2796
|
+
export type DisplayTemplatesPatchError = DisplayTemplatesPatchErrors[keyof DisplayTemplatesPatchErrors];
|
|
2797
|
+
export type DisplayTemplatesPatchResponses = {
|
|
2451
2798
|
/**
|
|
2452
2799
|
* OK
|
|
2453
2800
|
*/
|
|
2454
|
-
200:
|
|
2801
|
+
200: DisplayTemplate;
|
|
2455
2802
|
};
|
|
2456
|
-
export type
|
|
2803
|
+
export type DisplayTemplatesPatchResponse = DisplayTemplatesPatchResponses[keyof DisplayTemplatesPatchResponses];
|
|
2457
2804
|
export type PropertyFormatsListData = {
|
|
2458
2805
|
body?: never;
|
|
2459
2806
|
path?: never;
|
|
@@ -2479,6 +2826,16 @@ export type PropertyFormatsListResponses = {
|
|
|
2479
2826
|
export type PropertyFormatsListResponse = PropertyFormatsListResponses[keyof PropertyFormatsListResponses];
|
|
2480
2827
|
export type PropertyFormatsGetData = {
|
|
2481
2828
|
body?: never;
|
|
2829
|
+
headers?: {
|
|
2830
|
+
/**
|
|
2831
|
+
* 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.
|
|
2832
|
+
*/
|
|
2833
|
+
'If-None-Match'?: string;
|
|
2834
|
+
/**
|
|
2835
|
+
* 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.
|
|
2836
|
+
*/
|
|
2837
|
+
'If-Modified-Since'?: string;
|
|
2838
|
+
};
|
|
2482
2839
|
path: {
|
|
2483
2840
|
/**
|
|
2484
2841
|
* The key of the property format to retrieve.
|
|
@@ -2498,6 +2855,10 @@ export type PropertyFormatsGetErrors = {
|
|
|
2498
2855
|
* Forbidden
|
|
2499
2856
|
*/
|
|
2500
2857
|
403: ProblemDetails;
|
|
2858
|
+
/**
|
|
2859
|
+
* Not Found
|
|
2860
|
+
*/
|
|
2861
|
+
404: ProblemDetails;
|
|
2501
2862
|
};
|
|
2502
2863
|
export type PropertyFormatsGetError = PropertyFormatsGetErrors[keyof PropertyFormatsGetErrors];
|
|
2503
2864
|
export type PropertyFormatsGetResponses = {
|
|
@@ -2512,9 +2873,8 @@ export type PropertyGroupsListData = {
|
|
|
2512
2873
|
path?: never;
|
|
2513
2874
|
query?: {
|
|
2514
2875
|
/**
|
|
2515
|
-
* Indicates which property groups sources
|
|
2516
|
-
* Use
|
|
2517
|
-
* Default to include groups without a specific sources.
|
|
2876
|
+
* Indicates which property groups sources should be listed.
|
|
2877
|
+
* Use 'DEFAULT' to include groups without a specific sources.
|
|
2518
2878
|
*/
|
|
2519
2879
|
sources?: Array<string>;
|
|
2520
2880
|
};
|
|
@@ -2538,7 +2898,7 @@ export type PropertyGroupsCreateData = {
|
|
|
2538
2898
|
/**
|
|
2539
2899
|
* The property group that should be created.
|
|
2540
2900
|
*/
|
|
2541
|
-
body:
|
|
2901
|
+
body: PropertyGroupWritable;
|
|
2542
2902
|
path?: never;
|
|
2543
2903
|
query?: never;
|
|
2544
2904
|
url: '/propertygroups';
|
|
@@ -2556,13 +2916,23 @@ export type PropertyGroupsCreateErrors = {
|
|
|
2556
2916
|
export type PropertyGroupsCreateError = PropertyGroupsCreateErrors[keyof PropertyGroupsCreateErrors];
|
|
2557
2917
|
export type PropertyGroupsCreateResponses = {
|
|
2558
2918
|
/**
|
|
2559
|
-
*
|
|
2919
|
+
* Created
|
|
2560
2920
|
*/
|
|
2561
|
-
|
|
2921
|
+
201: PropertyGroup;
|
|
2562
2922
|
};
|
|
2563
2923
|
export type PropertyGroupsCreateResponse = PropertyGroupsCreateResponses[keyof PropertyGroupsCreateResponses];
|
|
2564
2924
|
export type PropertyGroupsDeleteData = {
|
|
2565
2925
|
body?: never;
|
|
2926
|
+
headers?: {
|
|
2927
|
+
/**
|
|
2928
|
+
* 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.
|
|
2929
|
+
*/
|
|
2930
|
+
'If-Match'?: string;
|
|
2931
|
+
/**
|
|
2932
|
+
* 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.
|
|
2933
|
+
*/
|
|
2934
|
+
'If-Unmodified-Since'?: string;
|
|
2935
|
+
};
|
|
2566
2936
|
path: {
|
|
2567
2937
|
/**
|
|
2568
2938
|
* The key of the property group to delete.
|
|
@@ -2581,6 +2951,14 @@ export type PropertyGroupsDeleteErrors = {
|
|
|
2581
2951
|
* Forbidden
|
|
2582
2952
|
*/
|
|
2583
2953
|
403: ProblemDetails;
|
|
2954
|
+
/**
|
|
2955
|
+
* Not Found
|
|
2956
|
+
*/
|
|
2957
|
+
404: ProblemDetails;
|
|
2958
|
+
/**
|
|
2959
|
+
* Precondition Failed
|
|
2960
|
+
*/
|
|
2961
|
+
412: ProblemDetails;
|
|
2584
2962
|
};
|
|
2585
2963
|
export type PropertyGroupsDeleteError = PropertyGroupsDeleteErrors[keyof PropertyGroupsDeleteErrors];
|
|
2586
2964
|
export type PropertyGroupsDeleteResponses = {
|
|
@@ -2592,6 +2970,16 @@ export type PropertyGroupsDeleteResponses = {
|
|
|
2592
2970
|
export type PropertyGroupsDeleteResponse = PropertyGroupsDeleteResponses[keyof PropertyGroupsDeleteResponses];
|
|
2593
2971
|
export type PropertyGroupsGetData = {
|
|
2594
2972
|
body?: never;
|
|
2973
|
+
headers?: {
|
|
2974
|
+
/**
|
|
2975
|
+
* 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.
|
|
2976
|
+
*/
|
|
2977
|
+
'If-None-Match'?: string;
|
|
2978
|
+
/**
|
|
2979
|
+
* 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.
|
|
2980
|
+
*/
|
|
2981
|
+
'If-Modified-Since'?: string;
|
|
2982
|
+
};
|
|
2595
2983
|
path: {
|
|
2596
2984
|
/**
|
|
2597
2985
|
* The key of the property group to retrieve.
|
|
@@ -2606,6 +2994,10 @@ export type PropertyGroupsGetErrors = {
|
|
|
2606
2994
|
* Forbidden
|
|
2607
2995
|
*/
|
|
2608
2996
|
403: ProblemDetails;
|
|
2997
|
+
/**
|
|
2998
|
+
* Not Found
|
|
2999
|
+
*/
|
|
3000
|
+
404: ProblemDetails;
|
|
2609
3001
|
};
|
|
2610
3002
|
export type PropertyGroupsGetError = PropertyGroupsGetErrors[keyof PropertyGroupsGetErrors];
|
|
2611
3003
|
export type PropertyGroupsGetResponses = {
|
|
@@ -2617,9 +3009,19 @@ export type PropertyGroupsGetResponses = {
|
|
|
2617
3009
|
export type PropertyGroupsGetResponse = PropertyGroupsGetResponses[keyof PropertyGroupsGetResponses];
|
|
2618
3010
|
export type PropertyGroupsPatchData = {
|
|
2619
3011
|
/**
|
|
2620
|
-
* The values of the property group that should be
|
|
3012
|
+
* The values of the property group that should be patched formatted according to RFC7396.
|
|
2621
3013
|
*/
|
|
2622
|
-
body:
|
|
3014
|
+
body: PropertyGroupWritable;
|
|
3015
|
+
headers?: {
|
|
3016
|
+
/**
|
|
3017
|
+
* 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.
|
|
3018
|
+
*/
|
|
3019
|
+
'If-Match'?: string;
|
|
3020
|
+
/**
|
|
3021
|
+
* 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.
|
|
3022
|
+
*/
|
|
3023
|
+
'If-Unmodified-Since'?: string;
|
|
3024
|
+
};
|
|
2623
3025
|
path: {
|
|
2624
3026
|
/**
|
|
2625
3027
|
* The key of the property group to patch.
|
|
@@ -2638,47 +3040,20 @@ export type PropertyGroupsPatchErrors = {
|
|
|
2638
3040
|
* Forbidden
|
|
2639
3041
|
*/
|
|
2640
3042
|
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
3043
|
/**
|
|
2666
|
-
*
|
|
3044
|
+
* Not Found
|
|
2667
3045
|
*/
|
|
2668
|
-
|
|
3046
|
+
404: ProblemDetails;
|
|
2669
3047
|
/**
|
|
2670
|
-
*
|
|
3048
|
+
* Precondition Failed
|
|
2671
3049
|
*/
|
|
2672
|
-
|
|
3050
|
+
412: ProblemDetails;
|
|
2673
3051
|
};
|
|
2674
|
-
export type
|
|
2675
|
-
export type
|
|
3052
|
+
export type PropertyGroupsPatchError = PropertyGroupsPatchErrors[keyof PropertyGroupsPatchErrors];
|
|
3053
|
+
export type PropertyGroupsPatchResponses = {
|
|
2676
3054
|
/**
|
|
2677
3055
|
* OK
|
|
2678
3056
|
*/
|
|
2679
3057
|
200: PropertyGroup;
|
|
2680
3058
|
};
|
|
2681
|
-
export type
|
|
2682
|
-
export type ClientOptions = {
|
|
2683
|
-
baseUrl: `${string}://${string}/_cms/preview2` | (string & {});
|
|
2684
|
-
};
|
|
3059
|
+
export type PropertyGroupsPatchResponse = PropertyGroupsPatchResponses[keyof PropertyGroupsPatchResponses];
|