@remkoj/optimizely-cms-api 6.0.0-pre1 → 6.0.0-pre10

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