@remkoj/optimizely-cms-api 5.2.0 → 5.3.0

package/dist/client/services/BlueprintsService.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlueprintsService = void 0;
+class BlueprintsService {
+    constructor(httpRequest) {
+        this.httpRequest = httpRequest;
+    }
+    /**
+     * List blueprints
+     * List blueprints using the provided parameters. This API is experimental and may change in future releases.
+     * @param pageIndex
+     * @param pageSize
+     * @returns BlueprintPage OK
+     * @throws ApiError
+     */
+    blueprintsList(pageIndex, pageSize) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/experimental/blueprints',
+            query: {
+                'pageIndex': pageIndex,
+                'pageSize': pageSize,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Create a blueprint
+     * Create a new blueprint. This API is experimental and may change in future releases.
+     * @param requestBody The blueprint that should be created.
+     * @returns Blueprint Created
+     * @throws ApiError
+     */
+    blueprintsCreate(requestBody) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/experimental/blueprints',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Get a specific blueprint
+     * Get the blueprint with the provided key. This API is experimental and may change in future releases.
+     * @param key The key of the blueprint to retrieve.
+     * @param ifNoneMatch If provided and the value matches the RFC7232 ETag of the current resource a 304 NotModified response will be returned. Weak ETags will always be ignored.
+     * @param ifModifiedSince If provided and the resource has not been modified since the date a 304 NotModified response will be returned. This parameter will be ignored if an 'If-None-Match' parameter is also provided.
+     * @returns Blueprint OK
+     * @throws ApiError
+     */
+    blueprintsGet(key, ifNoneMatch, ifModifiedSince) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/experimental/blueprints/{key}',
+            path: {
+                'key': key,
+            },
+            headers: {
+                'If-None-Match': ifNoneMatch,
+                'If-Modified-Since': ifModifiedSince,
+            },
+            errors: {
+                304: `Not Modified`,
+                403: `Forbidden`,
+                404: `Not Found`,
+            },
+        });
+    }
+    /**
+     * Patch blueprint
+     * Patch an existing blueprint. This API is experimental and may change in future releases.
+     * @param key The key of the blueprint to patch.
+     * @param requestBody The values of the blueprint that should be patched formatted according to RFC7396.
+     * @param ifMatch If provided, the PATCH request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
+     * @param ifUnmodifiedSince If provided, the PATCH request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
+     * @returns Blueprint OK
+     * @throws ApiError
+     */
+    blueprintsPatch(key, requestBody, ifMatch, ifUnmodifiedSince) {
+        return this.httpRequest.request({
+            method: 'PATCH',
+            url: '/experimental/blueprints/{key}',
+            path: {
+                'key': key,
+            },
+            headers: {
+                'If-Match': ifMatch,
+                'If-Unmodified-Since': ifUnmodifiedSince,
+            },
+            body: requestBody,
+            mediaType: 'application/merge-patch+json',
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+                404: `Not Found`,
+                412: `Precondition Failed`,
+            },
+        });
+    }
+    /**
+     * Delete a blueprint
+     * Deletes the blueprint with the provided key. This API is experimental and may change in future releases.
+     * @param key The key of the blueprint to delete.
+     * @param ifMatch If provided, the DELETE request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
+     * @param ifUnmodifiedSince If provided, the DELETE request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
+     * @returns Blueprint OK
+     * @throws ApiError
+     */
+    blueprintsDelete(key, ifMatch, ifUnmodifiedSince) {
+        return this.httpRequest.request({
+            method: 'DELETE',
+            url: '/experimental/blueprints/{key}',
+            path: {
+                'key': key,
+            },
+            headers: {
+                'If-Match': ifMatch,
+                'If-Unmodified-Since': ifUnmodifiedSince,
+            },
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+                404: `Not Found`,
+                412: `Precondition Failed`,
+            },
+        });
+    }
+}
+exports.BlueprintsService = BlueprintsService;

package/dist/client/services/ChangesetsService.d.ts

