@remkoj/optimizely-cms-api 2.0.0-pre3 → 2.0.0-pre5

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 (111) hide show
  1. package/dist/api-client.d.ts +35 -0
  2. package/dist/api-client.js +67 -0
  3. package/dist/client/CmsIntegrationApiClient.d.ts +24 -22
  4. package/dist/client/CmsIntegrationApiClient.js +2 -0
  5. package/dist/client/core/ApiError.d.ts +10 -10
  6. package/dist/client/core/ApiRequestOptions.d.ts +13 -13
  7. package/dist/client/core/ApiResult.d.ts +7 -7
  8. package/dist/client/core/BaseHttpRequest.d.ts +8 -8
  9. package/dist/client/core/CancelablePromise.d.ts +20 -20
  10. package/dist/client/core/FetchHttpRequest.d.ts +14 -14
  11. package/dist/client/core/OpenAPI.d.ts +16 -16
  12. package/dist/client/core/request.d.ts +30 -30
  13. package/dist/client/index.d.ts +81 -76
  14. package/dist/client/index.js +3 -1
  15. package/dist/client/models/BinaryProperty.d.ts +8 -8
  16. package/dist/client/models/BooleanProperty.d.ts +5 -5
  17. package/dist/client/models/Changeset.d.ts +26 -26
  18. package/dist/client/models/ChangesetItem.d.ts +11 -11
  19. package/dist/client/models/ChangesetItemPage.d.ts +19 -19
  20. package/dist/client/models/ChangesetPage.d.ts +19 -19
  21. package/dist/client/models/ComponentListItem.d.ts +7 -10
  22. package/dist/client/models/ComponentProperty.d.ts +7 -10
  23. package/dist/client/models/ContentBaseType.d.ts +11 -11
  24. package/dist/client/models/ContentComponent.d.ts +34 -34
  25. package/dist/client/models/ContentItem.d.ts +60 -60
  26. package/dist/client/models/ContentItemListWithContentTypes.d.ts +27 -27
  27. package/dist/client/models/ContentItemPage.d.ts +19 -19
  28. package/dist/client/models/ContentItemWithContentTypes.d.ts +12 -12
  29. package/dist/client/models/ContentListItem.d.ts +8 -14
  30. package/dist/client/models/ContentLocaleInfo.d.ts +19 -11
  31. package/dist/client/models/ContentMetadata.d.ts +38 -46
  32. package/dist/client/models/ContentMetadataPage.d.ts +19 -19
  33. package/dist/client/models/ContentProperty.d.ts +8 -14
  34. package/dist/client/models/ContentReference.d.ts +17 -17
  35. package/dist/client/models/ContentReferenceListItem.d.ts +8 -14
  36. package/dist/client/models/ContentReferenceProperty.d.ts +8 -14
  37. package/dist/client/models/ContentType.d.ts +79 -79
  38. package/dist/client/models/ContentTypeFeature.d.ts +10 -10
  39. package/dist/client/models/ContentTypePage.d.ts +19 -19
  40. package/dist/client/models/ContentTypeProperty.d.ts +47 -47
  41. package/dist/client/models/ContentTypeUsage.d.ts +7 -7
  42. package/dist/client/models/CopyContentOptions.d.ts +21 -21
  43. package/dist/client/models/DateTimeListItem.d.ts +8 -14
  44. package/dist/client/models/DateTimeProperty.d.ts +8 -14
  45. package/dist/client/models/DisplaySetting.d.ts +22 -0
  46. package/dist/client/models/DisplaySetting.js +2 -0
  47. package/dist/client/models/DisplaySettingChoice.d.ts +13 -0
  48. package/dist/client/models/DisplaySettingChoice.js +2 -0
  49. package/dist/client/models/DisplayTemplate.d.ts +49 -0
  50. package/dist/client/models/DisplayTemplate.js +2 -0
  51. package/dist/client/models/DisplayTemplatePage.d.ts +19 -0
  52. package/dist/client/models/DisplayTemplatePage.js +2 -0
  53. package/dist/client/models/DoubleEnumerationSettings.d.ts +9 -9
  54. package/dist/client/models/FloatListItem.d.ts +10 -16
  55. package/dist/client/models/FloatProperty.d.ts +10 -16
  56. package/dist/client/models/ImageDescriptor.d.ts +17 -17
  57. package/dist/client/models/ImportPackageMessage.d.ts +17 -17
  58. package/dist/client/models/ImportPackageResult.d.ts +22 -22
  59. package/dist/client/models/IndexingType.d.ts +8 -8
  60. package/dist/client/models/Int32EnumerationSettings.d.ts +9 -9
  61. package/dist/client/models/IntegerListItem.d.ts +10 -16
  62. package/dist/client/models/IntegerProperty.d.ts +10 -16
  63. package/dist/client/models/JsonStringProperty.d.ts +5 -5
  64. package/dist/client/models/ListProperty.d.ts +26 -26
  65. package/dist/client/models/ListPropertyItem.d.ts +11 -11
  66. package/dist/client/models/LocaleStatus.d.ts +7 -7
  67. package/dist/client/models/Manifest.d.ts +24 -19
  68. package/dist/client/models/OauthToken.d.ts +18 -18
  69. package/dist/client/models/OauthTokenError.d.ts +13 -13
  70. package/dist/client/models/OauthTokenRequest.d.ts +21 -21
  71. package/dist/client/models/PackageJob.d.ts +28 -28
  72. package/dist/client/models/PackageJobMessage.d.ts +17 -17
  73. package/dist/client/models/PackageJobStatus.d.ts +4 -4
  74. package/dist/client/models/ProblemDetails.d.ts +1 -1
  75. package/dist/client/models/PropertyDataType.d.ts +18 -18
  76. package/dist/client/models/PropertyFormat.d.ts +34 -34
  77. package/dist/client/models/PropertyFormatPage.d.ts +19 -19
  78. package/dist/client/models/PropertyGroup.d.ts +21 -21
  79. package/dist/client/models/PropertyGroupPage.d.ts +19 -19
  80. package/dist/client/models/StringEnumerationSettings.d.ts +9 -9
  81. package/dist/client/models/StringListItem.d.ts +11 -14
  82. package/dist/client/models/StringProperty.d.ts +11 -14
  83. package/dist/client/models/UrlListItem.d.ts +5 -5
  84. package/dist/client/models/UrlProperty.d.ts +5 -5
  85. package/dist/client/models/VersionStatus.d.ts +12 -12
  86. package/dist/client/services/ChangesetsService.d.ts +105 -105
  87. package/dist/client/services/ChangesetsService.js +10 -10
  88. package/dist/client/services/ContentService.d.ts +172 -172
  89. package/dist/client/services/ContentService.js +14 -14
  90. package/dist/client/services/ContentTypesService.d.ts +66 -66
  91. package/dist/client/services/ContentTypesService.js +6 -6
  92. package/dist/client/services/DisplayTemplatesService.d.ts +60 -0
  93. package/dist/client/services/DisplayTemplatesService.js +135 -0
  94. package/dist/client/services/OauthService.d.ts +17 -17
  95. package/dist/client/services/OauthService.js +1 -1
  96. package/dist/client/services/PackagesService.d.ts +41 -41
  97. package/dist/client/services/PackagesService.js +3 -3
  98. package/dist/client/services/PropertyFormatsService.d.ts +26 -26
  99. package/dist/client/services/PropertyFormatsService.js +2 -2
  100. package/dist/client/services/PropertyGroupsService.d.ts +61 -61
  101. package/dist/client/services/PropertyGroupsService.js +6 -6
  102. package/dist/config.d.ts +8 -7
  103. package/dist/config.js +2 -1
  104. package/dist/getaccesstoken.d.ts +3 -0
  105. package/dist/getaccesstoken.js +43 -0
  106. package/dist/index.d.ts +16 -15
  107. package/dist/index.js +8 -51
  108. package/dist/types.d.ts +8 -0
  109. package/dist/types.js +2 -0
  110. package/dist/version.json +5 -0
  111. package/package.json +11 -7
@@ -1,105 +1,105 @@
1
- import type { Changeset } from '../models/Changeset';
2
- import type { ChangesetItem } from '../models/ChangesetItem';
3
- import type { ChangesetItemPage } from '../models/ChangesetItemPage';
4
- import type { ChangesetPage } from '../models/ChangesetPage';
5
- import type { CancelablePromise } from '../core/CancelablePromise';
6
- import type { BaseHttpRequest } from '../core/BaseHttpRequest';
7
- export declare class ChangesetsService {
8
- readonly httpRequest: BaseHttpRequest;
9
- constructor(httpRequest: BaseHttpRequest);
10
- /**
11
- * List changeset
12
- * Lists all changeset using the provided options.
13
- * @param pageIndex
14
- * @param pageSize
15
- * @returns ChangesetPage Success
16
- * @throws ApiError
17
- */
18
- changesetsList(pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetPage>;
19
- /**
20
- * Create changeset
21
- * Creates a new changeset.
22
- * @param requestBody The changeset that should be created.
23
- * @returns Changeset Success
24
- * @throws ApiError
25
- */
26
- changesetsCreate(requestBody: Changeset): CancelablePromise<Changeset>;
27
- /**
28
- * Get changeset
29
- * Gets the changeset with the provided key.
30
- * @param key The key of the changeset to retrieve.
31
- * @returns Changeset Success
32
- * @throws ApiError
33
- */
34
- changesetsGet(key: string): CancelablePromise<Changeset>;
35
- /**
36
- * Delete changeset
37
- * Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned.
38
- * @param key The key of the changeset to delete.
39
- * @returns Changeset Success
40
- * @throws ApiError
41
- */
42
- changesetsDelete(key: string): CancelablePromise<Changeset>;
43
- /**
44
- * Create or replace changeset
45
- * Creates or replaces a changeset. If a changeset with the provided key exist it is replaced.
46
- * Otherwise a new changeset is created.
47
- * @param key The key of the changeset to update or create.
48
- * @param requestBody The values of the created or replaced changeset.
49
- * @returns Changeset Success
50
- * @throws ApiError
51
- */
52
- changesetsPut(key: string, requestBody: Changeset): CancelablePromise<Changeset>;
53
- /**
54
- * Get changeset item
55
- * Gets the changeset item for the specified content reference.
56
- * @param changeset The changeset key
57
- * @param key The content key
58
- * @param version The content version
59
- * @returns ChangesetItem Success
60
- * @throws ApiError
61
- */
62
- changesetsGetItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
63
- /**
64
- * Delete changeset item
65
- * Deletes the specified changeset item from the changeset.
66
- * @param changeset The changeset key
67
- * @param key The content key
68
- * @param version The content version
69
- * @returns ChangesetItem Success
70
- * @throws ApiError
71
- */
72
- changesetsDeleteItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
73
- /**
74
- * List changeset items
75
- * Lists the available changeset items for the specified changeset using
76
- * the provided options.
77
- * @param changeset The changeset key
78
- * @param pageIndex
79
- * @param pageSize
80
- * @returns ChangesetItemPage Success
81
- * @throws ApiError
82
- */
83
- changesetsListItems(changeset: string, pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetItemPage>;
84
- /**
85
- * Create changeset item
86
- * Creates the given changeset item.
87
- * @param changeset The changeset key
88
- * @param requestBody The changeset item
89
- * @returns ChangesetItem Success
90
- * @throws ApiError
91
- */
92
- changesetsCreateItem(changeset: string, requestBody: ChangesetItem): CancelablePromise<ChangesetItem>;
93
- /**
94
- * Update changeset item
95
- * Updates the given changeset item.
96
- * @param changeset The changeset key
97
- * @param contentKey The content key
98
- * @param contentVersion The content version
99
- * @param requestBody The changeset item
100
- * @param allowCreate Indicates if a new changeset item should be created if it does not exist
101
- * @returns ChangesetItem Success
102
- * @throws ApiError
103
- */
104
- changesetsUpdateItem(changeset: string, contentKey: string, contentVersion: string, requestBody: ChangesetItem, allowCreate?: boolean): CancelablePromise<ChangesetItem>;
105
- }
1
+ import type { Changeset } from '../models/Changeset';
2
+ import type { ChangesetItem } from '../models/ChangesetItem';
3
+ import type { ChangesetItemPage } from '../models/ChangesetItemPage';
4
+ import type { ChangesetPage } from '../models/ChangesetPage';
5
+ import type { CancelablePromise } from '../core/CancelablePromise';
6
+ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
7
+ export declare class ChangesetsService {
8
+ readonly httpRequest: BaseHttpRequest;
9
+ constructor(httpRequest: BaseHttpRequest);
10
+ /**
11
+ * List changeset
12
+ * Lists all changeset using the provided options.
13
+ * @param pageIndex
14
+ * @param pageSize
15
+ * @returns ChangesetPage OK
16
+ * @throws ApiError
17
+ */
18
+ changesetsList(pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetPage>;
19
+ /**
20
+ * Create changeset
21
+ * Creates a new changeset.
22
+ * @param requestBody The changeset that should be created.
23
+ * @returns Changeset OK
24
+ * @throws ApiError
25
+ */
26
+ changesetsCreate(requestBody: Changeset): CancelablePromise<Changeset>;
27
+ /**
28
+ * Get changeset
29
+ * Gets the changeset with the provided key.
30
+ * @param key The key of the changeset to retrieve.
31
+ * @returns Changeset OK
32
+ * @throws ApiError
33
+ */
34
+ changesetsGet(key: string): CancelablePromise<Changeset>;
35
+ /**
36
+ * Delete changeset
37
+ * Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned.
38
+ * @param key The key of the changeset to delete.
39
+ * @returns Changeset OK
40
+ * @throws ApiError
41
+ */
42
+ changesetsDelete(key: string): CancelablePromise<Changeset>;
43
+ /**
44
+ * Create or replace changeset
45
+ * Creates or replaces a changeset. If a changeset with the provided key exist it is replaced.
46
+ * Otherwise a new changeset is created.
47
+ * @param key The key of the changeset to update or create.
48
+ * @param requestBody The values of the created or replaced changeset.
49
+ * @returns Changeset OK
50
+ * @throws ApiError
51
+ */
52
+ changesetsPut(key: string, requestBody: Changeset): CancelablePromise<Changeset>;
53
+ /**
54
+ * Get changeset item
55
+ * Gets the changeset item for the specified content reference.
56
+ * @param changeset The changeset key
57
+ * @param key The content key
58
+ * @param version The content version
59
+ * @returns ChangesetItem OK
60
+ * @throws ApiError
61
+ */
62
+ changesetsGetItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
63
+ /**
64
+ * Delete changeset item
65
+ * Deletes the specified changeset item from the changeset.
66
+ * @param changeset The changeset key
67
+ * @param key The content key
68
+ * @param version The content version
69
+ * @returns ChangesetItem OK
70
+ * @throws ApiError
71
+ */
72
+ changesetsDeleteItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
73
+ /**
74
+ * List changeset items
75
+ * Lists the available changeset items for the specified changeset using
76
+ * the provided options.
77
+ * @param changeset The changeset key
78
+ * @param pageIndex
79
+ * @param pageSize
80
+ * @returns ChangesetItemPage OK
81
+ * @throws ApiError
82
+ */
83
+ changesetsListItems(changeset: string, pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetItemPage>;
84
+ /**
85
+ * Create changeset item
86
+ * Creates the given changeset item.
87
+ * @param changeset The changeset key
88
+ * @param requestBody The changeset item
89
+ * @returns ChangesetItem OK
90
+ * @throws ApiError
91
+ */
92
+ changesetsCreateItem(changeset: string, requestBody: ChangesetItem): CancelablePromise<ChangesetItem>;
93
+ /**
94
+ * Update changeset item
95
+ * Updates the given changeset item.
96
+ * @param changeset The changeset key
97
+ * @param contentKey The content key
98
+ * @param contentVersion The content version
99
+ * @param requestBody The changeset item
100
+ * @param allowCreate Indicates if a new changeset item should be created if it does not exist
101
+ * @returns ChangesetItem OK
102
+ * @throws ApiError
103
+ */
104
+ changesetsUpdateItem(changeset: string, contentKey: string, contentVersion: string, requestBody: ChangesetItem, allowCreate?: boolean): CancelablePromise<ChangesetItem>;
105
+ }
@@ -10,7 +10,7 @@ class ChangesetsService {
10
10
  * Lists all changeset using the provided options.
11
11
  * @param pageIndex
12
12
  * @param pageSize
13
- * @returns ChangesetPage Success
13
+ * @returns ChangesetPage OK
14
14
  * @throws ApiError
15
15
  */
16
16
  changesetsList(pageIndex, pageSize) {
@@ -30,7 +30,7 @@ class ChangesetsService {
30
30
  * Create changeset
31
31
  * Creates a new changeset.
32
32
  * @param requestBody The changeset that should be created.
33
- * @returns Changeset Success
33
+ * @returns Changeset OK
34
34
  * @throws ApiError
35
35
  */
36
36
  changesetsCreate(requestBody) {
@@ -49,7 +49,7 @@ class ChangesetsService {
49
49
  * Get changeset
50
50
  * Gets the changeset with the provided key.
51
51
  * @param key The key of the changeset to retrieve.
52
- * @returns Changeset Success
52
+ * @returns Changeset OK
53
53
  * @throws ApiError
54
54
  */
55
55
  changesetsGet(key) {
@@ -68,7 +68,7 @@ class ChangesetsService {
68
68
  * Delete changeset
69
69
  * Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned.
70
70
  * @param key The key of the changeset to delete.
71
- * @returns Changeset Success
71
+ * @returns Changeset OK
72
72
  * @throws ApiError
73
73
  */
74
74
  changesetsDelete(key) {
@@ -90,7 +90,7 @@ class ChangesetsService {
90
90
  * Otherwise a new changeset is created.
91
91
  * @param key The key of the changeset to update or create.
92
92
  * @param requestBody The values of the created or replaced changeset.
93
- * @returns Changeset Success
93
+ * @returns Changeset OK
94
94
  * @throws ApiError
95
95
  */
96
96
  changesetsPut(key, requestBody) {
@@ -114,7 +114,7 @@ class ChangesetsService {
114
114
  * @param changeset The changeset key
115
115
  * @param key The content key
116
116
  * @param version The content version
117
- * @returns ChangesetItem Success
117
+ * @returns ChangesetItem OK
118
118
  * @throws ApiError
119
119
  */
120
120
  changesetsGetItem(changeset, key, version) {
@@ -137,7 +137,7 @@ class ChangesetsService {
137
137
  * @param changeset The changeset key
138
138
  * @param key The content key
139
139
  * @param version The content version
140
- * @returns ChangesetItem Success
140
+ * @returns ChangesetItem OK
141
141
  * @throws ApiError
142
142
  */
143
143
  changesetsDeleteItem(changeset, key, version) {
@@ -162,7 +162,7 @@ class ChangesetsService {
162
162
  * @param changeset The changeset key
163
163
  * @param pageIndex
164
164
  * @param pageSize
165
- * @returns ChangesetItemPage Success
165
+ * @returns ChangesetItemPage OK
166
166
  * @throws ApiError
167
167
  */
168
168
  changesetsListItems(changeset, pageIndex, pageSize) {
@@ -186,7 +186,7 @@ class ChangesetsService {
186
186
  * Creates the given changeset item.
187
187
  * @param changeset The changeset key
188
188
  * @param requestBody The changeset item
189
- * @returns ChangesetItem Success
189
+ * @returns ChangesetItem OK
190
190
  * @throws ApiError
191
191
  */
192
192
  changesetsCreateItem(changeset, requestBody) {
@@ -212,7 +212,7 @@ class ChangesetsService {
212
212
  * @param contentVersion The content version
213
213
  * @param requestBody The changeset item
214
214
  * @param allowCreate Indicates if a new changeset item should be created if it does not exist
215
- * @returns ChangesetItem Success
215
+ * @returns ChangesetItem OK
216
216
  * @throws ApiError
217
217
  */
218
218
  changesetsUpdateItem(changeset, contentKey, contentVersion, requestBody, allowCreate) {
@@ -1,172 +1,172 @@
1
- import type { ContentItem } from '../models/ContentItem';
2
- import type { ContentItemPage } from '../models/ContentItemPage';
3
- import type { ContentMetadata } from '../models/ContentMetadata';
4
- import type { ContentMetadataPage } from '../models/ContentMetadataPage';
5
- import type { CopyContentOptions } from '../models/CopyContentOptions';
6
- import type { VersionStatus } from '../models/VersionStatus';
7
- import type { CancelablePromise } from '../core/CancelablePromise';
8
- import type { BaseHttpRequest } from '../core/BaseHttpRequest';
9
- export declare class ContentService {
10
- readonly httpRequest: BaseHttpRequest;
11
- constructor(httpRequest: BaseHttpRequest);
12
- /**
13
- * Create content
14
- * Create a new content item.
15
- * @param requestBody The content item that should be created.
16
- * @param skipValidation Indicates that the content validation should be ignored.
17
- * @returns ContentItem Created
18
- * @throws ApiError
19
- */
20
- contentCreate(requestBody: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
21
- /**
22
- * Get content
23
- * Get shared metadata about the content instance with the provided key.
24
- * @param key The key of the content to retrieve metadata for.
25
- * @param allowDeleted Indicates that metadata for a deleted content may be returned.
26
- * @returns ContentMetadata Success
27
- * @throws ApiError
28
- */
29
- contentGetMetadata(key: string, allowDeleted?: boolean): CancelablePromise<ContentMetadata>;
30
- /**
31
- * Update content
32
- * Update an existing content item. If a content item with the provided key does not exist an error is returned.
33
- * @param key The key of the content item to patch.
34
- * @param requestBody The values of the content item that should be updated.
35
- * @returns ContentMetadata Success
36
- * @throws ApiError
37
- */
38
- contentPatchMetadata(key: string, requestBody: ContentMetadata): CancelablePromise<ContentMetadata>;
39
- /**
40
- * Delete content
41
- * Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
42
- * @param key The key of the content item to delete.
43
- * @param permanent Indicates that the content item should be permanently deleted immediately or if it should be soft deleted first.
44
- * @returns ContentMetadata Success
45
- * @throws ApiError
46
- */
47
- contentDelete(key: string, permanent?: boolean): CancelablePromise<ContentMetadata>;
48
- /**
49
- * Get content path
50
- * Get the content path with the provided key.
51
- * @param key The key of the content path to retrieve.
52
- * @param pageIndex
53
- * @param pageSize
54
- * @returns ContentMetadataPage Success
55
- * @throws ApiError
56
- */
57
- contentGetPath(key: string, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
58
- /**
59
- * List content in container
60
- * List the content items located in a specific container.
61
- * @param key The key of the content to retrieve items for.
62
- * @param contentTypes Indicates which content types or base types to include in the list.
63
- * @param pageIndex
64
- * @param pageSize
65
- * @returns ContentMetadataPage Success
66
- * @throws ApiError
67
- */
68
- contentListItems(key: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
69
- /**
70
- * List assets
71
- * List the assets that belongs to a content instance.
72
- * @param key The key of the content to retrieve assets for.
73
- * @param contentTypes Indicates which content types or base types to include in the list.
74
- * @param pageIndex
75
- * @param pageSize
76
- * @returns ContentMetadataPage Success
77
- * @throws ApiError
78
- */
79
- contentListAssets(key: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
80
- /**
81
- * Copy content
82
- * Create a copy of the content item with the provided key.
83
- * @param key The key of the content item to copy.
84
- * @param requestBody Optional instructions for how to copy content.
85
- * @returns ContentMetadata Success
86
- * @throws ApiError
87
- */
88
- contentCopy(key: string, requestBody?: CopyContentOptions): CancelablePromise<ContentMetadata>;
89
- /**
90
- * Restore content
91
- * Restore the deleted content item with the provided key. If a content item with the provided key is not deleted an error is returned.
92
- * @param key The key of the content item to undelete.
93
- * @returns ContentMetadata Success
94
- * @throws ApiError
95
- */
96
- contentUndelete(key: string): CancelablePromise<ContentMetadata>;
97
- /**
98
- * Query versions
99
- * List content versions based on the provided query options.
100
- * @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
101
- * Locale must be a valid IETF BCP-47 language tag.
102
- * @param statuses Indicates which status content versions must have to be listed.
103
- * @param pageIndex
104
- * @param pageSize
105
- * @returns ContentItemPage Success
106
- * @throws ApiError
107
- */
108
- contentListAllVersions(locales?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
109
- /**
110
- * List versions
111
- * List versions of the content item with the provided key and the provided options.
112
- * @param key
113
- * @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
114
- * Locale must be a valid IETF BCP-47 language tag.
115
- * @param statuses Indicates which status content versions must have to be listed.
116
- * @param pageIndex
117
- * @param pageSize
118
- * @returns ContentItemPage Success
119
- * @throws ApiError
120
- */
121
- contentListVersions(key: string, locales?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
122
- /**
123
- * Create version
124
- * Create a new version of a content item.
125
- * @param key The key of the content item for which a new content version should be created.
126
- * @param requestBody The content version that should be created.
127
- * @param skipValidation Indicates that the content validation should be ignored.
128
- * @returns ContentItem Created
129
- * @throws ApiError
130
- */
131
- contentCreateVersion(key: string, requestBody: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
132
- /**
133
- * Delete locale
134
- * Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
135
- * @param key
136
- * @param locale
137
- * @returns ContentItem Success
138
- * @throws ApiError
139
- */
140
- contentDeleteLocale(key: string, locale?: string): CancelablePromise<ContentItem>;
141
- /**
142
- * Get version
143
- * Get the content item with the provided key and version.
144
- * @param key
145
- * @param version
146
- * @param locale
147
- * @returns ContentItem Success
148
- * @throws ApiError
149
- */
150
- contentGetVersion(key: string, version: string, locale?: string): CancelablePromise<ContentItem>;
151
- /**
152
- * Update version
153
- * Update an existing content item. If a content item with the provided key does not exist an error is returned.
154
- * @param key The key of the content item that should be updated.
155
- * @param version The version of the content that should be updated.
156
- * @param requestBody The content information that should be updated.
157
- * @param locale The locale of the content that should be updated.
158
- * @param skipValidation Indicates that the content validation should be ignored.
159
- * @returns ContentItem Success
160
- * @throws ApiError
161
- */
162
- contentPatchVersion(key: string, version: string, requestBody: ContentItem, locale?: string, skipValidation?: boolean): CancelablePromise<ContentItem>;
163
- /**
164
- * Delete version
165
- * Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
166
- * @param key
167
- * @param version
168
- * @returns ContentItem Success
169
- * @throws ApiError
170
- */
171
- contentDeleteVersion(key: string, version: string): CancelablePromise<ContentItem>;
172
- }
1
+ import type { ContentItem } from '../models/ContentItem';
2
+ import type { ContentItemPage } from '../models/ContentItemPage';
3
+ import type { ContentMetadata } from '../models/ContentMetadata';
4
+ import type { ContentMetadataPage } from '../models/ContentMetadataPage';
5
+ import type { CopyContentOptions } from '../models/CopyContentOptions';
6
+ import type { VersionStatus } from '../models/VersionStatus';
7
+ import type { CancelablePromise } from '../core/CancelablePromise';
8
+ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
9
+ export declare class ContentService {
10
+ readonly httpRequest: BaseHttpRequest;
11
+ constructor(httpRequest: BaseHttpRequest);
12
+ /**
13
+ * Create content
14
+ * Create a new content item.
15
+ * @param requestBody The content item that should be created.
16
+ * @param skipValidation Indicates that the content validation should be ignored.
17
+ * @returns ContentItem Created
18
+ * @throws ApiError
19
+ */
20
+ contentCreate(requestBody: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
21
+ /**
22
+ * Get content
23
+ * Get shared metadata about the content instance with the provided key.
24
+ * @param key The key of the content to retrieve metadata for.
25
+ * @param allowDeleted Indicates that metadata for a deleted content may be returned.
26
+ * @returns ContentMetadata OK
27
+ * @throws ApiError
28
+ */
29
+ contentGetMetadata(key: string, allowDeleted?: boolean): CancelablePromise<ContentMetadata>;
30
+ /**
31
+ * Update content
32
+ * Update an existing content item. If a content item with the provided key does not exist an error is returned.
33
+ * @param key The key of the content item to patch.
34
+ * @param requestBody The values of the content item that should be updated.
35
+ * @returns ContentMetadata OK
36
+ * @throws ApiError
37
+ */
38
+ contentPatchMetadata(key: string, requestBody: ContentMetadata): CancelablePromise<ContentMetadata>;
39
+ /**
40
+ * Delete content
41
+ * Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
42
+ * @param key The key of the content item to delete.
43
+ * @param permanent Indicates that the content item should be permanently deleted immediately or if it should be soft deleted first.
44
+ * @returns ContentMetadata OK
45
+ * @throws ApiError
46
+ */
47
+ contentDelete(key: string, permanent?: boolean): CancelablePromise<ContentMetadata>;
48
+ /**
49
+ * Get content path
50
+ * Get the content path with the provided key.
51
+ * @param key The key of the content path to retrieve.
52
+ * @param pageIndex
53
+ * @param pageSize
54
+ * @returns ContentMetadataPage OK
55
+ * @throws ApiError
56
+ */
57
+ contentGetPath(key: string, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
58
+ /**
59
+ * List content in container
60
+ * List the content items located in a specific container.
61
+ * @param key The key of the content to retrieve items for.
62
+ * @param contentTypes Indicates which content types or base types to include in the list.
63
+ * @param pageIndex
64
+ * @param pageSize
65
+ * @returns ContentMetadataPage OK
66
+ * @throws ApiError
67
+ */
68
+ contentListItems(key: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
69
+ /**
70
+ * List assets
71
+ * List the assets that belongs to a content instance.
72
+ * @param key The key of the content to retrieve assets for.
73
+ * @param contentTypes Indicates which content types or base types to include in the list.
74
+ * @param pageIndex
75
+ * @param pageSize
76
+ * @returns ContentMetadataPage OK
77
+ * @throws ApiError
78
+ */
79
+ contentListAssets(key: string, contentTypes?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentMetadataPage>;
80
+ /**
81
+ * Copy content
82
+ * Create a copy of the content item with the provided key.
83
+ * @param key The key of the content item to copy.
84
+ * @param requestBody Optional instructions for how to copy content.
85
+ * @returns ContentMetadata OK
86
+ * @throws ApiError
87
+ */
88
+ contentCopy(key: string, requestBody?: CopyContentOptions): CancelablePromise<ContentMetadata>;
89
+ /**
90
+ * Restore content
91
+ * Restore the deleted content item with the provided key. If a content item with the provided key is not deleted an error is returned.
92
+ * @param key The key of the content item to undelete.
93
+ * @returns ContentMetadata OK
94
+ * @throws ApiError
95
+ */
96
+ contentUndelete(key: string): CancelablePromise<ContentMetadata>;
97
+ /**
98
+ * Query versions
99
+ * List content versions based on the provided query options.
100
+ * @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
101
+ * Locale must be a valid IETF BCP-47 language tag.
102
+ * @param statuses Indicates which status content versions must have to be listed.
103
+ * @param pageIndex
104
+ * @param pageSize
105
+ * @returns ContentItemPage OK
106
+ * @throws ApiError
107
+ */
108
+ contentListAllVersions(locales?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
109
+ /**
110
+ * List versions
111
+ * List versions of the content item with the provided key and the provided options.
112
+ * @param key
113
+ * @param locales Indicates which content locales that should be listed. Use 'NEUTRAL' to include locale-neutral content.
114
+ * Locale must be a valid IETF BCP-47 language tag.
115
+ * @param statuses Indicates which status content versions must have to be listed.
116
+ * @param pageIndex
117
+ * @param pageSize
118
+ * @returns ContentItemPage OK
119
+ * @throws ApiError
120
+ */
121
+ contentListVersions(key: string, locales?: Array<string>, statuses?: Array<VersionStatus>, pageIndex?: number, pageSize?: number): CancelablePromise<ContentItemPage>;
122
+ /**
123
+ * Create version
124
+ * Create a new version of a content item.
125
+ * @param key The key of the content item for which a new content version should be created.
126
+ * @param requestBody The content version that should be created.
127
+ * @param skipValidation Indicates that the content validation should be ignored.
128
+ * @returns ContentItem Created
129
+ * @throws ApiError
130
+ */
131
+ contentCreateVersion(key: string, requestBody: ContentItem, skipValidation?: boolean): CancelablePromise<ContentItem>;
132
+ /**
133
+ * Delete locale
134
+ * Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
135
+ * @param key
136
+ * @param locale
137
+ * @returns ContentItem OK
138
+ * @throws ApiError
139
+ */
140
+ contentDeleteLocale(key: string, locale?: string): CancelablePromise<ContentItem>;
141
+ /**
142
+ * Get version
143
+ * Get the content item with the provided key and version.
144
+ * @param key
145
+ * @param version
146
+ * @param locale
147
+ * @returns ContentItem OK
148
+ * @throws ApiError
149
+ */
150
+ contentGetVersion(key: string, version: string, locale?: string): CancelablePromise<ContentItem>;
151
+ /**
152
+ * Update version
153
+ * Update an existing content item. If a content item with the provided key does not exist an error is returned.
154
+ * @param key The key of the content item that should be updated.
155
+ * @param version The version of the content that should be updated.
156
+ * @param requestBody The content information that should be updated.
157
+ * @param locale The locale of the content that should be updated.
158
+ * @param skipValidation Indicates that the content validation should be ignored.
159
+ * @returns ContentItem OK
160
+ * @throws ApiError
161
+ */
162
+ contentPatchVersion(key: string, version: string, requestBody: ContentItem, locale?: string, skipValidation?: boolean): CancelablePromise<ContentItem>;
163
+ /**
164
+ * Delete version
165
+ * Deletes the content item with the provided key. If a content item with the provided key does not exist an error is returned.
166
+ * @param key
167
+ * @param version
168
+ * @returns ContentItem OK
169
+ * @throws ApiError
170
+ */
171
+ contentDeleteVersion(key: string, version: string): CancelablePromise<ContentItem>;
172
+ }