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

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 (198) hide show
  1. package/dist/api-client.d.ts +53 -10
  2. package/dist/api-client.js +142 -42
  3. package/dist/client/client/client.d.ts +2 -0
  4. package/dist/client/client/client.js +147 -0
  5. package/dist/client/client/index.d.ts +7 -0
  6. package/dist/client/client/index.js +14 -0
  7. package/dist/client/client/types.d.ts +119 -0
  8. package/dist/client/client/utils.d.ts +45 -0
  9. package/dist/client/client/utils.js +296 -0
  10. package/dist/client/client.gen.d.ts +12 -0
  11. package/dist/client/client.gen.js +9 -0
  12. package/dist/client/core/auth.d.ts +18 -0
  13. package/dist/client/core/auth.js +17 -0
  14. package/dist/client/core/bodySerializer.d.ts +17 -0
  15. package/dist/client/core/bodySerializer.js +56 -0
  16. package/dist/client/core/params.d.ts +23 -0
  17. package/dist/client/core/params.js +91 -0
  18. package/dist/client/core/pathSerializer.d.ts +33 -0
  19. package/dist/client/core/pathSerializer.js +122 -0
  20. package/dist/client/core/types.d.ts +73 -0
  21. package/dist/client/index.d.ts +4 -78
  22. package/dist/client/index.js +19 -46
  23. package/dist/client/sdk.gen.d.ts +256 -0
  24. package/dist/client/sdk.gen.js +638 -0
  25. package/dist/client/transformers.gen.d.ts +34 -0
  26. package/dist/client/transformers.gen.js +273 -0
  27. package/dist/client/types.gen.d.ts +2941 -0
  28. package/dist/client/types.gen.js +87 -0
  29. package/dist/client-config.d.ts +2 -0
  30. package/dist/client-config.js +27 -0
  31. package/dist/config.js +1 -2
  32. package/dist/getaccesstoken.js +1 -2
  33. package/dist/index.d.ts +3 -5
  34. package/dist/index.js +6 -8
  35. package/dist/version.json +2 -2
  36. package/package.json +18 -9
  37. package/dist/client/CmsIntegrationApiClient.d.ts +0 -22
  38. package/dist/client/CmsIntegrationApiClient.js +0 -34
  39. package/dist/client/core/ApiError.d.ts +0 -10
  40. package/dist/client/core/ApiError.js +0 -15
  41. package/dist/client/core/ApiRequestOptions.d.ts +0 -13
  42. package/dist/client/core/ApiResult.d.ts +0 -7
  43. package/dist/client/core/BaseHttpRequest.d.ts +0 -8
  44. package/dist/client/core/BaseHttpRequest.js +0 -9
  45. package/dist/client/core/CancelablePromise.d.ts +0 -20
  46. package/dist/client/core/CancelablePromise.js +0 -116
  47. package/dist/client/core/FetchHttpRequest.d.ts +0 -14
  48. package/dist/client/core/FetchHttpRequest.js +0 -20
  49. package/dist/client/core/OpenAPI.d.ts +0 -16
  50. package/dist/client/core/OpenAPI.js +0 -14
  51. package/dist/client/core/request.d.ts +0 -30
  52. package/dist/client/core/request.js +0 -294
  53. package/dist/client/models/BinaryProperty.d.ts +0 -8
  54. package/dist/client/models/BinaryProperty.js +0 -2
  55. package/dist/client/models/BooleanProperty.d.ts +0 -5
  56. package/dist/client/models/BooleanProperty.js +0 -2
  57. package/dist/client/models/Changeset.d.ts +0 -26
  58. package/dist/client/models/Changeset.js +0 -2
  59. package/dist/client/models/ChangesetItem.d.ts +0 -11
  60. package/dist/client/models/ChangesetItem.js +0 -2
  61. package/dist/client/models/ChangesetItemPage.d.ts +0 -19
  62. package/dist/client/models/ChangesetItemPage.js +0 -2
  63. package/dist/client/models/ChangesetPage.d.ts +0 -19
  64. package/dist/client/models/ChangesetPage.js +0 -2
  65. package/dist/client/models/ComponentListItem.d.ts +0 -10
  66. package/dist/client/models/ComponentListItem.js +0 -2
  67. package/dist/client/models/ComponentProperty.d.ts +0 -10
  68. package/dist/client/models/ComponentProperty.js +0 -2
  69. package/dist/client/models/CompositionBehavior.d.ts +0 -7
  70. package/dist/client/models/CompositionBehavior.js +0 -15
  71. package/dist/client/models/ContentBaseType.d.ts +0 -14
  72. package/dist/client/models/ContentBaseType.js +0 -22
  73. package/dist/client/models/ContentComponent.d.ts +0 -30
  74. package/dist/client/models/ContentComponent.js +0 -2
  75. package/dist/client/models/ContentItem.d.ts +0 -60
  76. package/dist/client/models/ContentItem.js +0 -2
  77. package/dist/client/models/ContentItemListWithContentTypes.d.ts +0 -27
  78. package/dist/client/models/ContentItemListWithContentTypes.js +0 -2
  79. package/dist/client/models/ContentItemPage.d.ts +0 -19
  80. package/dist/client/models/ContentItemPage.js +0 -2
  81. package/dist/client/models/ContentItemWithContentTypes.d.ts +0 -12
  82. package/dist/client/models/ContentItemWithContentTypes.js +0 -2
  83. package/dist/client/models/ContentListItem.d.ts +0 -14
  84. package/dist/client/models/ContentListItem.js +0 -2
  85. package/dist/client/models/ContentLocaleInfo.d.ts +0 -19
  86. package/dist/client/models/ContentLocaleInfo.js +0 -2
  87. package/dist/client/models/ContentMetadata.d.ts +0 -38
  88. package/dist/client/models/ContentMetadata.js +0 -2
  89. package/dist/client/models/ContentMetadataPage.d.ts +0 -19
  90. package/dist/client/models/ContentMetadataPage.js +0 -2
  91. package/dist/client/models/ContentProperty.d.ts +0 -14
  92. package/dist/client/models/ContentProperty.js +0 -2
  93. package/dist/client/models/ContentReference.d.ts +0 -17
  94. package/dist/client/models/ContentReference.js +0 -2
  95. package/dist/client/models/ContentReferenceListItem.d.ts +0 -14
  96. package/dist/client/models/ContentReferenceListItem.js +0 -2
  97. package/dist/client/models/ContentReferenceProperty.d.ts +0 -14
  98. package/dist/client/models/ContentReferenceProperty.js +0 -2
  99. package/dist/client/models/ContentType.d.ts +0 -84
  100. package/dist/client/models/ContentType.js +0 -2
  101. package/dist/client/models/ContentTypeFeature.d.ts +0 -10
  102. package/dist/client/models/ContentTypeFeature.js +0 -18
  103. package/dist/client/models/ContentTypePage.d.ts +0 -19
  104. package/dist/client/models/ContentTypePage.js +0 -2
  105. package/dist/client/models/ContentTypeProperty.d.ts +0 -47
  106. package/dist/client/models/ContentTypeProperty.js +0 -2
  107. package/dist/client/models/ContentTypeUsage.d.ts +0 -7
  108. package/dist/client/models/ContentTypeUsage.js +0 -15
  109. package/dist/client/models/CopyContentOptions.d.ts +0 -21
  110. package/dist/client/models/CopyContentOptions.js +0 -2
  111. package/dist/client/models/DateTimeListItem.d.ts +0 -14
  112. package/dist/client/models/DateTimeListItem.js +0 -2
  113. package/dist/client/models/DateTimeProperty.d.ts +0 -14
  114. package/dist/client/models/DateTimeProperty.js +0 -2
  115. package/dist/client/models/DisplaySetting.d.ts +0 -22
  116. package/dist/client/models/DisplaySetting.js +0 -2
  117. package/dist/client/models/DisplaySettingChoice.d.ts +0 -13
  118. package/dist/client/models/DisplaySettingChoice.js +0 -2
  119. package/dist/client/models/DisplayTemplate.d.ts +0 -49
  120. package/dist/client/models/DisplayTemplate.js +0 -2
  121. package/dist/client/models/DisplayTemplatePage.d.ts +0 -19
  122. package/dist/client/models/DisplayTemplatePage.js +0 -2
  123. package/dist/client/models/DoubleEnumerationSettings.d.ts +0 -10
  124. package/dist/client/models/DoubleEnumerationSettings.js +0 -2
  125. package/dist/client/models/DoubleEnumerationValue.d.ts +0 -13
  126. package/dist/client/models/DoubleEnumerationValue.js +0 -2
  127. package/dist/client/models/FloatListItem.d.ts +0 -16
  128. package/dist/client/models/FloatListItem.js +0 -2
  129. package/dist/client/models/FloatProperty.d.ts +0 -16
  130. package/dist/client/models/FloatProperty.js +0 -2
  131. package/dist/client/models/ImageDescriptor.d.ts +0 -17
  132. package/dist/client/models/ImageDescriptor.js +0 -2
  133. package/dist/client/models/IndexingType.d.ts +0 -8
  134. package/dist/client/models/IndexingType.js +0 -16
  135. package/dist/client/models/Int32EnumerationSettings.d.ts +0 -10
  136. package/dist/client/models/Int32EnumerationSettings.js +0 -2
  137. package/dist/client/models/Int32EnumerationValue.d.ts +0 -13
  138. package/dist/client/models/Int32EnumerationValue.js +0 -2
  139. package/dist/client/models/IntegerListItem.d.ts +0 -16
  140. package/dist/client/models/IntegerListItem.js +0 -2
  141. package/dist/client/models/IntegerProperty.d.ts +0 -16
  142. package/dist/client/models/IntegerProperty.js +0 -2
  143. package/dist/client/models/JsonStringProperty.d.ts +0 -5
  144. package/dist/client/models/JsonStringProperty.js +0 -2
  145. package/dist/client/models/ListProperty.d.ts +0 -26
  146. package/dist/client/models/ListProperty.js +0 -2
  147. package/dist/client/models/ListPropertyItem.d.ts +0 -11
  148. package/dist/client/models/ListPropertyItem.js +0 -2
  149. package/dist/client/models/LocaleStatus.d.ts +0 -7
  150. package/dist/client/models/LocaleStatus.js +0 -15
  151. package/dist/client/models/OauthToken.d.ts +0 -18
  152. package/dist/client/models/OauthToken.js +0 -2
  153. package/dist/client/models/OauthTokenError.d.ts +0 -13
  154. package/dist/client/models/OauthTokenError.js +0 -2
  155. package/dist/client/models/OauthTokenRequest.d.ts +0 -21
  156. package/dist/client/models/OauthTokenRequest.js +0 -2
  157. package/dist/client/models/ProblemDetails.d.ts +0 -1
  158. package/dist/client/models/ProblemDetails.js +0 -2
  159. package/dist/client/models/PropertyDataType.d.ts +0 -18
  160. package/dist/client/models/PropertyDataType.js +0 -26
  161. package/dist/client/models/PropertyFormat.d.ts +0 -37
  162. package/dist/client/models/PropertyFormat.js +0 -2
  163. package/dist/client/models/PropertyFormatPage.d.ts +0 -19
  164. package/dist/client/models/PropertyFormatPage.js +0 -2
  165. package/dist/client/models/PropertyGroup.d.ts +0 -21
  166. package/dist/client/models/PropertyGroup.js +0 -2
  167. package/dist/client/models/PropertyGroupPage.d.ts +0 -19
  168. package/dist/client/models/PropertyGroupPage.js +0 -2
  169. package/dist/client/models/StringEnumerationSettings.d.ts +0 -10
  170. package/dist/client/models/StringEnumerationSettings.js +0 -2
  171. package/dist/client/models/StringEnumerationValue.d.ts +0 -13
  172. package/dist/client/models/StringEnumerationValue.js +0 -2
  173. package/dist/client/models/StringListItem.d.ts +0 -20
  174. package/dist/client/models/StringListItem.js +0 -2
  175. package/dist/client/models/StringProperty.d.ts +0 -20
  176. package/dist/client/models/StringProperty.js +0 -2
  177. package/dist/client/models/UrlListItem.d.ts +0 -5
  178. package/dist/client/models/UrlListItem.js +0 -2
  179. package/dist/client/models/UrlProperty.d.ts +0 -5
  180. package/dist/client/models/UrlProperty.js +0 -2
  181. package/dist/client/models/VersionStatus.d.ts +0 -12
  182. package/dist/client/models/VersionStatus.js +0 -20
  183. package/dist/client/services/ChangesetsService.d.ts +0 -105
  184. package/dist/client/services/ChangesetsService.js +0 -239
  185. package/dist/client/services/ContentService.d.ts +0 -172
  186. package/dist/client/services/ContentService.js +0 -409
  187. package/dist/client/services/ContentTypesService.d.ts +0 -66
  188. package/dist/client/services/ContentTypesService.js +0 -149
  189. package/dist/client/services/DisplayTemplatesService.d.ts +0 -60
  190. package/dist/client/services/DisplayTemplatesService.js +0 -135
  191. package/dist/client/services/OauthService.d.ts +0 -17
  192. package/dist/client/services/OauthService.js +0 -28
  193. package/dist/client/services/PropertyFormatsService.d.ts +0 -26
  194. package/dist/client/services/PropertyFormatsService.js +0 -53
  195. package/dist/client/services/PropertyGroupsService.d.ts +0 -61
  196. package/dist/client/services/PropertyGroupsService.js +0 -135
  197. /package/dist/client/{core/ApiRequestOptions.js → client/types.js} +0 -0
  198. /package/dist/client/core/{ApiResult.js → types.js} +0 -0