@@ -9,50 +9,53 @@ export declare class ChangesetsService {
     constructor(httpRequest: BaseHttpRequest);
     /**
      * List changeset
-     * Lists all changeset using the provided options.
+     * Lists all changeset using the provided options. This API is experimental and may change in future releases.
+     * @param sources Indicates which sources should be included when listing changesets.
+     * Use Default to include changesets without a specific sources.
      * @param pageIndex
      * @param pageSize
      * @returns ChangesetPage OK
      * @throws ApiError
      */
-    changesetsList(pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetPage>;
+    changesetsList(sources?: Array<string>, pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetPage>;
     /**
      * Create changeset
-     * Creates a new changeset.
+     * Creates a new changeset. This API is experimental and may change in future releases.
      * @param requestBody The changeset that should be created.
-     * @returns Changeset OK
+     * @returns Changeset Created
      * @throws ApiError
      */
     changesetsCreate(requestBody: Changeset): CancelablePromise<Changeset>;
     /**
      * Get changeset
-     * Gets the changeset with the provided key.
+     * Gets the changeset with the provided key. This API is experimental and may change in future releases.
      * @param key The key of the changeset to retrieve.
+     * @param ifNoneMatch If provided and the value matches the RFC7232 ETag of the current resource a 304 NotModified response will be returned. Weak ETags will always be ignored.
+     * @param ifModifiedSince If provided and the resource has not been modified since the date a 304 NotModified response will be returned. This parameter will be ignored if an 'If-None-Match' parameter is also provided.
      * @returns Changeset OK
      * @throws ApiError
      */
-    changesetsGet(key: string): CancelablePromise<Changeset>;
+    changesetsGet(key: string, ifNoneMatch?: string, ifModifiedSince?: string): CancelablePromise<Changeset>;
     /**
      * Delete changeset
-     * Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned.
+     * Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned. This API is experimental and may change in future releases.
      * @param key The key of the changeset to delete.
      * @returns Changeset OK
      * @throws ApiError
      */
     changesetsDelete(key: string): CancelablePromise<Changeset>;
     /**
-     * Create or replace changeset
-     * Creates or replaces a changeset. If a changeset with the provided key exist it is replaced.
-     * Otherwise a new changeset is created.
-     * @param key The key of the changeset to update or create.
-     * @param requestBody The values of the created or replaced changeset.
+     * Patch changeset
+     * Patch an existing changeset. This API is experimental and may change in future releases.
+     * @param key The key of the changeset to patch.
+     * @param requestBody The values of the changeset that should be patched formatted according to RFC7396.
      * @returns Changeset OK
      * @throws ApiError
      */
-    changesetsPut(key: string, requestBody: Changeset): CancelablePromise<Changeset>;
+    changesetsPatch(key: string, requestBody: Changeset): CancelablePromise<Changeset>;
     /**
      * Get changeset item
-     * Gets the changeset item for the specified content reference.
+     * Gets the changeset item for the specified content reference. This API is experimental and may change in future releases.
      * @param changeset The changeset key
      * @param key The content key
      * @param version The content version
@@ -60,9 +63,20 @@ export declare class ChangesetsService {
      * @throws ApiError
      */
     changesetsGetItem(changeset: string, key: string, version: string): CancelablePromise<ChangesetItem>;
+    /**
+     * Patch changeset item
+     * Patch the given changeset item. This API is experimental and may change in future releases.
+     * @param changeset The changeset key
+     * @param key The content key
+     * @param version The content version
+     * @param requestBody The values of the changeset item that should be patched formatted according to RFC7396.
+     * @returns ChangesetItem OK
+     * @throws ApiError
+     */
+    changesetsPatchItem(changeset: string, key: string, version: string, requestBody: ChangesetItem): CancelablePromise<ChangesetItem>;
     /**
      * Delete changeset item
-     * Deletes the specified changeset item from the changeset.
+     * Deletes the specified changeset item from the changeset. This API is experimental and may change in future releases.
      * @param changeset The changeset key
      * @param key The content key
      * @param version The content version
@@ -73,7 +87,7 @@ export declare class ChangesetsService {
     /**
      * List changeset items
      * Lists the available changeset items for the specified changeset using
-     * the provided options.
+     * the provided options. This API is experimental and may change in future releases.
      * @param changeset The changeset key
      * @param pageIndex
      * @param pageSize
@@ -83,23 +97,11 @@ export declare class ChangesetsService {
     changesetsListItems(changeset: string, pageIndex?: number, pageSize?: number): CancelablePromise<ChangesetItemPage>;
     /**
      * Create changeset item
-     * Creates the given changeset item.
+     * Creates the given changeset item. This API is experimental and may change in future releases.
      * @param changeset The changeset key
      * @param requestBody The changeset item
-     * @returns ChangesetItem OK
+     * @returns ChangesetItem Created
      * @throws ApiError
      */
     changesetsCreateItem(changeset: string, requestBody: ChangesetItem): CancelablePromise<ChangesetItem>;
-    /**
-     * Update changeset item
-     * Updates the given changeset item.
-     * @param changeset The changeset key
-     * @param contentKey The content key
-     * @param contentVersion The content version
-     * @param requestBody The changeset item
-     * @param allowCreate Indicates if a new changeset item should be created if it does not exist
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsUpdateItem(changeset: string, contentKey: string, contentVersion: string, requestBody: ChangesetItem, allowCreate?: boolean): CancelablePromise<ChangesetItem>;
 }

package/dist/client/services/ChangesetsService.js

@@ -7,17 +7,20 @@ class ChangesetsService {
     }
     /**
      * List changeset
-     * Lists all changeset using the provided options.
+     * Lists all changeset using the provided options. This API is experimental and may change in future releases.
+     * @param sources Indicates which sources should be included when listing changesets.
+     * Use Default to include changesets without a specific sources.
      * @param pageIndex
      * @param pageSize
      * @returns ChangesetPage OK
      * @throws ApiError
      */
-    changesetsList(pageIndex, pageSize) {
+    changesetsList(sources, pageIndex, pageSize) {
         return this.httpRequest.request({
             method: 'GET',
-            url: '/changesets',
+            url: '/experimental/changesets',
             query: {
+                'sources': sources,
                 'pageIndex': pageIndex,
                 'pageSize': pageSize,
             },
@@ -28,15 +31,15 @@ class ChangesetsService {
     }
     /**
      * Create changeset
-     * Creates a new changeset.
+     * Creates a new changeset. This API is experimental and may change in future releases.
      * @param requestBody The changeset that should be created.
-     * @returns Changeset OK
+     * @returns Changeset Created
      * @throws ApiError
      */
     changesetsCreate(requestBody) {
         return this.httpRequest.request({
             method: 'POST',
-            url: '/changesets',
+            url: '/experimental/changesets',
             body: requestBody,
             mediaType: 'application/json',
             errors: {
@@ -47,26 +50,34 @@ class ChangesetsService {
     }
     /**
      * Get changeset
-     * Gets the changeset with the provided key.
+     * Gets the changeset with the provided key. This API is experimental and may change in future releases.
      * @param key The key of the changeset to retrieve.
+     * @param ifNoneMatch If provided and the value matches the RFC7232 ETag of the current resource a 304 NotModified response will be returned. Weak ETags will always be ignored.
+     * @param ifModifiedSince If provided and the resource has not been modified since the date a 304 NotModified response will be returned. This parameter will be ignored if an 'If-None-Match' parameter is also provided.
      * @returns Changeset OK
      * @throws ApiError
      */
-    changesetsGet(key) {
+    changesetsGet(key, ifNoneMatch, ifModifiedSince) {
         return this.httpRequest.request({
             method: 'GET',
-            url: '/changesets/{key}',
+            url: '/experimental/changesets/{key}',
             path: {
                 'key': key,
             },
+            headers: {
+                'If-None-Match': ifNoneMatch,
+                'If-Modified-Since': ifModifiedSince,
+            },
             errors: {
+                304: `Not Modified`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }
     /**
      * Delete changeset
-     * Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned.
+     * Deletes the changeset with the provided key. If a changeset with the provided key does not exist an error is returned. This API is experimental and may change in future releases.
      * @param key The key of the changeset to delete.
      * @returns Changeset OK
      * @throws ApiError
@@ -74,43 +85,44 @@ class ChangesetsService {
     changesetsDelete(key) {
         return this.httpRequest.request({
             method: 'DELETE',
-            url: '/changesets/{key}',
+            url: '/experimental/changesets/{key}',
             path: {
                 'key': key,
             },
             errors: {
                 400: `Bad Request`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }
     /**
-     * Create or replace changeset
-     * Creates or replaces a changeset. If a changeset with the provided key exist it is replaced.
-     * Otherwise a new changeset is created.
-     * @param key The key of the changeset to update or create.
-     * @param requestBody The values of the created or replaced changeset.
+     * Patch changeset
+     * Patch an existing changeset. This API is experimental and may change in future releases.
+     * @param key The key of the changeset to patch.
+     * @param requestBody The values of the changeset that should be patched formatted according to RFC7396.
      * @returns Changeset OK
      * @throws ApiError
      */
-    changesetsPut(key, requestBody) {
+    changesetsPatch(key, requestBody) {
         return this.httpRequest.request({
-            method: 'PUT',
-            url: '/changesets/{key}',
+            method: 'PATCH',
+            url: '/experimental/changesets/{key}',
             path: {
                 'key': key,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: 'application/merge-patch+json',
             errors: {
                 400: `Bad Request`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }
     /**
      * Get changeset item
-     * Gets the changeset item for the specified content reference.
+     * Gets the changeset item for the specified content reference. This API is experimental and may change in future releases.
      * @param changeset The changeset key
      * @param key The content key
      * @param version The content version
@@ -120,20 +132,49 @@ class ChangesetsService {
     changesetsGetItem(changeset, key, version) {
         return this.httpRequest.request({
             method: 'GET',
-            url: '/changesets/{changeset}/items/{key}/versions/{version}',
+            url: '/experimental/changesets/{changeset}/items/{key}/versions/{version}',
+            path: {
+                'changeset': changeset,
+                'key': key,
+                'version': version,
+            },
+            errors: {
+                403: `Forbidden`,
+                404: `Not Found`,
+            },
+        });
+    }
+    /**
+     * Patch changeset item
+     * Patch the given changeset item. This API is experimental and may change in future releases.
+     * @param changeset The changeset key
+     * @param key The content key
+     * @param version The content version
+     * @param requestBody The values of the changeset item that should be patched formatted according to RFC7396.
+     * @returns ChangesetItem OK
+     * @throws ApiError
+     */
+    changesetsPatchItem(changeset, key, version, requestBody) {
+        return this.httpRequest.request({
+            method: 'PATCH',
+            url: '/experimental/changesets/{changeset}/items/{key}/versions/{version}',
             path: {
                 'changeset': changeset,
                 'key': key,
                 'version': version,
             },
+            body: requestBody,
+            mediaType: 'application/merge-patch+json',
             errors: {
+                400: `Bad Request`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }
     /**
      * Delete changeset item
-     * Deletes the specified changeset item from the changeset.
+     * Deletes the specified changeset item from the changeset. This API is experimental and may change in future releases.
      * @param changeset The changeset key
      * @param key The content key
      * @param version The content version
@@ -143,7 +184,7 @@ class ChangesetsService {
     changesetsDeleteItem(changeset, key, version) {
         return this.httpRequest.request({
             method: 'DELETE',
-            url: '/changesets/{changeset}/items/{key}/versions/{version}',
+            url: '/experimental/changesets/{changeset}/items/{key}/versions/{version}',
             path: {
                 'changeset': changeset,
                 'key': key,
@@ -152,13 +193,14 @@ class ChangesetsService {
             errors: {
                 400: `Bad Request`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }
     /**
      * List changeset items
      * Lists the available changeset items for the specified changeset using
-     * the provided options.
+     * the provided options. This API is experimental and may change in future releases.
      * @param changeset The changeset key
      * @param pageIndex
      * @param pageSize
@@ -168,7 +210,7 @@ class ChangesetsService {
     changesetsListItems(changeset, pageIndex, pageSize) {
         return this.httpRequest.request({
             method: 'GET',
-            url: '/changesets/{changeset}/items',
+            url: '/experimental/changesets/{changeset}/items',
             path: {
                 'changeset': changeset,
             },
@@ -178,60 +220,31 @@ class ChangesetsService {
             },
             errors: {
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }
     /**
      * Create changeset item
-     * Creates the given changeset item.
+     * Creates the given changeset item. This API is experimental and may change in future releases.
      * @param changeset The changeset key
      * @param requestBody The changeset item
-     * @returns ChangesetItem OK
+     * @returns ChangesetItem Created
      * @throws ApiError
      */
     changesetsCreateItem(changeset, requestBody) {
         return this.httpRequest.request({
             method: 'POST',
-            url: '/changesets/{changeset}/items',
-            path: {
-                'changeset': changeset,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Update changeset item
-     * Updates the given changeset item.
-     * @param changeset The changeset key
-     * @param contentKey The content key
-     * @param contentVersion The content version
-     * @param requestBody The changeset item
-     * @param allowCreate Indicates if a new changeset item should be created if it does not exist
-     * @returns ChangesetItem OK
-     * @throws ApiError
-     */
-    changesetsUpdateItem(changeset, contentKey, contentVersion, requestBody, allowCreate) {
-        return this.httpRequest.request({
-            method: 'PUT',
-            url: '/changesets/{changeset}/items/{contentKey}/versions/{contentVersion}',
+            url: '/experimental/changesets/{changeset}/items',
             path: {
                 'changeset': changeset,
-                'contentKey': contentKey,
-                'contentVersion': contentVersion,
-            },
-            query: {
-                'allowCreate': allowCreate,
             },
             body: requestBody,
             mediaType: 'application/json',
             errors: {
                 400: `Bad Request`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }