@remkoj/optimizely-cms-api 2.0.0-pre4 → 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 (182) 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 -24
  4. package/dist/client/CmsIntegrationApiClient.js +36 -36
  5. package/dist/client/core/ApiError.d.ts +10 -10
  6. package/dist/client/core/ApiError.js +15 -15
  7. package/dist/client/core/ApiRequestOptions.d.ts +13 -13
  8. package/dist/client/core/ApiRequestOptions.js +2 -2
  9. package/dist/client/core/ApiResult.d.ts +7 -7
  10. package/dist/client/core/ApiResult.js +2 -2
  11. package/dist/client/core/BaseHttpRequest.d.ts +8 -8
  12. package/dist/client/core/BaseHttpRequest.js +9 -9
  13. package/dist/client/core/CancelablePromise.d.ts +20 -20
  14. package/dist/client/core/CancelablePromise.js +116 -116
  15. package/dist/client/core/FetchHttpRequest.d.ts +14 -14
  16. package/dist/client/core/FetchHttpRequest.js +20 -20
  17. package/dist/client/core/OpenAPI.d.ts +16 -16
  18. package/dist/client/core/OpenAPI.js +14 -14
  19. package/dist/client/core/request.d.ts +30 -30
  20. package/dist/client/core/request.js +294 -294
  21. package/dist/client/index.d.ts +81 -81
  22. package/dist/client/index.js +48 -48
  23. package/dist/client/models/BinaryProperty.d.ts +8 -8
  24. package/dist/client/models/BinaryProperty.js +2 -2
  25. package/dist/client/models/BooleanProperty.d.ts +5 -5
  26. package/dist/client/models/BooleanProperty.js +2 -2
  27. package/dist/client/models/Changeset.d.ts +26 -26
  28. package/dist/client/models/Changeset.js +2 -2
  29. package/dist/client/models/ChangesetItem.d.ts +11 -11
  30. package/dist/client/models/ChangesetItem.js +2 -2
  31. package/dist/client/models/ChangesetItemPage.d.ts +19 -19
  32. package/dist/client/models/ChangesetItemPage.js +2 -2
  33. package/dist/client/models/ChangesetPage.d.ts +19 -19
  34. package/dist/client/models/ChangesetPage.js +2 -2
  35. package/dist/client/models/ComponentListItem.d.ts +7 -10
  36. package/dist/client/models/ComponentListItem.js +2 -2
  37. package/dist/client/models/ComponentProperty.d.ts +7 -10
  38. package/dist/client/models/ComponentProperty.js +2 -2
  39. package/dist/client/models/ContentBaseType.d.ts +11 -11
  40. package/dist/client/models/ContentBaseType.js +19 -19
  41. package/dist/client/models/ContentComponent.d.ts +34 -34
  42. package/dist/client/models/ContentComponent.js +2 -2
  43. package/dist/client/models/ContentItem.d.ts +60 -60
  44. package/dist/client/models/ContentItem.js +2 -2
  45. package/dist/client/models/ContentItemListWithContentTypes.d.ts +27 -27
  46. package/dist/client/models/ContentItemListWithContentTypes.js +2 -2
  47. package/dist/client/models/ContentItemPage.d.ts +19 -19
  48. package/dist/client/models/ContentItemPage.js +2 -2
  49. package/dist/client/models/ContentItemWithContentTypes.d.ts +12 -12
  50. package/dist/client/models/ContentItemWithContentTypes.js +2 -2
  51. package/dist/client/models/ContentListItem.d.ts +8 -14
  52. package/dist/client/models/ContentListItem.js +2 -2
  53. package/dist/client/models/ContentLocaleInfo.d.ts +19 -11
  54. package/dist/client/models/ContentLocaleInfo.js +2 -2
  55. package/dist/client/models/ContentMetadata.d.ts +38 -46
  56. package/dist/client/models/ContentMetadata.js +2 -2
  57. package/dist/client/models/ContentMetadataPage.d.ts +19 -19
  58. package/dist/client/models/ContentMetadataPage.js +2 -2
  59. package/dist/client/models/ContentProperty.d.ts +8 -14
  60. package/dist/client/models/ContentProperty.js +2 -2
  61. package/dist/client/models/ContentReference.d.ts +17 -17
  62. package/dist/client/models/ContentReference.js +2 -2
  63. package/dist/client/models/ContentReferenceListItem.d.ts +8 -14
  64. package/dist/client/models/ContentReferenceListItem.js +2 -2
  65. package/dist/client/models/ContentReferenceProperty.d.ts +8 -14
  66. package/dist/client/models/ContentReferenceProperty.js +2 -2
  67. package/dist/client/models/ContentType.d.ts +79 -79
  68. package/dist/client/models/ContentType.js +2 -2
  69. package/dist/client/models/ContentTypeFeature.d.ts +10 -10
  70. package/dist/client/models/ContentTypeFeature.js +18 -18
  71. package/dist/client/models/ContentTypePage.d.ts +19 -19
  72. package/dist/client/models/ContentTypePage.js +2 -2
  73. package/dist/client/models/ContentTypeProperty.d.ts +47 -47
  74. package/dist/client/models/ContentTypeProperty.js +2 -2
  75. package/dist/client/models/ContentTypeUsage.d.ts +7 -7
  76. package/dist/client/models/ContentTypeUsage.js +15 -15
  77. package/dist/client/models/CopyContentOptions.d.ts +21 -21
  78. package/dist/client/models/CopyContentOptions.js +2 -2
  79. package/dist/client/models/DateTimeListItem.d.ts +8 -14
  80. package/dist/client/models/DateTimeListItem.js +2 -2
  81. package/dist/client/models/DateTimeProperty.d.ts +8 -14
  82. package/dist/client/models/DateTimeProperty.js +2 -2
  83. package/dist/client/models/DisplaySetting.d.ts +22 -22
  84. package/dist/client/models/DisplaySetting.js +2 -2
  85. package/dist/client/models/DisplaySettingChoice.d.ts +13 -13
  86. package/dist/client/models/DisplaySettingChoice.js +2 -2
  87. package/dist/client/models/DisplayTemplate.d.ts +49 -49
  88. package/dist/client/models/DisplayTemplate.js +2 -2
  89. package/dist/client/models/DisplayTemplatePage.d.ts +19 -19
  90. package/dist/client/models/DisplayTemplatePage.js +2 -2
  91. package/dist/client/models/DoubleEnumerationSettings.d.ts +9 -9
  92. package/dist/client/models/DoubleEnumerationSettings.js +2 -2
  93. package/dist/client/models/FloatListItem.d.ts +10 -16
  94. package/dist/client/models/FloatListItem.js +2 -2
  95. package/dist/client/models/FloatProperty.d.ts +10 -16
  96. package/dist/client/models/FloatProperty.js +2 -2
  97. package/dist/client/models/ImageDescriptor.d.ts +17 -17
  98. package/dist/client/models/ImageDescriptor.js +2 -2
  99. package/dist/client/models/ImportPackageMessage.d.ts +17 -17
  100. package/dist/client/models/ImportPackageMessage.js +2 -2
  101. package/dist/client/models/ImportPackageResult.d.ts +22 -22
  102. package/dist/client/models/ImportPackageResult.js +2 -2
  103. package/dist/client/models/IndexingType.d.ts +8 -8
  104. package/dist/client/models/IndexingType.js +16 -16
  105. package/dist/client/models/Int32EnumerationSettings.d.ts +9 -9
  106. package/dist/client/models/Int32EnumerationSettings.js +2 -2
  107. package/dist/client/models/IntegerListItem.d.ts +10 -16
  108. package/dist/client/models/IntegerListItem.js +2 -2
  109. package/dist/client/models/IntegerProperty.d.ts +10 -16
  110. package/dist/client/models/IntegerProperty.js +2 -2
  111. package/dist/client/models/JsonStringProperty.d.ts +5 -5
  112. package/dist/client/models/JsonStringProperty.js +2 -2
  113. package/dist/client/models/ListProperty.d.ts +26 -26
  114. package/dist/client/models/ListProperty.js +2 -2
  115. package/dist/client/models/ListPropertyItem.d.ts +11 -11
  116. package/dist/client/models/ListPropertyItem.js +2 -2
  117. package/dist/client/models/LocaleStatus.d.ts +7 -7
  118. package/dist/client/models/LocaleStatus.js +15 -15
  119. package/dist/client/models/Manifest.d.ts +24 -24
  120. package/dist/client/models/Manifest.js +2 -2
  121. package/dist/client/models/OauthToken.d.ts +18 -18
  122. package/dist/client/models/OauthToken.js +2 -2
  123. package/dist/client/models/OauthTokenError.d.ts +13 -13
  124. package/dist/client/models/OauthTokenError.js +2 -2
  125. package/dist/client/models/OauthTokenRequest.d.ts +21 -21
  126. package/dist/client/models/OauthTokenRequest.js +2 -2
  127. package/dist/client/models/PackageJob.d.ts +28 -28
  128. package/dist/client/models/PackageJob.js +2 -2
  129. package/dist/client/models/PackageJobMessage.d.ts +17 -17
  130. package/dist/client/models/PackageJobMessage.js +2 -2
  131. package/dist/client/models/PackageJobStatus.d.ts +4 -4
  132. package/dist/client/models/PackageJobStatus.js +2 -2
  133. package/dist/client/models/ProblemDetails.d.ts +1 -1
  134. package/dist/client/models/ProblemDetails.js +2 -2
  135. package/dist/client/models/PropertyDataType.d.ts +18 -18
  136. package/dist/client/models/PropertyDataType.js +26 -26
  137. package/dist/client/models/PropertyFormat.d.ts +34 -34
  138. package/dist/client/models/PropertyFormat.js +2 -2
  139. package/dist/client/models/PropertyFormatPage.d.ts +19 -19
  140. package/dist/client/models/PropertyFormatPage.js +2 -2
  141. package/dist/client/models/PropertyGroup.d.ts +21 -21
  142. package/dist/client/models/PropertyGroup.js +2 -2
  143. package/dist/client/models/PropertyGroupPage.d.ts +19 -19
  144. package/dist/client/models/PropertyGroupPage.js +2 -2
  145. package/dist/client/models/StringEnumerationSettings.d.ts +9 -9
  146. package/dist/client/models/StringEnumerationSettings.js +2 -2
  147. package/dist/client/models/StringListItem.d.ts +11 -14
  148. package/dist/client/models/StringListItem.js +2 -2
  149. package/dist/client/models/StringProperty.d.ts +11 -14
  150. package/dist/client/models/StringProperty.js +2 -2
  151. package/dist/client/models/UrlListItem.d.ts +5 -5
  152. package/dist/client/models/UrlListItem.js +2 -2
  153. package/dist/client/models/UrlProperty.d.ts +5 -5
  154. package/dist/client/models/UrlProperty.js +2 -2
  155. package/dist/client/models/VersionStatus.d.ts +12 -12
  156. package/dist/client/models/VersionStatus.js +20 -20
  157. package/dist/client/services/ChangesetsService.d.ts +105 -105
  158. package/dist/client/services/ChangesetsService.js +239 -239
  159. package/dist/client/services/ContentService.d.ts +172 -172
  160. package/dist/client/services/ContentService.js +409 -409
  161. package/dist/client/services/ContentTypesService.d.ts +66 -66
  162. package/dist/client/services/ContentTypesService.js +149 -149
  163. package/dist/client/services/DisplayTemplatesService.d.ts +60 -60
  164. package/dist/client/services/DisplayTemplatesService.js +135 -135
  165. package/dist/client/services/OauthService.d.ts +17 -17
  166. package/dist/client/services/OauthService.js +28 -28
  167. package/dist/client/services/PackagesService.d.ts +41 -41
  168. package/dist/client/services/PackagesService.js +80 -80
  169. package/dist/client/services/PropertyFormatsService.d.ts +26 -26
  170. package/dist/client/services/PropertyFormatsService.js +53 -53
  171. package/dist/client/services/PropertyGroupsService.d.ts +61 -61
  172. package/dist/client/services/PropertyGroupsService.js +135 -135
  173. package/dist/config.d.ts +8 -8
  174. package/dist/config.js +40 -40
  175. package/dist/getaccesstoken.d.ts +3 -0
  176. package/dist/getaccesstoken.js +43 -0
  177. package/dist/index.d.ts +16 -15
  178. package/dist/index.js +52 -95
  179. package/dist/types.d.ts +8 -0
  180. package/dist/types.js +2 -0
  181. package/dist/version.json +5 -0
  182. package/package.json +11 -7
