@resolution/confluence-api-client 0.4.2 → 0.4.4

package/lib/openapi/v2/models/user.d.ts

@@ -0,0 +1,51 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+/** The account status of the user. */
+export type AccountStatus = "active" | "inactive" | "closed" | "unknown";
+/** The account type of the user. */
+export type AccountType = "atlassian" | "app" | "customer" | "unknown";
+/**
+ * This object represents an icon. If used as a profilePicture, this may be
+ * returned as null, depending on the user's privacy setting.
+ */
+export interface Icon extends Record<string, unknown> {
+    path: string;
+    width: number;
+    height: number;
+    isDefault: boolean;
+}
+export interface User extends Record<string, unknown> {
+    /** Display name of the user. */
+    displayName?: string;
+    /**
+     * Time zone of the user. Depending on the user's privacy
+     * setting, this may return null.
+     */
+    timeZone?: string;
+    /**
+     * Space ID of the user's personal space. Returns null, if no personal space for
+     * the user.
+     */
+    personalSpaceId?: string;
+    /** Whether the user is an external collaborator. */
+    isExternalCollaborator?: boolean;
+    /** The account status of the user. */
+    accountStatus?: AccountStatus;
+    /** Account ID of the user. */
+    accountId?: string;
+    /**
+     * The email address of the user. Depending on the user's privacy setting, this
+     * may return an empty string.
+     */
+    email?: string;
+    /** The account type of the user. */
+    accountType?: AccountType;
+    /** Public name of the user. */
+    publicName?: string;
+    /**
+     * This object represents an icon. If used as a profilePicture, this may be
+     * returned as null, depending on the user's privacy setting.
+     */
+    profilePicture?: Icon | null;
+}
+export declare function registerUserValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;

package/lib/openapi/v2/models/user.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerUserValidationSchemas = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+function registerUserValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("AccountStatus", zod_1.z
+        .enum(["active", "inactive", "closed", "unknown"])
+        .describe("AccountStatus"));
+    validationSchemaStorage.register("AccountType", zod_1.z.enum(["atlassian", "app", "customer", "unknown"]).describe("AccountType"));
+    validationSchemaStorage.register("Icon", zod_1.z
+        .object({
+        path: zod_1.z.string(),
+        width: zod_1.z.number().int(),
+        height: zod_1.z.number().int(),
+        isDefault: zod_1.z.boolean(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("Icon"));
+    validationSchemaStorage.register("User", zod_1.z
+        .object({
+        displayName: zod_1.z.string().optional(),
+        timeZone: zod_1.z.string().optional(),
+        personalSpaceId: zod_1.z.string().optional(),
+        isExternalCollaborator: zod_1.z.boolean().optional(),
+        accountStatus: validationSchemaStorage.lazy("AccountStatus").optional(),
+        accountId: zod_1.z.string().optional(),
+        email: zod_1.z.string().optional(),
+        accountType: validationSchemaStorage.lazy("AccountType").optional(),
+        publicName: zod_1.z.string().optional(),
+        profilePicture: zod_1.z
+            .nullable(validationSchemaStorage.lazy("Icon"))
+            .optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("User"));
+}
+exports.registerUserValidationSchemas = registerUserValidationSchemas;
+//# sourceMappingURL=user.js.map

package/lib/openapi/v2/models/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../../src/openapi/v2/models/user.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAmDzC,SAAgB,6BAA6B,CAC3C,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,eAAe,EACf,OAAC;SACE,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;SACjD,QAAQ,CAAC,eAAe,CAAC,CAC7B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,aAAa,EACb,OAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAC5E,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,MAAM,EACN,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;QAChB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACvB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACxB,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE;KACvB,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,MAAM,CAAC,CACpB,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,MAAM,EACN,OAAC;SACE,MAAM,CAAC;QACN,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACtC,sBAAsB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC9C,aAAa,EAAE,uBAAuB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;QACvE,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,WAAW,EAAE,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;QACnE,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACjC,cAAc,EAAE,OAAC;aACd,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aAC9C,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,MAAM,CAAC,CACpB,CAAC;AACJ,CAAC;AA7CD,sEA6CC"}

package/lib/openapi/v2/services/UserService.d.ts

@@ -1,4 +1,6 @@
 import { CommonHttpService } from "../core/CommonHttpService";
+import { type MultiEntityLinks } from "../models/common";
+import { type User } from "../models/user";
 /** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user */
 export declare class UserService extends CommonHttpService {
     /**
@@ -27,6 +29,32 @@ export declare class UserService extends CommonHttpService {
     } & {
         [key: string]: unknown;
     }>;
+    /**
+     * Returns user details for the ids provided in the request body.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * The user must be able to view user profiles in the Confluence site.
+     *
+     * @returns Returned if the user info is returned for the account IDs. `results` may be
+     * empty if no account IDs were found.
+     * @path {POST} /users-bulk
+     * @scopes-current read:user:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-users-bulk-post
+     */
+    createBulkUserLookup({ requestBody, }: {
+        requestBody: {
+            /** List of accountIds to retrieve user info for. */
+            accountId?: string[];
+        } & {
+            [key: string]: unknown;
+        };
+    }): Promise<{
+        results?: User[];
+        _links?: MultiEntityLinks;
+    } & {
+        [key: string]: unknown;
+    }>;
     /**
      * Invite a list of emails to the site.
      *

package/lib/openapi/v2/services/UserService.js

@@ -7,6 +7,8 @@ exports.UserService = void 0;
 const zod_1 = require("zod");
 const commonHttpClient = require("../core/CommonHttpClient");
 const CommonHttpService_1 = require("../core/CommonHttpService");
+const common_1 = require("../models/common");
+const user_1 = require("../models/user");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user */
 class UserService extends CommonHttpService_1.CommonHttpService {
@@ -40,6 +42,38 @@ class UserService extends CommonHttpService_1.CommonHttpService {
             .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserService.checkAccessByEmail.response"))
             .then(commonHttpClient.getBody);
     }
+    /**
+     * Returns user details for the ids provided in the request body.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * Permission to access the Confluence site ('Can use' global permission).
+     * The user must be able to view user profiles in the Confluence site.
+     *
+     * @returns Returned if the user info is returned for the account IDs. `results` may be
+     * empty if no account IDs were found.
+     * @path {POST} /users-bulk
+     * @scopes-current read:user:confluence
+     * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-users-bulk-post
+     */
+    createBulkUserLookup({ requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/users-bulk",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserService.createBulkUserLookup.response"))
+            .then(commonHttpClient.getBody);
+    }
     /**
      * Invite a list of emails to the site.
      *
@@ -80,6 +114,24 @@ class UserService extends CommonHttpService_1.CommonHttpService {
                 .catchall(zod_1.z.unknown()),
         })
             .describe("UserService.checkAccessByEmail.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("UserService.createBulkUserLookup.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("User")).optional(),
+                _links: validationSchemaStorage_1.validationSchemaStorage
+                    .lazy("MultiEntityLinks")
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("UserService.createBulkUserLookup.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([
+            user_1.registerUserValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
     }
 }
 exports.UserService = UserService;

package/lib/openapi/v2/services/UserService.js.map

@@ -1 +1 @@
-{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/UserService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,wEAAqE;AACrE,mFAAmF;AACnF,MAAa,WAAY,SAAQ,qCAAiB;IAChD;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EACjB,WAAW,GAQZ;QAUC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oCAAoC;YAC1C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EACZ,WAAW,GAQZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8BAA8B;YACpC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,CAAC,UAAU;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,OAAC;iBACJ,MAAM,CAAC;gBACN,mBAAmB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;gBACnD,aAAa,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;aAC9C,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;IACJ,CAAC;CACF;AAvHD,kCAuHC"}
+{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/UserService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,yCAA0E;AAC1E,wEAAqE;AACrE,mFAAmF;AACnF,MAAa,WAAY,SAAQ,qCAAiB;IAChD;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EACjB,WAAW,GAQZ;QAUC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oCAAoC;YAC1C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,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,EASzB,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,oBAAoB,CAAC,EACnB,WAAW,GAQZ;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,2CAA2C,CAC5C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EACZ,WAAW,GAQZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,8BAA8B;YACpC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,CAAC,UAAU;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,OAAC;iBACJ,MAAM,CAAC;gBACN,mBAAmB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;gBACnD,aAAa,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;aAC9C,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,2CAA2C,EAC3C,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,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;gBACjE,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,2CAA2C,CAAC,CACzD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,oCAA6B;YAC7B,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA7MD,kCA6MC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resolution/confluence-api-client",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "Confluence API Client based on OpenAPI Schema from Atlassian.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -35,10 +35,10 @@
   },
   "homepage": "https://bitbucket.org/resolutiongmbh/atlassian-api-clients#readme",
   "dependencies": {
-    "@resolution/atlassian-api-common": "^0.4.2"
+    "@resolution/atlassian-api-common": "^0.4.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "443c80eef7f897d574df5245ac1c8a608f447835"
+  "gitHead": "50f8d6611b4048dff84c30c74887058eabf0466b"
 }