@resolution/confluence-api-client 0.4.3 → 0.4.5

package/lib/openapi/v1/services/ContentPropertiesService.d.ts

@@ -28,12 +28,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
      * @scopes-beta read:content.property:confluence, write:content.property:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-post
      */
-    createContentProperty({ id, contentPropertyCreate, }: {
+    createContentProperty: ({ id, contentPropertyCreate, }: {
         /** The ID of the content to add the property to. */
         id: string;
         /** The content property to be created. */
         contentPropertyCreate: ContentPropertyCreate;
-    }): Promise<ContentPropertyV1>;
+    }) => Promise<ContentPropertyV1>;
     /**
      * Creates a property for an existing piece of content. For more information
      * about content properties, see [Confluence entity
@@ -56,14 +56,14 @@ export declare class ContentPropertiesService extends CommonHttpService {
      * @scopes-beta read:content.property:confluence, write:content.property:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-post
      */
-    createContentPropertyForKey({ id, key, contentPropertyCreateNoKey, }: {
+    createContentPropertyForKey: ({ id, key, contentPropertyCreateNoKey, }: {
         /** The ID of the content to add the property to. */
         id: string;
         /** The key of the content property. Required. */
         key: string;
         /** The content property to be created. */
         contentPropertyCreateNoKey: ContentPropertyCreateNoKey;
-    }): Promise<ContentPropertyV1>;
+    }) => Promise<ContentPropertyV1>;
     /**
      * Deletes a content property. For more information about content properties, see
      * [Confluence entity
@@ -78,12 +78,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
      * @scopes-beta write:content.property:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-delete
      */
-    deleteContentProperty({ id, key, }: {
+    deleteContentProperty: ({ id, key, }: {
         /** The ID of the content that the property belongs to. */
         id: string;
         /** The key of the property. */
         key: string;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Returns the properties for a piece of content. For more information
      * about content properties, see [Confluence entity
@@ -100,11 +100,11 @@ export declare class ContentPropertiesService extends CommonHttpService {
      * @scopes-beta read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-get
      */
-    getContentProperties({ id, key, expand, start, limit, }: {
+    getContentProperties: ({ id, key, expand, start, limit, }: {
         /** The ID of the content to be queried for its properties. */
         id: string;
         /** The key of the content property. */
-        key?: string[];
+        key?: string[] | undefined;
         /**
          * A multi-value parameter indicating which properties of the content to
          * expand. By default, the `version` object is expanded.
@@ -113,15 +113,15 @@ export declare class ContentPropertiesService extends CommonHttpService {
          * - `version` returns information about the version of the property, such
          * as the version number, when it was created, etc.
          */
-        expand?: ("content" | "version")[];
+        expand?: ("content" | "version")[] | undefined;
         /** The starting index of the returned properties. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of properties to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<ContentPropertyArray>;
+        limit?: number | undefined;
+    }) => Promise<ContentPropertyArray>;
     /**
      * Returns a content property for a piece of content. For more information, see
      * [Confluence entity
@@ -138,7 +138,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
      * @scopes-beta read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-get
      */
-    getContentProperty({ id, key, expand, status, }: {
+    getContentProperty: ({ id, key, expand, status, }: {
         /** The ID of the content to be queried for the property. */
         id: string;
         /** The key of the content property. */
@@ -151,7 +151,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
          * - `version` returns information about the version of the property, such
          * as the version number, when it was created, etc.
          */
-        expand?: ("content" | "version")[];
+        expand?: ("content" | "version")[] | undefined;
         /**
          * Filter the results to a set of content based on their status. If set to `any`,
          * content with any status is returned. By default it will fetch current and
@@ -165,8 +165,8 @@ export declare class ContentPropertiesService extends CommonHttpService {
          * - draft
          * - trashed
          */
-        status?: "any" | "archived" | "current" | "deleted" | "draft" | "trashed";
-    }): Promise<ContentPropertyV1>;
+        status?: "current" | "any" | "deleted" | "draft" | "trashed" | "archived" | undefined;
+    }) => Promise<ContentPropertyV1>;
     /**
      * Updates an existing content property. This method will also create a new
      * property for a piece of content, if the property key does not exist and
@@ -184,13 +184,13 @@ export declare class ContentPropertiesService extends CommonHttpService {
      * @scopes-beta read:content.property:confluence, write:content.property:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-put
      */
-    updateContentProperty({ id, key, contentPropertyUpdate, }: {
+    updateContentProperty: ({ id, key, contentPropertyUpdate, }: {
         /** The ID of the content that the property belongs to. */
         id: string;
         /** The key of the property. */
         key: string;
         /** The content property being updated. */
         contentPropertyUpdate: ContentPropertyUpdate;
-    }): Promise<ContentPropertyV1>;
+    }) => Promise<ContentPropertyV1>;
     static initialize(): void;
 }

package/lib/openapi/v1/services/ContentPropertiesService.js

@@ -14,240 +14,243 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
  * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties
  */
 class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Creates a property for an existing piece of content. For more information
-     * about content properties, see [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * This is the same as [Create content property for
-     * key](#api-content-id-property-key-post)
-     * except that the key is specified in the request body instead of as a
-     * path parameter.
-     *
-     * Content properties can also be added when creating a new piece of content
-     * by including them in the `metadata.properties` of the request.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to update the content.
-     *
-     * @deprecated
-     * @returns Returned if the content property is created.
-     * @path {POST} /wiki/rest/api/content/{id}/property
-     * @scopes-current write:confluence-props
-     * @scopes-beta read:content.property:confluence, write:content.property:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-post
-     */
-    createContentProperty({ id, contentPropertyCreate, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/content/{id}/property",
-            method: "POST",
-            pathParams: {
-                id,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: contentPropertyCreate,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createContentProperty.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Creates a property for an existing piece of content. For more information
-     * about content properties, see [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * This is the same as [Create content property](#api-content-id-property-post)
-     * except that the key is specified as a path parameter instead of in the
-     * request body.
-     *
-     * Content properties can also be added when creating a new piece of content
-     * by including them in the `metadata.properties` of the request.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to update the content.
-     *
-     * @deprecated
-     * @returns Returned if the content property is created.
-     * @path {POST} /wiki/rest/api/content/{id}/property/{key}
-     * @scopes-current write:confluence-props
-     * @scopes-beta read:content.property:confluence, write:content.property:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-post
-     */
-    createContentPropertyForKey({ id, key, contentPropertyCreateNoKey, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/content/{id}/property/{key}",
-            method: "POST",
-            pathParams: {
-                id,
-                key,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: contentPropertyCreateNoKey,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createContentPropertyForKey.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Deletes a content property. For more information about content properties, see
-     * [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to update the content.
-     *
-     * @deprecated
-     * @path {DELETE} /wiki/rest/api/content/{id}/property/{key}
-     * @scopes-current write:confluence-props
-     * @scopes-beta write:content.property:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-delete
-     */
-    deleteContentProperty({ id, key, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/content/{id}/property/{key}",
-            method: "DELETE",
-            pathParams: {
-                id,
-                key,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Returns the properties for a piece of content. For more information
-     * about content properties, see [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'View' permission for the space, and permission to view the content if it is a
-     * page.
-     *
-     * @deprecated
-     * @returns Returned if the requested properties are returned.
-     * @path {GET} /wiki/rest/api/content/{id}/property
-     * @scopes-current read:confluence-props
-     * @scopes-beta read:content-details:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-get
-     */
-    getContentProperties({ id, key, expand, start, limit, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/content/{id}/property",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-            query: {
-                key,
-                expand,
-                start,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getContentProperties.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns a content property for a piece of content. For more information, see
-     * [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * 'View' permission for the space, and permission to view the content if it is a
-     * page.
-     *
-     * @deprecated
-     * @returns Returned if the content property is returned.
-     * @path {GET} /wiki/rest/api/content/{id}/property/{key}
-     * @scopes-current read:confluence-props
-     * @scopes-beta read:content-details:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-get
-     */
-    getContentProperty({ id, key, expand, status, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/content/{id}/property/{key}",
-            method: "GET",
-            pathParams: {
-                id,
-                key,
-            },
-            query: {
-                expand,
-                status,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getContentProperty.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Updates an existing content property. This method will also create a new
-     * property for a piece of content, if the property key does not exist and
-     * the property version is 1. For more information about content properties, see
-     * [Confluence entity
-     * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to update the content.
-     *
-     * @deprecated
-     * @returns Returned if the content property is created.
-     * @path {PUT} /wiki/rest/api/content/{id}/property/{key}
-     * @scopes-current write:confluence-props
-     * @scopes-beta read:content.property:confluence, write:content.property:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-put
-     */
-    updateContentProperty({ id, key, contentPropertyUpdate, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/content/{id}/property/{key}",
-            method: "PUT",
-            pathParams: {
-                id,
-                key,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: contentPropertyUpdate,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateContentProperty.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Creates a property for an existing piece of content. For more information
+         * about content properties, see [Confluence entity
+         * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+         *
+         * This is the same as [Create content property for
+         * key](#api-content-id-property-key-post)
+         * except that the key is specified in the request body instead of as a
+         * path parameter.
+         *
+         * Content properties can also be added when creating a new piece of content
+         * by including them in the `metadata.properties` of the request.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to update the content.
+         *
+         * @deprecated
+         * @returns Returned if the content property is created.
+         * @path {POST} /wiki/rest/api/content/{id}/property
+         * @scopes-current write:confluence-props
+         * @scopes-beta read:content.property:confluence, write:content.property:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-post
+         */
+        this.createContentProperty = ({ id, contentPropertyCreate, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/content/{id}/property",
+                method: "POST",
+                pathParams: {
+                    id,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: contentPropertyCreate,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createContentProperty.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Creates a property for an existing piece of content. For more information
+         * about content properties, see [Confluence entity
+         * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+         *
+         * This is the same as [Create content property](#api-content-id-property-post)
+         * except that the key is specified as a path parameter instead of in the
+         * request body.
+         *
+         * Content properties can also be added when creating a new piece of content
+         * by including them in the `metadata.properties` of the request.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to update the content.
+         *
+         * @deprecated
+         * @returns Returned if the content property is created.
+         * @path {POST} /wiki/rest/api/content/{id}/property/{key}
+         * @scopes-current write:confluence-props
+         * @scopes-beta read:content.property:confluence, write:content.property:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-post
+         */
+        this.createContentPropertyForKey = ({ id, key, contentPropertyCreateNoKey, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/content/{id}/property/{key}",
+                method: "POST",
+                pathParams: {
+                    id,
+                    key,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: contentPropertyCreateNoKey,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createContentPropertyForKey.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Deletes a content property. For more information about content properties, see
+         * [Confluence entity
+         * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to update the content.
+         *
+         * @deprecated
+         * @path {DELETE} /wiki/rest/api/content/{id}/property/{key}
+         * @scopes-current write:confluence-props
+         * @scopes-beta write:content.property:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-delete
+         */
+        this.deleteContentProperty = ({ id, key, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/content/{id}/property/{key}",
+                method: "DELETE",
+                pathParams: {
+                    id,
+                    key,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Returns the properties for a piece of content. For more information
+         * about content properties, see [Confluence entity
+         * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'View' permission for the space, and permission to view the content if it is a
+         * page.
+         *
+         * @deprecated
+         * @returns Returned if the requested properties are returned.
+         * @path {GET} /wiki/rest/api/content/{id}/property
+         * @scopes-current read:confluence-props
+         * @scopes-beta read:content-details:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-get
+         */
+        this.getContentProperties = ({ id, key, expand, start, limit, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/content/{id}/property",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    key,
+                    expand,
+                    start,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getContentProperties.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns a content property for a piece of content. For more information, see
+         * [Confluence entity
+         * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * 'View' permission for the space, and permission to view the content if it is a
+         * page.
+         *
+         * @deprecated
+         * @returns Returned if the content property is returned.
+         * @path {GET} /wiki/rest/api/content/{id}/property/{key}
+         * @scopes-current read:confluence-props
+         * @scopes-beta read:content-details:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-get
+         */
+        this.getContentProperty = ({ id, key, expand, status, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/content/{id}/property/{key}",
+                method: "GET",
+                pathParams: {
+                    id,
+                    key,
+                },
+                query: {
+                    expand,
+                    status,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getContentProperty.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Updates an existing content property. This method will also create a new
+         * property for a piece of content, if the property key does not exist and
+         * the property version is 1. For more information about content properties, see
+         * [Confluence entity
+         * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to update the content.
+         *
+         * @deprecated
+         * @returns Returned if the content property is created.
+         * @path {PUT} /wiki/rest/api/content/{id}/property/{key}
+         * @scopes-current write:confluence-props
+         * @scopes-beta read:content.property:confluence, write:content.property:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties#api-wiki-rest-api-content-id-property-key-put
+         */
+        this.updateContentProperty = ({ id, key, contentPropertyUpdate, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/content/{id}/property/{key}",
+                method: "PUT",
+                pathParams: {
+                    id,
+                    key,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: contentPropertyUpdate,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateContentProperty.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentPropertiesService.getContentProperties.response", zod_1.z