@resolution/confluence-api-client 0.4.4 → 0.4.6

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

@@ -11,69 +11,73 @@ const longRunningTask_1 = require("../models/longRunningTask");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task */
 class LongRunningTaskService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Returns information about an active long-running task (e.g. space export),
-     * such as how long it has been running and the percentage of the task that
-     * has completed.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to access the Confluence site ('Can use' global permission).
-     *
-     * @returns Returned if the requested task is returned.
-     * @path {GET} /wiki/rest/api/longtask/{id}
-     * @scopes-current read:confluence-space.summary
-     * @scopes-beta read:content.metadata:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task#api-wiki-rest-api-longtask-id-get
-     */
-    getTask({ id, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/longtask/{id}",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("LongRunningTaskService.getTask.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns information about all active long-running tasks (e.g. space export),
-     * such as how long each task has been running and the percentage of each task
-     * that has completed.
-     *
-     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
-     * Permission to access the Confluence site ('Can use' global permission).
-     *
-     * @returns Returned if the requested tasks are returned.
-     * @path {GET} /wiki/rest/api/longtask
-     * @scopes-current read:content.metadata:confluence
-     * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task#api-wiki-rest-api-longtask-get
-     */
-    getTasks({ start, limit, } = {}) {
-        return this.getClientInstance()
-            .request({
-            path: "/wiki/rest/api/longtask",
-            method: "GET",
-            query: {
-                start,
-                limit,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("LongRunningTaskService.getTasks.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Returns information about an active long-running task (e.g. space export),
+         * such as how long it has been running and the percentage of the task that
+         * has completed.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to access the Confluence site ('Can use' global permission).
+         *
+         * @returns Returned if the requested task is returned.
+         * @path {GET} /wiki/rest/api/longtask/{id}
+         * @scopes-current read:confluence-space.summary
+         * @scopes-beta read:content.metadata:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task#api-wiki-rest-api-longtask-id-get
+         */
+        this.getTask = ({ id, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/longtask/{id}",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("LongRunningTaskService.getTask.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns information about all active long-running tasks (e.g. space export),
+         * such as how long each task has been running and the percentage of each task
+         * that has completed.
+         *
+         * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+         * Permission to access the Confluence site ('Can use' global permission).
+         *
+         * @returns Returned if the requested tasks are returned.
+         * @path {GET} /wiki/rest/api/longtask
+         * @scopes-current read:content.metadata:confluence
+         * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task#api-wiki-rest-api-longtask-get
+         */
+        this.getTasks = ({ key, start, limit, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/wiki/rest/api/longtask",
+                method: "GET",
+                query: {
+                    key,
+                    start,
+                    limit,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("LongRunningTaskService.getTasks.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("LongRunningTaskService.getTasks.response", zod_1.z

package/lib/openapi/v1/services/LongRunningTaskService.js.map

@@ -1 +1 @@
-{"version":3,"file":"LongRunningTaskService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/LongRunningTaskService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,+DAImC;AACnC,wEAAqE;AACrE,gGAAgG;AAChG,MAAa,sBAAuB,SAAQ,qCAAiB;IAC3D;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EACN,EAAE,GAIH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8BAA8B;YACpC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EACP,KAAK,EACL,KAAK,MASH,EAAE;QACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC;SAC1D,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,yBAAyB,CAAC;SAC9D,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,0DAAwC;SACzC,CAAC,CAAC;IACL,CAAC;CACF;AAlID,wDAkIC"}
+{"version":3,"file":"LongRunningTaskService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/LongRunningTaskService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,+DAImC;AACnC,wEAAqE;AACrE,gGAAgG;AAChG,MAAa,sBAAuB,SAAQ,qCAAiB;IAA7D;;QACE;;;;;;;;;;;;;WAaG;QACH,YAAO,GAAG,CAAC,EACT,EAAE,GAIH,EAAoC,EAAE;YACrC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8BAA8B;gBACpC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,aAAQ,GAAG,CAAC,EACV,GAAG,EACH,KAAK,EACL,KAAK,MAWH,EAAE,EAAgC,EAAE;YACtC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,yBAAyB;gBAC/B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,GAAG;oBACH,KAAK;oBACL,KAAK;iBACN;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA0BJ,CAAC;IAzBC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC;SAC1D,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,yBAAyB,CAAC;SAC9D,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,0DAAwC;SACzC,CAAC,CAAC;IACL,CAAC;CACF;AAtID,wDAsIC"}

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

@@ -22,7 +22,7 @@ export declare class RelationService extends CommonHttpService {
      * read:content:confluence, write:relation:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put
      */
-    createRelationship({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }: {
+    createRelationship: ({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }: {
         /**
          * The name of the relationship. This method supports the 'favourite'
          * (i.e. 'save for later') relationship. You can also specify any other
@@ -61,23 +61,23 @@ export declare class RelationService extends CommonHttpService {
          * The status of the source. This parameter is only used when the
          * `sourceType` is 'content'.
          */
-        sourceStatus?: string;
+        sourceStatus?: string | undefined;
         /**
          * The status of the target. This parameter is only used when the
          * `targetType` is 'content'.
          */
-        targetStatus?: string;
+        targetStatus?: string | undefined;
         /**
          * The version of the source. This parameter is only used when the
          * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
          */
-        sourceVersion?: number;
+        sourceVersion?: number | undefined;
         /**
          * The version of the target. This parameter is only used when the
          * `targetType` is 'content' and the `targetStatus` is 'historical'.
          */
-        targetVersion?: number;
-    }): Promise<Relation>;
+        targetVersion?: number | undefined;
+    }) => Promise<Relation>;
     /**
      * Deletes a relationship between two entities (user, space, content).
      *
@@ -93,7 +93,7 @@ export declare class RelationService extends CommonHttpService {
      * @scopes-beta write:relation:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-delete
      */
-    deleteRelationship({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }: {
+    deleteRelationship: ({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }: {
         /** The name of the relationship. */
         relationName: string;
         /**
@@ -128,23 +128,23 @@ export declare class RelationService extends CommonHttpService {
          * The status of the source. This parameter is only used when the
          * `sourceType` is 'content'.
          */
-        sourceStatus?: string;
+        sourceStatus?: string | undefined;
         /**
          * The status of the target. This parameter is only used when the
          * `targetType` is 'content'.
          */
-        targetStatus?: string;
+        targetStatus?: string | undefined;
         /**
          * The version of the source. This parameter is only used when the
          * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
          */
-        sourceVersion?: number;
+        sourceVersion?: number | undefined;
         /**
          * The version of the target. This parameter is only used when the
          * `targetType` is 'content' and the `targetStatus` is 'historical'.
          */
-        targetVersion?: number;
-    }): Promise<void>;
+        targetVersion?: number | undefined;
+    }) => Promise<void>;
     /**
      * Returns all target entities that have a particular relationship to the
      * source entity. Note, relationships are one way.
@@ -164,7 +164,7 @@ export declare class RelationService extends CommonHttpService {
      * @scopes-beta read:relation:confluence, read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-to-targettype-targetkey-from-sourcetype-get
      */
-    findSourcesForTarget({ relationName, sourceType, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }: {
+    findSourcesForTarget: ({ relationName, sourceType, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }: {
         /**
          * The name of the relationship. This method supports relationships created via
          * [Create
@@ -194,22 +194,22 @@ export declare class RelationService extends CommonHttpService {
          * The status of the source. This parameter is only used when the
          * `sourceType` is 'content'.
          */
-        sourceStatus?: string;
+        sourceStatus?: string | undefined;
         /**
          * The status of the target. This parameter is only used when the
          * `targetType` is 'content'.
          */
-        targetStatus?: string;
+        targetStatus?: string | undefined;
         /**
          * The version of the source. This parameter is only used when the
          * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
          */
-        sourceVersion?: number;
+        sourceVersion?: number | undefined;
         /**
          * The version of the target. This parameter is only used when the
          * `targetType` is 'content' and the `targetStatus` is 'historical'.
          */
-        targetVersion?: number;
+        targetVersion?: number | undefined;
         /**
          * A multi-value parameter indicating which properties of the response
          * object to expand.
@@ -219,15 +219,15 @@ export declare class RelationService extends CommonHttpService {
          * - `source` returns the source entity.
          * - `target` returns the target entity.
          */
-        expand?: ("relationData" | "source" | "target")[];
+        expand?: ("source" | "target" | "relationData")[] | undefined;
         /** The starting index of the returned relationships. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of relationships to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<RelationArray>;
+        limit?: number | undefined;
+    }) => Promise<RelationArray>;
     /**
      * Returns all target entities that have a particular relationship to the
      * source entity. Note, relationships are one way.
@@ -247,7 +247,7 @@ export declare class RelationService extends CommonHttpService {
      * @scopes-beta read:relation:confluence, read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-get
      */
-    findTargetFromSource({ relationName, sourceType, sourceKey, targetType, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }: {
+    findTargetFromSource: ({ relationName, sourceType, sourceKey, targetType, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }: {
         /**
          * The name of the relationship. This method supports relationships created via
          * [Create
@@ -277,22 +277,22 @@ export declare class RelationService extends CommonHttpService {
          * The status of the source. This parameter is only used when the
          * `sourceType` is 'content'.
          */
-        sourceStatus?: string;
+        sourceStatus?: string | undefined;
         /**
          * The status of the target. This parameter is only used when the
          * `targetType` is 'content'.
          */
-        targetStatus?: string;
+        targetStatus?: string | undefined;
         /**
          * The version of the source. This parameter is only used when the
          * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
          */
-        sourceVersion?: number;
+        sourceVersion?: number | undefined;
         /**
          * The version of the target. This parameter is only used when the
          * `targetType` is 'content' and the `targetStatus` is 'historical'.
          */
-        targetVersion?: number;
+        targetVersion?: number | undefined;
         /**
          * A multi-value parameter indicating which properties of the response
          * object to expand.
@@ -302,15 +302,15 @@ export declare class RelationService extends CommonHttpService {
          * - `source` returns the source entity.
          * - `target` returns the target entity.
          */
-        expand?: ("relationData" | "source" | "target")[];
+        expand?: ("source" | "target" | "relationData")[] | undefined;
         /** The starting index of the returned relationships. */
-        start?: number;
+        start?: number | undefined;
         /**
          * The maximum number of relationships to return per page.
          * Note, this may be restricted by fixed system limits.
          */
-        limit?: number;
-    }): Promise<RelationArray>;
+        limit?: number | undefined;
+    }) => Promise<RelationArray>;
     /**
      * Find whether a particular type of relationship exists from a source
      * entity to a target entity. Note, relationships are one way.
@@ -329,7 +329,7 @@ export declare class RelationService extends CommonHttpService {
      * @scopes-beta read:relation:confluence, read:content-details:confluence
      * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-get
      */
-    getRelationship({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, }: {
+    getRelationship: ({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, }: {
         /**
          * The name of the relationship. This method supports the 'favourite'
          * (i.e. 'save for later') relationship as well as any other relationship
@@ -379,22 +379,22 @@ export declare class RelationService extends CommonHttpService {
          * The status of the source. This parameter is only used when the
          * `sourceType` is 'content'.
          */
-        sourceStatus?: string;
+        sourceStatus?: string | undefined;
         /**
          * The status of the target. This parameter is only used when the
          * `targetType` is 'content'.
          */
-        targetStatus?: string;
+        targetStatus?: string | undefined;
         /**
          * The version of the source. This parameter is only used when the
          * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
          */
-        sourceVersion?: number;
+        sourceVersion?: number | undefined;
         /**
          * The version of the target. This parameter is only used when the
          * `targetType` is 'content' and the `targetStatus` is 'historical'.
          */
-        targetVersion?: number;
+        targetVersion?: number | undefined;
         /**
          * A multi-value parameter indicating which properties of the response
          * object to expand.
@@ -404,7 +404,7 @@ export declare class RelationService extends CommonHttpService {
          * - `source` returns the source entity.
          * - `target` returns the target entity.
          */
-        expand?: ("relationData" | "source" | "target")[];
-    }): Promise<Relation>;
+        expand?: ("source" | "target" | "relationData")[] | undefined;
+    }) => Promise<Relation>;
     static initialize(): void;
 }