@@ -0,0 +1,2941 @@
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;
16
+ };
17
+ /**
18
+ * Changesets are used to group work on several content items together.
19
+ */
20
+ export type Changeset = {
21
+ /**
22
+ * The unique key of this Changeset.
23
+ */
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;
37
+ /**
38
+ * The username of the user that created this changeset.
39
+ */
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 = {
47
+ /**
48
+ * The unique key of this Changeset.
49
+ */
50
+ key: string;
51
+ /**
52
+ * The source of this Changeset
53
+ */
54
+ source?: string;
55
+ /**
56
+ * The name of this Changeset.
57
+ */
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;
66
+ /**
67
+ * Gets/sets the changeset item category.
68
+ */
69
+ category?: string;
70
+ };
71
+ /**
72
+ * Items in an changeset that contains a link to the specific content version.
73
+ */
74
+ export type ChangesetItemWritable = {
75
+ /**
76
+ * Gets/sets the changeset item category.
77
+ */
78
+ category?: string;
79
+ };
80
+ export type ChangesetItemPage = {
81
+ /**
82
+ * The items in this paged collection.
83
+ */
84
+ readonly items?: Array<ChangesetItem>;
85
+ /**
86
+ * The zero-based index of the current page.
87
+ */
88
+ readonly pageIndex?: number;
89
+ /**
90
+ * The number of item in each page. Not necessarily the same as the number of items in this page.
91
+ */
92
+ readonly pageSize?: number;
93
+ /**
94
+ * The estimated total number of items in the collection. May be omitted if the total item count is unknown.
95
+ */
96
+ readonly totalItemCount?: number;
97
+ };
98
+ export type ChangesetItemPageWritable = {
99
+ [key: string]: never;
100
+ };
101
+ export type ChangesetPage = {
102
+ /**
103
+ * The items in this paged collection.
104
+ */
105
+ readonly items?: Array<Changeset>;
106
+ /**
107
+ * The zero-based index of the current page.
108
+ */
109
+ readonly pageIndex?: number;
110
+ /**
111
+ * The number of item in each page. Not necessarily the same as the number of items in this page.
112
+ */
113
+ readonly pageSize?: number;
114
+ /**
115
+ * The estimated total number of items in the collection. May be omitted if the total item count is unknown.
116
+ */
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
+ } & {
128
+ /**
129
+ * The key of the ContentType that this ComponentListItem can contain.
130
+ */
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
+ } & {
139
+ /**
140
+ * The key of the ContentType that this ComponentProperty can contain.
141
+ */
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 = {
177
+ /**
178
+ * The name of the content component. If Reference is set, the name is automatically set to the name of the referenced content.
179
+ */
180
+ name?: string;
181
+ /**
182
+ * An optional display option for the content component.
183
+ */
184
+ displayOption?: string;
185
+ /**
186
+ * An optional group for the personalizable component.
187
+ */
188
+ segmentationGroup?: string;
189
+ /**
190
+ * Specifies the settings for the content component.
191
+ */
192
+ segments?: Array<string>;
193
+ reference?: string;
194
+ /**
195
+ * The key of the content type that this is an embedded instance of.
196
+ */
197
+ contentType?: string;
198
+ /**
199
+ * Dictionary with all custom properties as specified by associated ContentType
200
+ */
201
+ content?: unknown;
202
+ };
203
+ /**
204
+ * Represents a version of a content item.
205
+ */
206
+ export type ContentItem = {
207
+ /**
208
+ * Properties as they are defined by corresponding component or content type.
209
+ */
210
+ properties?: {
211
+ [key: string]: unknown;
212
+ };
213
+ /**
214
+ * The key that identifies this content item.
215
+ */
216
+ readonly key: string;
217
+ /**
218
+ * The locale of this content instance.
219
+ */
220
+ readonly locale?: string;
221
+ /**
222
+ * The version identifier of this content instance.
223
+ */
224
+ readonly version?: string;
225
+ /**
226
+ * The content type of this content item.
227
+ */
228
+ readonly contentType?: string;
229
+ /**
230
+ * The display name of this content item.
231
+ */
232
+ displayName: string;
233
+ /**
234
+ * Indicates a time when this content was published or should be published.
235
+ */
236
+ published?: Date | null;
237
+ /**
238
+ * Indicates a time when this content expired or should expire.
239
+ */
240
+ expired?: Date | null;
241
+ status?: VersionStatus;
242
+ /**
243
+ * Indicates a time when this content version should transition to published status. Must only be assigned when Status is set to Scheduled.
244
+ */
245
+ delayPublishUntil?: Date | null;
246
+ /**
247
+ * The key that identifies the container content that this content item belongs to.
248
+ */
249
+ container?: string | null;
250
+ /**
251
+ * The key that identifies the owner of this content. Content that is own by another content is also known as an asset.
252
+ */
253
+ owner?: string | null;
254
+ /**
255
+ * A string that represents the segment that should be used when routing or generate routes to the current content instance.
256
+ */
257
+ routeSegment?: string | null;
258
+ lastModified?: Date;
259
+ /**
260
+ * The username of the user that made the latest modification to this content instance.
261
+ */
262
+ readonly lastModifiedBy?: string;
263
+ };
264
+ /**
265
+ * Represents a version of a content item.
266
+ */
267
+ export type ContentItemWritable = {
268
+ /**
269
+ * Properties as they are defined by corresponding component or content type.
270
+ */
271
+ properties?: {
272
+ [key: string]: unknown;
273
+ };
274
+ /**
275
+ * The display name of this content item.
276
+ */
277
+ displayName: string;
278
+ /**
279
+ * Indicates a time when this content was published or should be published.
280
+ */
281
+ published?: Date | null;
282
+ /**
283
+ * Indicates a time when this content expired or should expire.
284
+ */
285
+ expired?: Date | null;
286
+ status?: VersionStatus;
287
+ /**
288
+ * Indicates a time when this content version should transition to published status. Must only be assigned when Status is set to Scheduled.
289
+ */
290
+ delayPublishUntil?: Date | null;
291
+ /**
292
+ * The key that identifies the container content that this content item belongs to.
293
+ */
294
+ container?: string | null;
295
+ /**
296
+ * The key that identifies the owner of this content. Content that is own by another content is also known as an asset.
297
+ */
298
+ owner?: string | null;
299
+ /**
300
+ * A string that represents the segment that should be used when routing or generate routes to the current content instance.
301
+ */
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 = {
309
+ /**
310
+ * The content types that are used by the content items in the response.
311
+ */
312
+ readonly contentTypes?: Array<ContentType>;
313
+ /**
314
+ * The content items in this paged collection.
315
+ */
316
+ readonly items?: Array<ContentItem>;
317
+ /**
318
+ * The zero-based index of the current page.
319
+ */
320
+ readonly pageIndex?: number;
321
+ /**
322
+ * The number of item in each page. Not necessarily the same as the number of items in this page.
323
+ */
324
+ readonly pageSize?: number;
325
+ /**
326
+ * The estimated total number of items in the collection. May be omitted if the total item count is unknown.
327
+ */
328
+ readonly totalItemCount?: number;
329
+ };
330
+ /**
331
+ * The response object for Page`1 when used ContentType are included.
332
+ */
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;
349
+ /**
350
+ * The estimated total number of items in the collection. May be omitted if the total item count is unknown.
351
+ */
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 = {
361
+ /**
362
+ * The content types that are used by the content item in the response.
363
+ */
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
+ } & {
379
+ /**
380
+ * Specifies which content types and base types these property items are allowed to contain.
381
+ */
382
+ allowedTypes?: Array<string>;
383
+ /**
384
+ * Specifies which content types and base types these property items cannot contain.
385
+ */
386
+ restrictedTypes?: Array<string>;
387
+ };
388
+ /**
389
+ * Describes information about a locale instance of a content item.
390
+ */
391
+ export type ContentLocaleInfo = {
392
+ /**
393
+ * The display name of the content.
394
+ */
395
+ readonly displayName?: string;
396
+ /**
397
+ * The date and time when the first locale version for the content was created.
398
+ */
399
+ readonly created?: Date;
400
+ /**
401
+ * The username of the user that created this locale version of content.
402
+ */
403
+ readonly createdBy?: string;
404
+ status?: LocaleStatus;
405
+ };
406
+ /**
407
+ * Represents metadata about a content item.
408
+ */
409
+ export type ContentMetadata = {
410
+ /**
411
+ * The key that identifies this content.
412
+ */
413
+ key?: string;
414
+ /**
415
+ * The content type of this content.
416
+ */
417
+ contentType?: string;
418
+ /**
419
+ * Set of locales that this content has been created for.
420
+ */
421
+ readonly locales?: {
422
+ [key: string]: ContentLocaleInfo;
423
+ };
424
+ /**
425
+ * The key that identifies the container content that this content belongs to.
426
+ */
427
+ container?: string | null;
428
+ /**
429
+ * Indicates if the content contains any content items.
430
+ */
431
+ readonly hasItems?: boolean;
432
+ /**
433
+ * The key that identifies the owner of this content. Content that is own by another content is also known as an asset.
434
+ */
435
+ owner?: string | null;
436
+ /**
437
+ * A timestamp, which if provided, indicates when this content was deleted.
438
+ */
439
+ readonly deleted?: Date | null;
440
+ /**
441
+ * The username of the user that deleted this content.
442
+ */
443
+ readonly deletedBy?: string | null;
444
+ };
445
+ /**
446
+ * Represents metadata about a content item.
447
+ */
448
+ export type ContentMetadataWritable = {
449
+ /**
450
+ * The key that identifies this content.
451
+ */
452
+ key?: string;
453
+ /**
454
+ * The content type of this content.
455
+ */
456
+ contentType?: string;
457
+ /**
458
+ * The key that identifies the container content that this content belongs to.
459
+ */
460
+ container?: string | null;
461
+ /**
462
+ * The key that identifies the owner of this content. Content that is own by another content is also known as an asset.
463
+ */
464
+ owner?: string | null;
465
+ };
466
+ export type ContentMetadataPage = {
467
+ /**
468
+ * The items in this paged collection.
469
+ */
470
+ readonly items?: Array<ContentMetadata>;
471
+ /**
472
+ * The zero-based index of the current page.
473
+ */
474
+ readonly pageIndex?: number;
475
+ /**
476
+ * The number of item in each page. Not necessarily the same as the number of items in this page.
477
+ */
478
+ readonly pageSize?: number;
479
+ /**
480
+ * The estimated total number of items in the collection. May be omitted if the total item count is unknown.
481
+ */
482
+ readonly totalItemCount?: number;
483
+ };
484
+ export type ContentMetadataPageWritable = {
485
+ [key: string]: never;
486
+ };
487
+ /**
488
+ * Describes a property that can contain a content item.
489
+ */
490
+ export type ContentProperty = ContentTypeProperty & {
491
+ type: 'ContentProperty';
492
+ } & {
493
+ /**
494
+ * Specifies which content types and base types this property is allowed to contain.
495
+ */
496
+ allowedTypes?: Array<string>;
497
+ /**
498
+ * Specifies which content types and base types this property cannot contain.
499
+ */
500
+ restrictedTypes?: Array<string>;
501
+ };
502
+ /**
503
+ * A reference to a specific content instance.
504
+ */
505
+ export type ContentReference = {
506
+ /**
507
+ * The content key that identifies the content.
508
+ */
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
+ } & {
540
+ /**
541
+ * Specifies which content types and base types this property is allowed to reference.
542
+ */
543
+ allowedTypes?: Array<string>;
544
+ /**
545
+ * Specifies which content types and base types this property is restricted from referencing.
546
+ */
547
+ restrictedTypes?: Array<string>;
548
+ };
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>;
583
+ /**
584
+ * Provides a set of content types that can be created in container of this type
585
+ */
586
+ mayContainTypes?: Array<string>;
587
+ /**
588
+ * Provides a set of media file extensions that this content type can handle.
589
+ */
590
+ mediaFileExtensions?: Array<string>;
591
+ /**
592
+ * Provides a set of composition behaviors specifying how this content type can be used within compositions.
593
+ */
594
+ compositionBehaviors?: Array<CompositionBehavior>;
595
+ /**
596
+ * A timestamp indicating when this ContentType was first created.
597
+ */
598
+ readonly created?: Date;
599
+ /**
600
+ * Indicates the last time this content type was modified.
601
+ */
602
+ readonly lastModified?: Date;
603
+ /**
604
+ * The username of the user that made the latest modification to this ContentType.
605
+ */
606
+ readonly lastModifiedBy?: string;
607
+ /**
608
+ * Dictionary with all custom properties of this ContentType.
609
+ */
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
+ };
646
+ };
647
+ /**
648
+ * A writable implementation of an ContentType.
649
+ */
650
+ export type ContentTypeWritable = {
651
+ /**
652
+ * The key that identifies this ContentType.
653
+ */
654
+ key: string;
655
+ /**
656
+ * The display name of this ContentType.
657
+ */
658
+ displayName?: string;
659
+ /**
660
+ * A description of this ContentType.
661
+ */
662
+ description?: string;
663
+ baseType?: ContentBaseType;
664
+ /**
665
+ * An value that is used to when sorting ContentType instances.
666
+ */
667
+ sortOrder?: number;
668
+ /**
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.
671
+ */
672
+ features?: Array<ContentTypeFeature>;
673
+ /**
674
+ * Specifies how this ContentType can be used.
675
+ */
676
+ usage?: Array<ContentTypeUsage>;
677
+ /**
678
+ * Provides a set of content types that can be created in container of this type
679
+ */
680
+ mayContainTypes?: Array<string>;
681
+ /**
682
+ * Provides a set of media file extensions that this content type can handle.
683
+ */
684
+ mediaFileExtensions?: Array<string>;
685
+ /**
686
+ * Provides a set of composition behaviors specifying how this content type can be used within compositions.
687
+ */
688
+ compositionBehaviors?: Array<CompositionBehavior>;
689
+ /**
690
+ * Dictionary with all custom properties of this ContentType.
691
+ */
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";
742
+ };
743
+ export type ContentTypePage = {
744
+ /**
745
+ * The items in this paged collection.
746
+ */
747
+ readonly items?: Array<ContentType>;
748
+ /**
749
+ * The zero-based index of the current page.
750
+ */
751
+ readonly pageIndex?: number;
752
+ /**
753
+ * The number of item in each page. Not necessarily the same as the number of items in this page.
754
+ */
755
+ readonly pageSize?: number;
756
+ /**
757
+ * The estimated total number of items in the collection. May be omitted if the total item count is unknown.
758
+ */
759
+ readonly totalItemCount?: number;
760
+ };
761
+ export type ContentTypePageWritable = {
762
+ [key: string]: never;
763
+ };
764
+ /**
765
+ * Describes a property of a ContentType in the CMS.
766
+ */
767
+ export type ContentTypeProperty = {
768
+ type: PropertyDataType;
769
+ /**
770
+ * The key of the PropertyFormat that this ContentTypeProperty is an instance of.
771
+ */
772
+ format?: string | null;
773
+ /**
774
+ * The display name of this ContentTypeProperty.
775
+ */
776
+ displayName?: string;
777
+ /**
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.
788
+ */
789
+ required?: boolean;
790
+ /**
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.
793
+ */
794
+ group?: string;
795
+ /**
796
+ * An value that is used to when sorting ContentTypeProperty instances.
797
+ */
798
+ sortOrder?: number;
799
+ indexingType?: IndexingType;
800
+ /**
801
+ * Editor used for managing this property.
802
+ */
803
+ editor?: string | null;
804
+ /**
805
+ * Settings for the editor.
806
+ */
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";
823
+ };
824
+ /**
825
+ * Options for copying content.
826
+ */
827
+ export type CopyContentOptions = {
828
+ /**
829
+ * Indicates if deleted content could be used as source.
830
+ */
831
+ allowDeleted?: boolean;
832
+ /**
833
+ * Optional key of the container where the copied content should be placed.
834
+ */
835
+ container?: string | null;
836
+ /**
837
+ * Optional key of the owner where the copied content should be placed.
838
+ */
839
+ owner?: string | null;
840
+ /**
841
+ * Indicates if published versions of the content should keep their published status rather than being created as a draft version at the destination.
842
+ */
843
+ keepPublishedStatus?: boolean;
844
+ };
845
+ /**
846
+ * Describes a property list item that can contain a timestamp.
847
+ */
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;
855
+ /**
856
+ * The latest timestamp that list items of this type should be able to contain.
857
+ */
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
+ } & {
866
+ /**
867
+ * The earliest timestamp that properties of this type should be able to contain.
868
+ */
869
+ minimum?: Date | null;
870
+ /**
871
+ * The latest timestamp that properties of this type should be able to contain.
872
+ */
873
+ maximum?: Date | null;
874
+ };
875
+ /**
876
+ * Describes a setting for a display template.
877
+ */
878
+ export type DisplaySetting = {
879
+ /**
880
+ * The display name of this display setting.
881
+ */
882
+ displayName: string;
883
+ /**
884
+ * The suggested editor for this display setting.
885
+ */
886
+ editor?: string;
887
+ /**
888
+ * The sort order of this display setting within the template.
889
+ */
890
+ sortOrder?: number;
891
+ /**
892
+ * The available choices for this display setting.
893
+ */
894
+ choices?: {
895
+ [key: string]: DisplaySettingChoice;
896
+ };
897
+ };
898
+ /**
899
+ * Describes a setting for a display template.
900
+ */
901
+ export type DisplaySettingChoice = {
902
+ /**
903
+ * The display name of this display setting choice.
904
+ */
905
+ displayName: string;
906
+ /**
907
+ * The sort order of this choice within the setting.
908
+ */
909
+ sortOrder?: number;
910
+ };
911
+ /**
912
+ * Describes a display template that can be assigned to content.
913
+ */
914
+ export type DisplayTemplate = {
915
+ /**
916
+ * The key that identifies this display template.
917
+ */
918
+ readonly key: string;
919
+ /**
920
+ * The display name of this display template.
921
+ */
922
+ displayName: string;
923
+ /**
924
+ * The optional node type this display template is valid for.
925
+ */
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 = {
2251
+ /**
2252
+ * Bad Request
2253
+ */
2254
+ 400: ProblemDetails;
2255
+ /**
2256
+ * Forbidden
2257
+ */
2258
+ 403: ProblemDetails;
2259
+ };
2260
+ export type ContentDeleteVersionError = ContentDeleteVersionErrors[keyof ContentDeleteVersionErrors];
2261
+ export type ContentDeleteVersionResponses = {
2262
+ /**
2263
+ * OK
2264
+ */
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;
2276
+ };
2277
+ url: '/content/{key}/versions/{version}';
2278
+ };
2279
+ export type ContentGetVersionErrors = {
2280
+ /**
2281
+ * Forbidden
2282
+ */
2283
+ 403: ProblemDetails;
2284
+ };
2285
+ export type ContentGetVersionError = ContentGetVersionErrors[keyof ContentGetVersionErrors];
2286
+ export type ContentGetVersionResponses = {
2287
+ /**
2288
+ * OK
2289
+ */
2290
+ 200: ContentItemWithContentTypes;
2291
+ };
2292
+ export type ContentGetVersionResponse = ContentGetVersionResponses[keyof ContentGetVersionResponses];
2293
+ export type ContentPatchVersionData = {
2294
+ /**
2295
+ * The content information that should be updated.
2296
+ */
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}';
2319
+ };
2320
+ export type ContentPatchVersionErrors = {
2321
+ /**
2322
+ * Bad Request
2323
+ */
2324
+ 400: ProblemDetails;
2325
+ /**
2326
+ * Forbidden
2327
+ */
2328
+ 403: ProblemDetails;
2329
+ };
2330
+ export type ContentPatchVersionError = ContentPatchVersionErrors[keyof ContentPatchVersionErrors];
2331
+ export type ContentPatchVersionResponses = {
2332
+ /**
2333
+ * OK
2334
+ */
2335
+ 200: ContentItemWithContentTypes;
2336
+ };
2337
+ export type ContentPatchVersionResponse = ContentPatchVersionResponses[keyof ContentPatchVersionResponses];
2338
+ export type ContentTypesListData = {
2339
+ body?: never;
2340
+ path?: never;
2341
+ query?: {
2342
+ /**
2343
+ * Only include types that are available for creation under the provided container type
2344
+ */
2345
+ forContainerType?: string;
2346
+ /**
2347
+ * 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.
2350
+ */
2351
+ sources?: Array<string>;
2352
+ pageIndex?: number;
2353
+ pageSize?: number;
2354
+ };
2355
+ url: '/contenttypes';
2356
+ };
2357
+ export type ContentTypesListErrors = {
2358
+ /**
2359
+ * Forbidden
2360
+ */
2361
+ 403: ProblemDetails;
2362
+ };
2363
+ export type ContentTypesListError = ContentTypesListErrors[keyof ContentTypesListErrors];
2364
+ export type ContentTypesListResponses = {
2365
+ /**
2366
+ * OK
2367
+ */
2368
+ 200: ContentTypePage;
2369
+ };
2370
+ export type ContentTypesListResponse = ContentTypesListResponses[keyof ContentTypesListResponses];
2371
+ export type ContentTypesCreateData = {
2372
+ /**
2373
+ * The content type that should be created.
2374
+ */
2375
+ body: ContentTypeWritable;
2376
+ path?: never;
2377
+ query?: never;
2378
+ url: '/contenttypes';
2379
+ };
2380
+ export type ContentTypesCreateErrors = {
2381
+ /**
2382
+ * Bad Request
2383
+ */
2384
+ 400: ProblemDetails;
2385
+ /**
2386
+ * Forbidden
2387
+ */
2388
+ 403: ProblemDetails;
2389
+ };
2390
+ export type ContentTypesCreateError = ContentTypesCreateErrors[keyof ContentTypesCreateErrors];
2391
+ export type ContentTypesCreateResponses = {
2392
+ /**
2393
+ * OK
2394
+ */
2395
+ 200: ContentType;
2396
+ };
2397
+ export type ContentTypesCreateResponse = ContentTypesCreateResponses[keyof ContentTypesCreateResponses];
2398
+ export type ContentTypesDeleteData = {
2399
+ body?: never;
2400
+ path: {
2401
+ /**
2402
+ * The key of the content type to delete.
2403
+ */
2404
+ key: string;
2405
+ };
2406
+ query?: never;
2407
+ url: '/contenttypes/{key}';
2408
+ };
2409
+ export type ContentTypesDeleteErrors = {
2410
+ /**
2411
+ * Bad Request
2412
+ */
2413
+ 400: ProblemDetails;
2414
+ /**
2415
+ * Forbidden
2416
+ */
2417
+ 403: ProblemDetails;
2418
+ };
2419
+ export type ContentTypesDeleteError = ContentTypesDeleteErrors[keyof ContentTypesDeleteErrors];
2420
+ export type ContentTypesDeleteResponses = {
2421
+ /**
2422
+ * OK
2423
+ */
2424
+ 200: ContentType;
2425
+ };
2426
+ export type ContentTypesDeleteResponse = ContentTypesDeleteResponses[keyof ContentTypesDeleteResponses];
2427
+ export type ContentTypesGetData = {
2428
+ body?: never;
2429
+ path: {
2430
+ /**
2431
+ * The key of the content type to retrieve.
2432
+ */
2433
+ key: string;
2434
+ };
2435
+ query?: never;
2436
+ url: '/contenttypes/{key}';
2437
+ };
2438
+ export type ContentTypesGetErrors = {
2439
+ /**
2440
+ * Forbidden
2441
+ */
2442
+ 403: ProblemDetails;
2443
+ };
2444
+ export type ContentTypesGetError = ContentTypesGetErrors[keyof ContentTypesGetErrors];
2445
+ export type ContentTypesGetResponses = {
2446
+ /**
2447
+ * OK
2448
+ */
2449
+ 200: ContentType;
2450
+ };
2451
+ export type ContentTypesGetResponse = ContentTypesGetResponses[keyof ContentTypesGetResponses];
2452
+ export type ContentTypesPatchData = {
2453
+ /**
2454
+ * The values of the content type that should be updated.
2455
+ */
2456
+ body: ContentTypeWritable;
2457
+ path: {
2458
+ /**
2459
+ * The key of the content type to patch.
2460
+ */
2461
+ key: string;
2462
+ };
2463
+ query?: {
2464
+ /**
2465
+ * Update the content type even though the changes might result in data loss.
2466
+ */
2467
+ ignoreDataLossWarnings?: boolean;
2468
+ };
2469
+ url: '/contenttypes/{key}';
2470
+ };
2471
+ export type ContentTypesPatchErrors = {
2472
+ /**
2473
+ * Bad Request
2474
+ */
2475
+ 400: ProblemDetails;
2476
+ /**
2477
+ * Forbidden
2478
+ */
2479
+ 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
+ /**
2510
+ * Bad Request
2511
+ */
2512
+ 400: ProblemDetails;
2513
+ /**
2514
+ * Forbidden
2515
+ */
2516
+ 403: ProblemDetails;
2517
+ };
2518
+ export type ContentTypesPutError = ContentTypesPutErrors[keyof ContentTypesPutErrors];
2519
+ export type ContentTypesPutResponses = {
2520
+ /**
2521
+ * OK
2522
+ */
2523
+ 200: ContentType;
2524
+ };
2525
+ export type ContentTypesPutResponse = ContentTypesPutResponses[keyof ContentTypesPutResponses];
2526
+ export type DisplayTemplatesListData = {
2527
+ body?: never;
2528
+ path?: never;
2529
+ query?: {
2530
+ pageIndex?: number;
2531
+ pageSize?: number;
2532
+ };
2533
+ url: '/displaytemplates';
2534
+ };
2535
+ export type DisplayTemplatesListErrors = {
2536
+ /**
2537
+ * Forbidden
2538
+ */
2539
+ 403: ProblemDetails;
2540
+ };
2541
+ export type DisplayTemplatesListError = DisplayTemplatesListErrors[keyof DisplayTemplatesListErrors];
2542
+ export type DisplayTemplatesListResponses = {
2543
+ /**
2544
+ * OK
2545
+ */
2546
+ 200: DisplayTemplatePage;
2547
+ };
2548
+ export type DisplayTemplatesListResponse = DisplayTemplatesListResponses[keyof DisplayTemplatesListResponses];
2549
+ export type DisplayTemplatesCreateData = {
2550
+ /**
2551
+ * The display template that should be created.
2552
+ */
2553
+ body: DisplayTemplateWritable;
2554
+ path?: never;
2555
+ query?: never;
2556
+ url: '/displaytemplates';
2557
+ };
2558
+ export type DisplayTemplatesCreateErrors = {
2559
+ /**
2560
+ * Bad Request
2561
+ */
2562
+ 400: ProblemDetails;
2563
+ /**
2564
+ * Forbidden
2565
+ */
2566
+ 403: ProblemDetails;
2567
+ };
2568
+ export type DisplayTemplatesCreateError = DisplayTemplatesCreateErrors[keyof DisplayTemplatesCreateErrors];
2569
+ export type DisplayTemplatesCreateResponses = {
2570
+ /**
2571
+ * OK
2572
+ */
2573
+ 200: DisplayTemplate;
2574
+ };
2575
+ export type DisplayTemplatesCreateResponse = DisplayTemplatesCreateResponses[keyof DisplayTemplatesCreateResponses];
2576
+ export type DisplayTemplatesDeleteData = {
2577
+ body?: never;
2578
+ path: {
2579
+ /**
2580
+ * The key of the display template to delete.
2581
+ */
2582
+ key: string;
2583
+ };
2584
+ query?: never;
2585
+ url: '/displaytemplates/{key}';
2586
+ };
2587
+ export type DisplayTemplatesDeleteErrors = {
2588
+ /**
2589
+ * Bad Request
2590
+ */
2591
+ 400: ProblemDetails;
2592
+ /**
2593
+ * Forbidden
2594
+ */
2595
+ 403: ProblemDetails;
2596
+ };
2597
+ export type DisplayTemplatesDeleteError = DisplayTemplatesDeleteErrors[keyof DisplayTemplatesDeleteErrors];
2598
+ export type DisplayTemplatesDeleteResponses = {
2599
+ /**
2600
+ * OK
2601
+ */
2602
+ 200: DisplayTemplate;
2603
+ };
2604
+ export type DisplayTemplatesDeleteResponse = DisplayTemplatesDeleteResponses[keyof DisplayTemplatesDeleteResponses];
2605
+ export type DisplayTemplatesGetData = {
2606
+ body?: never;
2607
+ path: {
2608
+ /**
2609
+ * The key of the display template to retrieve.
2610
+ */
2611
+ key: string;
2612
+ };
2613
+ query?: never;
2614
+ url: '/displaytemplates/{key}';
2615
+ };
2616
+ export type DisplayTemplatesGetErrors = {
2617
+ /**
2618
+ * Forbidden
2619
+ */
2620
+ 403: ProblemDetails;
2621
+ };
2622
+ export type DisplayTemplatesGetError = DisplayTemplatesGetErrors[keyof DisplayTemplatesGetErrors];
2623
+ export type DisplayTemplatesGetResponses = {
2624
+ /**
2625
+ * OK
2626
+ */
2627
+ 200: DisplayTemplate;
2628
+ };
2629
+ export type DisplayTemplatesGetResponse = DisplayTemplatesGetResponses[keyof DisplayTemplatesGetResponses];
2630
+ export type DisplayTemplatesPatchData = {
2631
+ /**
2632
+ * The values of the display template that should be updated.
2633
+ */
2634
+ body: DisplayTemplateWritable;
2635
+ path: {
2636
+ /**
2637
+ * The key of the display template to patch.
2638
+ */
2639
+ key: string;
2640
+ };
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
+ path: {
2668
+ /**
2669
+ * The key of the display template to update or create.
2670
+ */
2671
+ key: string;
2672
+ };
2673
+ query?: never;
2674
+ url: '/displaytemplates/{key}';
2675
+ };
2676
+ export type DisplayTemplatesPutErrors = {
2677
+ /**
2678
+ * Bad Request
2679
+ */
2680
+ 400: ProblemDetails;
2681
+ /**
2682
+ * Forbidden
2683
+ */
2684
+ 403: ProblemDetails;
2685
+ };
2686
+ export type DisplayTemplatesPutError = DisplayTemplatesPutErrors[keyof DisplayTemplatesPutErrors];
2687
+ export type DisplayTemplatesPutResponses = {
2688
+ /**
2689
+ * OK
2690
+ */
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 = {
2701
+ /**
2702
+ * Bad Request
2703
+ */
2704
+ 400: OauthTokenError;
2705
+ };
2706
+ export type OauthTokenError2 = OauthTokenErrors[keyof OauthTokenErrors];
2707
+ export type OauthTokenResponses = {
2708
+ /**
2709
+ * OK
2710
+ */
2711
+ 200: OauthToken;
2712
+ };
2713
+ export type OauthTokenResponse = OauthTokenResponses[keyof OauthTokenResponses];
2714
+ export type PropertyFormatsListData = {
2715
+ body?: never;
2716
+ path?: never;
2717
+ query?: {
2718
+ pageIndex?: number;
2719
+ pageSize?: number;
2720
+ };
2721
+ url: '/propertyformats';
2722
+ };
2723
+ export type PropertyFormatsListErrors = {
2724
+ /**
2725
+ * Forbidden
2726
+ */
2727
+ 403: ProblemDetails;
2728
+ };
2729
+ export type PropertyFormatsListError = PropertyFormatsListErrors[keyof PropertyFormatsListErrors];
2730
+ export type PropertyFormatsListResponses = {
2731
+ /**
2732
+ * OK
2733
+ */
2734
+ 200: PropertyFormatPage;
2735
+ };
2736
+ export type PropertyFormatsListResponse = PropertyFormatsListResponses[keyof PropertyFormatsListResponses];
2737
+ export type PropertyFormatsGetData = {
2738
+ body?: never;
2739
+ path: {
2740
+ /**
2741
+ * The key of the property format to retrieve.
2742
+ */
2743
+ key: string;
2744
+ };
2745
+ query?: {
2746
+ /**
2747
+ * Indicates that a deleted property format may be returned.
2748
+ */
2749
+ allowDeleted?: boolean;
2750
+ };
2751
+ url: '/propertyformats/{key}';
2752
+ };
2753
+ export type PropertyFormatsGetErrors = {
2754
+ /**
2755
+ * Forbidden
2756
+ */
2757
+ 403: ProblemDetails;
2758
+ };
2759
+ export type PropertyFormatsGetError = PropertyFormatsGetErrors[keyof PropertyFormatsGetErrors];
2760
+ export type PropertyFormatsGetResponses = {
2761
+ /**
2762
+ * OK
2763
+ */
2764
+ 200: PropertyFormat;
2765
+ };
2766
+ export type PropertyFormatsGetResponse = PropertyFormatsGetResponses[keyof PropertyFormatsGetResponses];
2767
+ export type PropertyGroupsListData = {
2768
+ body?: never;
2769
+ path?: never;
2770
+ query?: {
2771
+ /**
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.
2775
+ */
2776
+ sources?: Array<string>;
2777
+ };
2778
+ url: '/propertygroups';
2779
+ };
2780
+ export type PropertyGroupsListErrors = {
2781
+ /**
2782
+ * Forbidden
2783
+ */
2784
+ 403: ProblemDetails;
2785
+ };
2786
+ export type PropertyGroupsListError = PropertyGroupsListErrors[keyof PropertyGroupsListErrors];
2787
+ export type PropertyGroupsListResponses = {
2788
+ /**
2789
+ * OK
2790
+ */
2791
+ 200: PropertyGroupPage;
2792
+ };
2793
+ export type PropertyGroupsListResponse = PropertyGroupsListResponses[keyof PropertyGroupsListResponses];
2794
+ export type PropertyGroupsCreateData = {
2795
+ /**
2796
+ * The property group that should be created.
2797
+ */
2798
+ body: PropertyGroupWritable;
2799
+ path?: never;
2800
+ query?: never;
2801
+ url: '/propertygroups';
2802
+ };
2803
+ export type PropertyGroupsCreateErrors = {
2804
+ /**
2805
+ * Bad Request
2806
+ */
2807
+ 400: ProblemDetails;
2808
+ /**
2809
+ * Forbidden
2810
+ */
2811
+ 403: ProblemDetails;
2812
+ };
2813
+ export type PropertyGroupsCreateError = PropertyGroupsCreateErrors[keyof PropertyGroupsCreateErrors];
2814
+ export type PropertyGroupsCreateResponses = {
2815
+ /**
2816
+ * OK
2817
+ */
2818
+ 200: PropertyGroup;
2819
+ };
2820
+ export type PropertyGroupsCreateResponse = PropertyGroupsCreateResponses[keyof PropertyGroupsCreateResponses];
2821
+ export type PropertyGroupsDeleteData = {
2822
+ body?: never;
2823
+ path: {
2824
+ /**
2825
+ * The key of the property group to delete.
2826
+ */
2827
+ key: string;
2828
+ };
2829
+ query?: never;
2830
+ url: '/propertygroups/{key}';
2831
+ };
2832
+ export type PropertyGroupsDeleteErrors = {
2833
+ /**
2834
+ * Bad Request
2835
+ */
2836
+ 400: ProblemDetails;
2837
+ /**
2838
+ * Forbidden
2839
+ */
2840
+ 403: ProblemDetails;
2841
+ };
2842
+ export type PropertyGroupsDeleteError = PropertyGroupsDeleteErrors[keyof PropertyGroupsDeleteErrors];
2843
+ export type PropertyGroupsDeleteResponses = {
2844
+ /**
2845
+ * OK
2846
+ */
2847
+ 200: PropertyGroup;
2848
+ };
2849
+ export type PropertyGroupsDeleteResponse = PropertyGroupsDeleteResponses[keyof PropertyGroupsDeleteResponses];
2850
+ export type PropertyGroupsGetData = {
2851
+ body?: never;
2852
+ path: {
2853
+ /**
2854
+ * The key of the property group to retrieve.
2855
+ */
2856
+ key: string;
2857
+ };
2858
+ query?: never;
2859
+ url: '/propertygroups/{key}';
2860
+ };
2861
+ export type PropertyGroupsGetErrors = {
2862
+ /**
2863
+ * Forbidden
2864
+ */
2865
+ 403: ProblemDetails;
2866
+ };
2867
+ export type PropertyGroupsGetError = PropertyGroupsGetErrors[keyof PropertyGroupsGetErrors];
2868
+ export type PropertyGroupsGetResponses = {
2869
+ /**
2870
+ * OK
2871
+ */
2872
+ 200: PropertyGroup;
2873
+ };
2874
+ export type PropertyGroupsGetResponse = PropertyGroupsGetResponses[keyof PropertyGroupsGetResponses];
2875
+ export type PropertyGroupsPatchData = {
2876
+ /**
2877
+ * The values of the property group that should be updated.
2878
+ */
2879
+ body: PropertyGroupWritable;
2880
+ path: {
2881
+ /**
2882
+ * The key of the property group to patch.
2883
+ */
2884
+ key: string;
2885
+ };
2886
+ query?: never;
2887
+ url: '/propertygroups/{key}';
2888
+ };
2889
+ export type PropertyGroupsPatchErrors = {
2890
+ /**
2891
+ * Bad Request
2892
+ */
2893
+ 400: ProblemDetails;
2894
+ /**
2895
+ * Forbidden
2896
+ */
2897
+ 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
+ /**
2923
+ * Bad Request
2924
+ */
2925
+ 400: ProblemDetails;
2926
+ /**
2927
+ * Forbidden
2928
+ */
2929
+ 403: ProblemDetails;
2930
+ };
2931
+ export type PropertyGroupsPutError = PropertyGroupsPutErrors[keyof PropertyGroupsPutErrors];
2932
+ export type PropertyGroupsPutResponses = {
2933
+ /**
2934
+ * OK
2935
+ */
2936
+ 200: PropertyGroup;
2937
+ };
2938
+ export type PropertyGroupsPutResponse = PropertyGroupsPutResponses[keyof PropertyGroupsPutResponses];
2939
+ export type ClientOptions = {
2940
+ baseUrl: `${string}://${string}/_cms/preview2` | (string & {});
2941
+ };