@remkoj/optimizely-cms-api 5.2.0 → 5.3.0

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

@@ -7,11 +7,10 @@ export declare class ContentTypesService {
     constructor(httpRequest: BaseHttpRequest);
     /**
      * List content types
-     * List content types using the provided options.
+     * List content types using the provided parameters.
      * @param forContainerType Only include types that are available for creation under the provided container type
      * @param sources Indicates which sources should be included when listing content types.
-     * Use All to include content types from all sources or
-     * Default to include content types without a specific sources.
+     * Use 'DEFAULT' to include content types without a specific source.
      * @param pageIndex
      * @param pageSize
      * @returns ContentTypePage OK
@@ -21,8 +20,8 @@ export declare class ContentTypesService {
     /**
      * Create content type
      * Create a new content type.
-     * @param requestBody The content type that should be created.
-     * @returns ContentType OK
+     * @param requestBody The content type that should be created or replaced.
+     * @returns ContentType Created
      * @throws ApiError
      */
     contentTypesCreate(requestBody: ContentType): CancelablePromise<ContentType>;
@@ -30,37 +29,32 @@ export declare class ContentTypesService {
      * Get content type
      * Get the content type with the provided key.
      * @param key The key of the content type 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 ContentType OK
      * @throws ApiError
      */
-    contentTypesGet(key: string): CancelablePromise<ContentType>;
-    /**
-     * Create or replace content type
-     * Create or replace a content type. If a content type with the provided key exist it is replaced.
-     * Otherwise a new content type is created.
-     * @param key The key of the content type to update or create.
-     * @param requestBody The values of the created or replaced content type.
-     * @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesPut(key: string, requestBody: ContentType, ignoreDataLossWarnings?: boolean): CancelablePromise<ContentType>;
+    contentTypesGet(key: string, ifNoneMatch?: string, ifModifiedSince?: string): CancelablePromise<ContentType>;
     /**
-     * Update content type
-     * Update an existing content type. If a content type with the provided key does not exist an error is returned.
+     * Patch content type
+     * Patch an existing content type. If a content type with the provided key does not exist an error is returned.
      * @param key The key of the content type to patch.
-     * @param requestBody The values of the content type that should be updated.
-     * @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
+     * @param requestBody The values of the content type that should be patched formatted according to RFC7396.
+     * @param cmsIgnoreDataLossWarnings Patch the content type even though the changes might result in data loss.
+     * @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 ContentType OK
      * @throws ApiError
      */
-    contentTypesPatch(key: string, requestBody: ContentType, ignoreDataLossWarnings?: boolean): CancelablePromise<ContentType>;
+    contentTypesPatch(key: string, requestBody: ContentType, cmsIgnoreDataLossWarnings?: boolean, ifMatch?: string, ifUnmodifiedSince?: string): CancelablePromise<ContentType>;
     /**
      * Delete content type
      * Deletes the content type with the provided key. If a content type with the provided key does not exist an error is returned.
      * @param key The key of the content type 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 ContentType OK
      * @throws ApiError
      */
-    contentTypesDelete(key: string): CancelablePromise<ContentType>;
+    contentTypesDelete(key: string, ifMatch?: string, ifUnmodifiedSince?: string): CancelablePromise<ContentType>;
 }

package/dist/client/services/ContentTypesService.js

@@ -7,11 +7,10 @@ class ContentTypesService {
     }
     /**
      * List content types
-     * List content types using the provided options.
+     * List content types using the provided parameters.
      * @param forContainerType Only include types that are available for creation under the provided container type
      * @param sources Indicates which sources should be included when listing content types.
-     * Use All to include content types from all sources or
-     * Default to include content types without a specific sources.
+     * Use 'DEFAULT' to include content types without a specific source.
      * @param pageIndex
      * @param pageSize
      * @returns ContentTypePage OK
@@ -35,8 +34,8 @@ class ContentTypesService {
     /**
      * Create content type
      * Create a new content type.
-     * @param requestBody The content type that should be created.
-     * @returns ContentType OK
+     * @param requestBody The content type that should be created or replaced.
+     * @returns ContentType Created
      * @throws ApiError
      */
     contentTypesCreate(requestBody) {
@@ -55,73 +54,59 @@ class ContentTypesService {
      * Get content type
      * Get the content type with the provided key.
      * @param key The key of the content type 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 ContentType OK
      * @throws ApiError
      */
-    contentTypesGet(key) {
+    contentTypesGet(key, ifNoneMatch, ifModifiedSince) {
         return this.httpRequest.request({
             method: 'GET',
             url: '/contenttypes/{key}',
             path: {
                 'key': key,
             },
-            errors: {
-                403: `Forbidden`,
+            headers: {
+                'If-None-Match': ifNoneMatch,
+                'If-Modified-Since': ifModifiedSince,
             },
-        });
-    }
-    /**
-     * Create or replace content type
-     * Create or replace a content type. If a content type with the provided key exist it is replaced.
-     * Otherwise a new content type is created.
-     * @param key The key of the content type to update or create.
-     * @param requestBody The values of the created or replaced content type.
-     * @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
-     * @returns ContentType OK
-     * @throws ApiError
-     */
-    contentTypesPut(key, requestBody, ignoreDataLossWarnings) {
-        return this.httpRequest.request({
-            method: 'PUT',
-            url: '/contenttypes/{key}',
-            path: {
-                'key': key,
-            },
-            query: {
-                'ignoreDataLossWarnings': ignoreDataLossWarnings,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
             errors: {
-                400: `Bad Request`,
+                304: `Not Modified`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }
     /**
-     * Update content type
-     * Update an existing content type. If a content type with the provided key does not exist an error is returned.
+     * Patch content type
+     * Patch an existing content type. If a content type with the provided key does not exist an error is returned.
      * @param key The key of the content type to patch.
-     * @param requestBody The values of the content type that should be updated.
-     * @param ignoreDataLossWarnings Update the content type even though the changes might result in data loss.
+     * @param requestBody The values of the content type that should be patched formatted according to RFC7396.
+     * @param cmsIgnoreDataLossWarnings Patch the content type even though the changes might result in data loss.
+     * @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 ContentType OK
      * @throws ApiError
      */
-    contentTypesPatch(key, requestBody, ignoreDataLossWarnings) {
+    contentTypesPatch(key, requestBody, cmsIgnoreDataLossWarnings, ifMatch, ifUnmodifiedSince) {
         return this.httpRequest.request({
             method: 'PATCH',
             url: '/contenttypes/{key}',
             path: {
                 'key': key,
             },
-            query: {
-                'ignoreDataLossWarnings': ignoreDataLossWarnings,
+            headers: {
+                'cms-ignore-data-loss-warnings': cmsIgnoreDataLossWarnings,
+                '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`,
             },
         });
     }
@@ -129,19 +114,27 @@ class ContentTypesService {
      * Delete content type
      * Deletes the content type with the provided key. If a content type with the provided key does not exist an error is returned.
      * @param key The key of the content type 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 ContentType OK
      * @throws ApiError
      */
-    contentTypesDelete(key) {
+    contentTypesDelete(key, ifMatch, ifUnmodifiedSince) {
         return this.httpRequest.request({
             method: 'DELETE',
             url: '/contenttypes/{key}',
             path: {
                 'key': key,
             },
+            headers: {
+                'If-Match': ifMatch,
+                'If-Unmodified-Since': ifUnmodifiedSince,
+            },
             errors: {
                 400: `Bad Request`,
                 403: `Forbidden`,
+                404: `Not Found`,
+                412: `Precondition Failed`,
             },
         });
     }

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

@@ -7,7 +7,7 @@ export declare class DisplayTemplatesService {
     constructor(httpRequest: BaseHttpRequest);
     /**
      * List display templates
-     * List display templates using the provided options.
+     * List display templates using the provided parameters.
      * @param pageIndex
      * @param pageSize
      * @returns DisplayTemplatePage OK
@@ -18,7 +18,7 @@ export declare class DisplayTemplatesService {
      * Create display template
      * Create a new display template.
      * @param requestBody The display template that should be created.
-     * @returns DisplayTemplate OK
+     * @returns DisplayTemplate Created
      * @throws ApiError
      */
     displayTemplatesCreate(requestBody: DisplayTemplate): CancelablePromise<DisplayTemplate>;
@@ -26,35 +26,31 @@ export declare class DisplayTemplatesService {
      * Get display template
      * Get the display template with the provided key.
      * @param key The key of the display template 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 DisplayTemplate OK
      * @throws ApiError
      */
-    displayTemplatesGet(key: string): CancelablePromise<DisplayTemplate>;
-    /**
-     * Create or replace a display template
-     * Create or replace a display template. If a display template with the provided key exist it is replaced.
-     * Otherwise a new display template is created.
-     * @param key The key of the display template to update or create.
-     * @param requestBody The values of the created or replaced display template.
-     * @returns DisplayTemplate OK
-     * @throws ApiError
-     */
-    displayTemplatesPut(key: string, requestBody: DisplayTemplate): CancelablePromise<DisplayTemplate>;
+    displayTemplatesGet(key: string, ifNoneMatch?: string, ifModifiedSince?: string): CancelablePromise<DisplayTemplate>;
     /**
-     * Update display template
-     * Update an existing display template.
+     * Patch display template
+     * Patch an existing display template.
      * @param key The key of the display template to patch.
-     * @param requestBody The values of the display template that should be updated.
+     * @param requestBody The values of the display template 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 DisplayTemplate OK
      * @throws ApiError
      */
-    displayTemplatesPatch(key: string, requestBody: DisplayTemplate): CancelablePromise<DisplayTemplate>;
+    displayTemplatesPatch(key: string, requestBody: DisplayTemplate, ifMatch?: string, ifUnmodifiedSince?: string): CancelablePromise<DisplayTemplate>;
     /**
      * Delete display template
      * Deletes the display template with the provided key.
      * @param key The key of the display template 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 DisplayTemplate OK
      * @throws ApiError
      */
-    displayTemplatesDelete(key: string): CancelablePromise<DisplayTemplate>;
+    displayTemplatesDelete(key: string, ifMatch?: string, ifUnmodifiedSince?: string): CancelablePromise<DisplayTemplate>;
 }

package/dist/client/services/DisplayTemplatesService.js

@@ -7,7 +7,7 @@ class DisplayTemplatesService {
     }
     /**
      * List display templates
-     * List display templates using the provided options.
+     * List display templates using the provided parameters.
      * @param pageIndex
      * @param pageSize
      * @returns DisplayTemplatePage OK
@@ -30,7 +30,7 @@ class DisplayTemplatesService {
      * Create display template
      * Create a new display template.
      * @param requestBody The display template that should be created.
-     * @returns DisplayTemplate OK
+     * @returns DisplayTemplate Created
      * @throws ApiError
      */
     displayTemplatesCreate(requestBody) {
@@ -49,65 +49,57 @@ class DisplayTemplatesService {
      * Get display template
      * Get the display template with the provided key.
      * @param key The key of the display template 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 DisplayTemplate OK
      * @throws ApiError
      */
-    displayTemplatesGet(key) {
+    displayTemplatesGet(key, ifNoneMatch, ifModifiedSince) {
         return this.httpRequest.request({
             method: 'GET',
             url: '/displaytemplates/{key}',
             path: {
                 'key': key,
             },
-            errors: {
-                403: `Forbidden`,
+            headers: {
+                'If-None-Match': ifNoneMatch,
+                'If-Modified-Since': ifModifiedSince,
             },
-        });
-    }
-    /**
-     * Create or replace a display template
-     * Create or replace a display template. If a display template with the provided key exist it is replaced.
-     * Otherwise a new display template is created.
-     * @param key The key of the display template to update or create.
-     * @param requestBody The values of the created or replaced display template.
-     * @returns DisplayTemplate OK
-     * @throws ApiError
-     */
-    displayTemplatesPut(key, requestBody) {
-        return this.httpRequest.request({
-            method: 'PUT',
-            url: '/displaytemplates/{key}',
-            path: {
-                'key': key,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
             errors: {
-                400: `Bad Request`,
+                304: `Not Modified`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }
     /**
-     * Update display template
-     * Update an existing display template.
+     * Patch display template
+     * Patch an existing display template.
      * @param key The key of the display template to patch.
-     * @param requestBody The values of the display template that should be updated.
+     * @param requestBody The values of the display template 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 DisplayTemplate OK
      * @throws ApiError
      */
-    displayTemplatesPatch(key, requestBody) {
+    displayTemplatesPatch(key, requestBody, ifMatch, ifUnmodifiedSince) {
         return this.httpRequest.request({
             method: 'PATCH',
             url: '/displaytemplates/{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`,
             },
         });
     }
@@ -115,19 +107,27 @@ class DisplayTemplatesService {
      * Delete display template
      * Deletes the display template with the provided key.
      * @param key The key of the display template 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 DisplayTemplate OK
      * @throws ApiError
      */
-    displayTemplatesDelete(key) {
+    displayTemplatesDelete(key, ifMatch, ifUnmodifiedSince) {
         return this.httpRequest.request({
             method: 'DELETE',
             url: '/displaytemplates/{key}',
             path: {
                 'key': key,
             },
+            headers: {
+                'If-Match': ifMatch,
+                'If-Unmodified-Since': ifUnmodifiedSince,
+            },
             errors: {
                 400: `Bad Request`,
                 403: `Forbidden`,
+                404: `Not Found`,
+                412: `Precondition Failed`,
             },
         });
     }

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

@@ -19,8 +19,10 @@ export declare class PropertyFormatsService {
      * Get the property format with the provided key.
      * @param key The key of the property format to retrieve.
      * @param allowDeleted Indicates that a deleted property format may be returned.
+     * @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 PropertyFormat OK
      * @throws ApiError
      */
-    propertyFormatsGet(key: string, allowDeleted?: boolean): CancelablePromise<PropertyFormat>;
+    propertyFormatsGet(key: string, allowDeleted?: boolean, ifNoneMatch?: string, ifModifiedSince?: string): CancelablePromise<PropertyFormat>;
 }

package/dist/client/services/PropertyFormatsService.js

@@ -31,21 +31,29 @@ class PropertyFormatsService {
      * Get the property format with the provided key.
      * @param key The key of the property format to retrieve.
      * @param allowDeleted Indicates that a deleted property format may be returned.
+     * @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 PropertyFormat OK
      * @throws ApiError
      */
-    propertyFormatsGet(key, allowDeleted) {
+    propertyFormatsGet(key, allowDeleted, ifNoneMatch, ifModifiedSince) {
         return this.httpRequest.request({
             method: 'GET',
             url: '/propertyformats/{key}',
             path: {
                 'key': key,
             },
+            headers: {
+                'If-None-Match': ifNoneMatch,
+                'If-Modified-Since': ifModifiedSince,
+            },
             query: {
                 'allowDeleted': allowDeleted,
             },
             errors: {
+                304: `Not Modified`,
                 403: `Forbidden`,
+                404: `Not Found`,
             },
         });
     }

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

@@ -8,9 +8,8 @@ export declare class PropertyGroupsService {
     /**
      * List property groups
      * List property groups using the provided options.
-     * @param sources Indicates which property groups sources that should be listed.
-     * Use All to include groups from all sources or
-     * Default to include groups without a specific sources.
+     * @param sources Indicates which property groups sources should be listed.
+     * Use 'DEFAULT' to include groups without a specific sources.
      * @returns PropertyGroupPage OK
      * @throws ApiError
      */
@@ -19,7 +18,7 @@ export declare class PropertyGroupsService {
      * Create property group
      * Create a new property group.
      * @param requestBody The property group that should be created.
-     * @returns PropertyGroup OK
+     * @returns PropertyGroup Created
      * @throws ApiError
      */
     propertyGroupsCreate(requestBody: PropertyGroup): CancelablePromise<PropertyGroup>;
@@ -27,35 +26,31 @@ export declare class PropertyGroupsService {
      * Get property group
      * Get the property group with the provided key.
      * @param key The key of the property group 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 PropertyGroup OK
      * @throws ApiError
      */
-    propertyGroupsGet(key: string): CancelablePromise<PropertyGroup>;
-    /**
-     * Create or replace property group
-     * Create or replace a property group. If a property group with the provided key exist it is replaced.
-     * Otherwise a new property group is created.
-     * @param key The key of the property group to update or create.
-     * @param requestBody The values of the created or replaced property group.
-     * @returns PropertyGroup OK
-     * @throws ApiError
-     */
-    propertyGroupsPut(key: string, requestBody: PropertyGroup): CancelablePromise<PropertyGroup>;
+    propertyGroupsGet(key: string, ifNoneMatch?: string, ifModifiedSince?: string): CancelablePromise<PropertyGroup>;
     /**
-     * Update property group
-     * Update an existing property group.
+     * Patch property group
+     * Patch an existing property group.
      * @param key The key of the property group to patch.
-     * @param requestBody The values of the property group that should be updated.
+     * @param requestBody The values of the property group 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 PropertyGroup OK
      * @throws ApiError
      */
-    propertyGroupsPatch(key: string, requestBody: PropertyGroup): CancelablePromise<PropertyGroup>;
+    propertyGroupsPatch(key: string, requestBody: PropertyGroup, ifMatch?: string, ifUnmodifiedSince?: string): CancelablePromise<PropertyGroup>;
     /**
      * Delete property group
      * Deletes the property group with the provided key.
      * @param key The key of the property group 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 PropertyGroup OK
      * @throws ApiError
      */
-    propertyGroupsDelete(key: string): CancelablePromise<PropertyGroup>;
+    propertyGroupsDelete(key: string, ifMatch?: string, ifUnmodifiedSince?: string): CancelablePromise<PropertyGroup>;
 }