@@ -1,135 +1,135 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DisplayTemplatesService = void 0;
4
- class DisplayTemplatesService {
5
- constructor(httpRequest) {
6
- this.httpRequest = httpRequest;
7
- }
8
- /**
9
- * List display templates
10
- * List display templates using the provided options.
11
- * @param pageIndex
12
- * @param pageSize
13
- * @returns DisplayTemplatePage Success
14
- * @throws ApiError
15
- */
16
- displayTemplatesList(pageIndex, pageSize) {
17
- return this.httpRequest.request({
18
- method: 'GET',
19
- url: '/displaytemplates',
20
- query: {
21
- 'pageIndex': pageIndex,
22
- 'pageSize': pageSize,
23
- },
24
- errors: {
25
- 403: `Forbidden`,
26
- },
27
- });
28
- }
29
- /**
30
- * Create display template
31
- * Create a new display template.
32
- * @param requestBody The display template that should be created.
33
- * @returns DisplayTemplate Success
34
- * @throws ApiError
35
- */
36
- displayTemplatesCreate(requestBody) {
37
- return this.httpRequest.request({
38
- method: 'POST',
39
- url: '/displaytemplates',
40
- body: requestBody,
41
- mediaType: 'application/json',
42
- errors: {
43
- 400: `Bad Request`,
44
- 403: `Forbidden`,
45
- },
46
- });
47
- }
48
- /**
49
- * Get display template
50
- * Get the display template with the provided key.
51
- * @param key The key of the display template to retrieve.
52
- * @returns DisplayTemplate Success
53
- * @throws ApiError
54
- */
55
- displayTemplatesGet(key) {
56
- return this.httpRequest.request({
57
- method: 'GET',
58
- url: '/displaytemplates/{key}',
59
- path: {
60
- 'key': key,
61
- },
62
- errors: {
63
- 403: `Forbidden`,
64
- },
65
- });
66
- }
67
- /**
68
- * Create or replace a display template
69
- * Create or replace a display template. If a display template with the provided key exist it is replaced.
70
- * Otherwise a new display template is created.
71
- * @param key The key of the display template to update or create.
72
- * @param requestBody The values of the created or replaced display template.
73
- * @returns DisplayTemplate Success
74
- * @throws ApiError
75
- */
76
- displayTemplatesPut(key, requestBody) {
77
- return this.httpRequest.request({
78
- method: 'PUT',
79
- url: '/displaytemplates/{key}',
80
- path: {
81
- 'key': key,
82
- },
83
- body: requestBody,
84
- mediaType: 'application/json',
85
- errors: {
86
- 400: `Bad Request`,
87
- 403: `Forbidden`,
88
- },
89
- });
90
- }
91
- /**
92
- * Update display template
93
- * Update an existing display template.
94
- * @param key The key of the display template to patch.
95
- * @param requestBody The values of the display template that should be updated.
96
- * @returns DisplayTemplate Success
97
- * @throws ApiError
98
- */
99
- displayTemplatesPatch(key, requestBody) {
100
- return this.httpRequest.request({
101
- method: 'PATCH',
102
- url: '/displaytemplates/{key}',
103
- path: {
104
- 'key': key,
105
- },
106
- body: requestBody,
107
- mediaType: 'application/merge-patch+json',
108
- errors: {
109
- 400: `Bad Request`,
110
- 403: `Forbidden`,
111
- },
112
- });
113
- }
114
- /**
115
- * Delete display template
116
- * Deletes the display template with the provided key.
117
- * @param key The key of the display template to delete.
118
- * @returns DisplayTemplate Success
119
- * @throws ApiError
120
- */
121
- displayTemplatesDelete(key) {
122
- return this.httpRequest.request({
123
- method: 'DELETE',
124
- url: '/displaytemplates/{key}',
125
- path: {
126
- 'key': key,
127
- },
128
- errors: {
129
- 400: `Bad Request`,
130
- 403: `Forbidden`,
131
- },
132
- });
133
- }
134
- }
135
- exports.DisplayTemplatesService = DisplayTemplatesService;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DisplayTemplatesService = void 0;
4
+ class DisplayTemplatesService {
5
+ constructor(httpRequest) {
6
+ this.httpRequest = httpRequest;
7
+ }
8
+ /**
9
+ * List display templates
10
+ * List display templates using the provided options.
11
+ * @param pageIndex
12
+ * @param pageSize
13
+ * @returns DisplayTemplatePage OK
14
+ * @throws ApiError
15
+ */
16
+ displayTemplatesList(pageIndex, pageSize) {
17
+ return this.httpRequest.request({
18
+ method: 'GET',
19
+ url: '/displaytemplates',
20
+ query: {
21
+ 'pageIndex': pageIndex,
22
+ 'pageSize': pageSize,
23
+ },
24
+ errors: {
25
+ 403: `Forbidden`,
26
+ },
27
+ });
28
+ }
29
+ /**
30
+ * Create display template
31
+ * Create a new display template.
32
+ * @param requestBody The display template that should be created.
33
+ * @returns DisplayTemplate OK
34
+ * @throws ApiError
35
+ */
36
+ displayTemplatesCreate(requestBody) {
37
+ return this.httpRequest.request({
38
+ method: 'POST',
39
+ url: '/displaytemplates',
40
+ body: requestBody,
41
+ mediaType: 'application/json',
42
+ errors: {
43
+ 400: `Bad Request`,
44
+ 403: `Forbidden`,
45
+ },
46
+ });
47
+ }
48
+ /**
49
+ * Get display template
50
+ * Get the display template with the provided key.
51
+ * @param key The key of the display template to retrieve.
52
+ * @returns DisplayTemplate OK
53
+ * @throws ApiError
54
+ */
55
+ displayTemplatesGet(key) {
56
+ return this.httpRequest.request({
57
+ method: 'GET',
58
+ url: '/displaytemplates/{key}',
59
+ path: {
60
+ 'key': key,
61
+ },
62
+ errors: {
63
+ 403: `Forbidden`,
64
+ },
65
+ });
66
+ }
67
+ /**
68
+ * Create or replace a display template
69
+ * Create or replace a display template. If a display template with the provided key exist it is replaced.
70
+ * Otherwise a new display template is created.
71
+ * @param key The key of the display template to update or create.
72
+ * @param requestBody The values of the created or replaced display template.
73
+ * @returns DisplayTemplate OK
74
+ * @throws ApiError
75
+ */
76
+ displayTemplatesPut(key, requestBody) {
77
+ return this.httpRequest.request({
78
+ method: 'PUT',
79
+ url: '/displaytemplates/{key}',
80
+ path: {
81
+ 'key': key,
82
+ },
83
+ body: requestBody,
84
+ mediaType: 'application/json',
85
+ errors: {
86
+ 400: `Bad Request`,
87
+ 403: `Forbidden`,
88
+ },
89
+ });
90
+ }
91
+ /**
92
+ * Update display template
93
+ * Update an existing display template.
94
+ * @param key The key of the display template to patch.
95
+ * @param requestBody The values of the display template that should be updated.
96
+ * @returns DisplayTemplate OK
97
+ * @throws ApiError
98
+ */
99
+ displayTemplatesPatch(key, requestBody) {
100
+ return this.httpRequest.request({
101
+ method: 'PATCH',
102
+ url: '/displaytemplates/{key}',
103
+ path: {
104
+ 'key': key,
105
+ },
106
+ body: requestBody,
107
+ mediaType: 'application/merge-patch+json',
108
+ errors: {
109
+ 400: `Bad Request`,
110
+ 403: `Forbidden`,
111
+ },
112
+ });
113
+ }
114
+ /**
115
+ * Delete display template
116
+ * Deletes the display template with the provided key.
117
+ * @param key The key of the display template to delete.
118
+ * @returns DisplayTemplate OK
119
+ * @throws ApiError
120
+ */
121
+ displayTemplatesDelete(key) {
122
+ return this.httpRequest.request({
123
+ method: 'DELETE',
124
+ url: '/displaytemplates/{key}',
125
+ path: {
126
+ 'key': key,
127
+ },
128
+ errors: {
129
+ 400: `Bad Request`,
130
+ 403: `Forbidden`,
131
+ },
132
+ });
133
+ }
134
+ }
135
+ exports.DisplayTemplatesService = DisplayTemplatesService;
@@ -1,17 +1,17 @@
1
- import type { OauthToken } from '../models/OauthToken';
2
- import type { OauthTokenRequest } from '../models/OauthTokenRequest';
3
- import type { CancelablePromise } from '../core/CancelablePromise';
4
- import type { BaseHttpRequest } from '../core/BaseHttpRequest';
5
- export declare class OauthService {
6
- readonly httpRequest: BaseHttpRequest;
7
- constructor(httpRequest: BaseHttpRequest);
8
- /**
9
- * Request access token
10
- * Request an access token. This endpoint only supports the 'client_credentials' grant type
11
- * and will only issue short-lived tokens.
12
- * @param requestBody
13
- * @returns OauthToken Success
14
- * @throws ApiError
15
- */
16
- oauthToken(requestBody: OauthTokenRequest): CancelablePromise<OauthToken>;
17
- }
1
+ import type { OauthToken } from '../models/OauthToken';
2
+ import type { OauthTokenRequest } from '../models/OauthTokenRequest';
3
+ import type { CancelablePromise } from '../core/CancelablePromise';
4
+ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
5
+ export declare class OauthService {
6
+ readonly httpRequest: BaseHttpRequest;
7
+ constructor(httpRequest: BaseHttpRequest);
8
+ /**
9
+ * Request access token
10
+ * Request an access token. This endpoint only supports the 'client_credentials' grant type
11
+ * and will only issue short-lived tokens.
12
+ * @param requestBody
13
+ * @returns OauthToken OK
14
+ * @throws ApiError
15
+ */
16
+ oauthToken(requestBody: OauthTokenRequest): CancelablePromise<OauthToken>;
17
+ }
@@ -1,28 +1,28 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OauthService = void 0;
4
- class OauthService {
5
- constructor(httpRequest) {
6
- this.httpRequest = httpRequest;
7
- }
8
- /**
9
- * Request access token
10
- * Request an access token. This endpoint only supports the 'client_credentials' grant type
11
- * and will only issue short-lived tokens.
12
- * @param requestBody
13
- * @returns OauthToken Success
14
- * @throws ApiError
15
- */
16
- oauthToken(requestBody) {
17
- return this.httpRequest.request({
18
- method: 'POST',
19
- url: '/oauth/token',
20
- body: requestBody,
21
- mediaType: 'application/json',
22
- errors: {
23
- 400: `Bad Request`,
24
- },
25
- });
26
- }
27
- }
28
- exports.OauthService = OauthService;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.OauthService = void 0;
4
+ class OauthService {
5
+ constructor(httpRequest) {
6
+ this.httpRequest = httpRequest;
7
+ }
8
+ /**
9
+ * Request access token
10
+ * Request an access token. This endpoint only supports the 'client_credentials' grant type
11
+ * and will only issue short-lived tokens.
12
+ * @param requestBody
13
+ * @returns OauthToken OK
14
+ * @throws ApiError
15
+ */
16
+ oauthToken(requestBody) {
17
+ return this.httpRequest.request({
18
+ method: 'POST',
19
+ url: '/oauth/token',
20
+ body: requestBody,
21
+ mediaType: 'application/json',
22
+ errors: {
23
+ 400: `Bad Request`,
24
+ },
25
+ });
26
+ }
27
+ }
28
+ exports.OauthService = OauthService;
@@ -1,41 +1,41 @@
1
- import type { ImportPackageResult } from '../models/ImportPackageResult';
2
- import type { Manifest } from '../models/Manifest';
3
- import type { PackageJob } from '../models/PackageJob';
4
- import type { CancelablePromise } from '../core/CancelablePromise';
5
- import type { BaseHttpRequest } from '../core/BaseHttpRequest';
6
- export declare class PackagesService {
7
- readonly httpRequest: BaseHttpRequest;
8
- constructor(httpRequest: BaseHttpRequest);
9
- /**
10
- * Get job status
11
- * Get a package job status.
12
- * @param key The key of the package job.
13
- * @returns PackageJob Success
14
- * @throws ApiError
15
- */
16
- packagesGet(key: string): CancelablePromise<PackageJob>;
17
- /**
18
- * Export package
19
- * Export a data package.
20
- * @param includeReadOnly Indicates if read-only resources should be included in the export data.
21
- * @returns Manifest Success
22
- * @throws ApiError
23
- */
24
- packagesExport(includeReadOnly?: boolean): CancelablePromise<Manifest>;
25
- /**
26
- * Import package
27
- * Import a data package.
28
- * @param container The key of the container content where new content items should be created under.
29
- * @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
30
- * content item with the same key.
31
- * If set to `false`, always create new content item under the specified container regardless of the content key.
32
- * @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
33
- * @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
34
- * then content in all locales are imported.
35
- * @param requestBody
36
- * @returns ImportPackageResult Success
37
- * @returns PackageJob Accepted
38
- * @throws ApiError
39
- */
40
- packagesImport(container?: string, overwriteExistingContentItems?: boolean, ignoreDataLossWarnings?: boolean, locale?: string, requestBody?: Blob): CancelablePromise<ImportPackageResult | PackageJob>;
41
- }
1
+ import type { ImportPackageResult } from '../models/ImportPackageResult';
2
+ import type { Manifest } from '../models/Manifest';
3
+ import type { PackageJob } from '../models/PackageJob';
4
+ import type { CancelablePromise } from '../core/CancelablePromise';
5
+ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
6
+ export declare class PackagesService {
7
+ readonly httpRequest: BaseHttpRequest;
8
+ constructor(httpRequest: BaseHttpRequest);
9
+ /**
10
+ * Get job status
11
+ * Get a package job status.
12
+ * @param key The key of the package job.
13
+ * @returns PackageJob OK
14
+ * @throws ApiError
15
+ */
16
+ packagesGet(key: string): CancelablePromise<PackageJob>;
17
+ /**
18
+ * Export package
19
+ * Export a data package.
20
+ * @param includeReadOnly Indicates if read-only resources should be included in the export data.
21
+ * @returns Manifest OK
22
+ * @throws ApiError
23
+ */
24
+ packagesExport(includeReadOnly?: boolean): CancelablePromise<Manifest>;
25
+ /**
26
+ * Import package
27
+ * Import a data package.
28
+ * @param container The key of the container content where new content items should be created under.
29
+ * @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
30
+ * content item with the same key.
31
+ * If set to `false`, always create new content item under the specified container regardless of the content key.
32
+ * @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
33
+ * @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
34
+ * then content in all locales are imported.
35
+ * @param requestBody
36
+ * @returns ImportPackageResult OK
37
+ * @returns PackageJob Accepted
38
+ * @throws ApiError
39
+ */
40
+ packagesImport(container?: string, overwriteExistingContentItems?: boolean, ignoreDataLossWarnings?: boolean, locale?: string, requestBody?: Blob): CancelablePromise<ImportPackageResult | PackageJob>;
41
+ }
@@ -1,80 +1,80 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PackagesService = void 0;
4
- class PackagesService {
5
- constructor(httpRequest) {
6
- this.httpRequest = httpRequest;
7
- }
8
- /**
9
- * Get job status
10
- * Get a package job status.
11
- * @param key The key of the package job.
12
- * @returns PackageJob Success
13
- * @throws ApiError
14
- */
15
- packagesGet(key) {
16
- return this.httpRequest.request({
17
- method: 'GET',
18
- url: '/packages/{key}',
19
- path: {
20
- 'key': key,
21
- },
22
- errors: {
23
- 403: `Forbidden`,
24
- },
25
- });
26
- }
27
- /**
28
- * Export package
29
- * Export a data package.
30
- * @param includeReadOnly Indicates if read-only resources should be included in the export data.
31
- * @returns Manifest Success
32
- * @throws ApiError
33
- */
34
- packagesExport(includeReadOnly) {
35
- return this.httpRequest.request({
36
- method: 'GET',
37
- url: '/packages',
38
- query: {
39
- 'includeReadOnly': includeReadOnly,
40
- },
41
- errors: {
42
- 403: `Forbidden`,
43
- },
44
- });
45
- }
46
- /**
47
- * Import package
48
- * Import a data package.
49
- * @param container The key of the container content where new content items should be created under.
50
- * @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
51
- * content item with the same key.
52
- * If set to `false`, always create new content item under the specified container regardless of the content key.
53
- * @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
54
- * @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
55
- * then content in all locales are imported.
56
- * @param requestBody
57
- * @returns ImportPackageResult Success
58
- * @returns PackageJob Accepted
59
- * @throws ApiError
60
- */
61
- packagesImport(container, overwriteExistingContentItems = false, ignoreDataLossWarnings = false, locale, requestBody) {
62
- return this.httpRequest.request({
63
- method: 'POST',
64
- url: '/packages',
65
- query: {
66
- 'container': container,
67
- 'overwriteExistingContentItems': overwriteExistingContentItems,
68
- 'ignoreDataLossWarnings': ignoreDataLossWarnings,
69
- 'locale': locale,
70
- },
71
- body: requestBody,
72
- mediaType: 'application/vnd.episerver.cms.data',
73
- errors: {
74
- 400: `Bad Request`,
75
- 403: `Forbidden`,
76
- },
77
- });
78
- }
79
- }
80
- exports.PackagesService = PackagesService;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PackagesService = void 0;
4
+ class PackagesService {
5
+ constructor(httpRequest) {
6
+ this.httpRequest = httpRequest;
7
+ }
8
+ /**
9
+ * Get job status
10
+ * Get a package job status.
11
+ * @param key The key of the package job.
12
+ * @returns PackageJob OK
13
+ * @throws ApiError
14
+ */
15
+ packagesGet(key) {
16
+ return this.httpRequest.request({
17
+ method: 'GET',
18
+ url: '/packages/{key}',
19
+ path: {
20
+ 'key': key,
21
+ },
22
+ errors: {
23
+ 403: `Forbidden`,
24
+ },
25
+ });
26
+ }
27
+ /**
28
+ * Export package
29
+ * Export a data package.
30
+ * @param includeReadOnly Indicates if read-only resources should be included in the export data.
31
+ * @returns Manifest OK
32
+ * @throws ApiError
33
+ */
34
+ packagesExport(includeReadOnly) {
35
+ return this.httpRequest.request({
36
+ method: 'GET',
37
+ url: '/packages',
38
+ query: {
39
+ 'includeReadOnly': includeReadOnly,
40
+ },
41
+ errors: {
42
+ 403: `Forbidden`,
43
+ },
44
+ });
45
+ }
46
+ /**
47
+ * Import package
48
+ * Import a data package.
49
+ * @param container The key of the container content where new content items should be created under.
50
+ * @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
51
+ * content item with the same key.
52
+ * If set to `false`, always create new content item under the specified container regardless of the content key.
53
+ * @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
54
+ * @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
55
+ * then content in all locales are imported.
56
+ * @param requestBody
57
+ * @returns ImportPackageResult OK
58
+ * @returns PackageJob Accepted
59
+ * @throws ApiError
60
+ */
61
+ packagesImport(container, overwriteExistingContentItems = false, ignoreDataLossWarnings = false, locale, requestBody) {
62
+ return this.httpRequest.request({
63
+ method: 'POST',
64
+ url: '/packages',
65
+ query: {
66
+ 'container': container,
67
+ 'overwriteExistingContentItems': overwriteExistingContentItems,
68
+ 'ignoreDataLossWarnings': ignoreDataLossWarnings,
69
+ 'locale': locale,
70
+ },
71
+ body: requestBody,
72
+ mediaType: 'application/vnd.episerver.cms.data',
73
+ errors: {
74
+ 400: `Bad Request`,
75
+ 403: `Forbidden`,
76
+ },
77
+ });
78
+ }
79
+ }
80
+ exports.PackagesService = PackagesService;
@@ -1,26 +1,26 @@
1
- import type { PropertyFormat } from '../models/PropertyFormat';
2
- import type { PropertyFormatPage } from '../models/PropertyFormatPage';
3
- import type { CancelablePromise } from '../core/CancelablePromise';
4
- import type { BaseHttpRequest } from '../core/BaseHttpRequest';
5
- export declare class PropertyFormatsService {
6
- readonly httpRequest: BaseHttpRequest;
7
- constructor(httpRequest: BaseHttpRequest);
8
- /**
9
- * List property formats
10
- * List all property formats using the provided options.
11
- * @param pageIndex
12
- * @param pageSize
13
- * @returns PropertyFormatPage Success
14
- * @throws ApiError
15
- */
16
- propertyFormatsList(pageIndex?: number, pageSize?: number): CancelablePromise<PropertyFormatPage>;
17
- /**
18
- * Get property format
19
- * Get the property format with the provided key.
20
- * @param key The key of the property format to retrieve.
21
- * @param allowDeleted Indicates that a deleted property format may be returned.
22
- * @returns PropertyFormat Success
23
- * @throws ApiError
24
- */
25
- propertyFormatsGet(key: string, allowDeleted?: boolean): CancelablePromise<PropertyFormat>;
26
- }
1
+ import type { PropertyFormat } from '../models/PropertyFormat';
2
+ import type { PropertyFormatPage } from '../models/PropertyFormatPage';
3
+ import type { CancelablePromise } from '../core/CancelablePromise';
4
+ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
5
+ export declare class PropertyFormatsService {
6
+ readonly httpRequest: BaseHttpRequest;
7
+ constructor(httpRequest: BaseHttpRequest);
8
+ /**
9
+ * List property formats
10
+ * List all property formats using the provided options.
11
+ * @param pageIndex
12
+ * @param pageSize
13
+ * @returns PropertyFormatPage OK
14
+ * @throws ApiError
15
+ */
16
+ propertyFormatsList(pageIndex?: number, pageSize?: number): CancelablePromise<PropertyFormatPage>;
17
+ /**
18
+ * Get property format
19
+ * Get the property format with the provided key.
20
+ * @param key The key of the property format to retrieve.
21
+ * @param allowDeleted Indicates that a deleted property format may be returned.
22
+ * @returns PropertyFormat OK
23
+ * @throws ApiError
24
+ */
25
+ propertyFormatsGet(key: string, allowDeleted?: boolean): CancelablePromise<PropertyFormat>;
26
+ }