@resolution/confluence-api-client 0.2.0

package/lib/openapi/v1/models/userProperties.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerUserPropertiesValidationSchemas = 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");
+const common_1 = require("./common");
+function registerUserPropertiesValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("UserProperty", zod_1.z
+        .object({
+        key: zod_1.z.string(),
+        value: zod_1.z.object({}).catchall(zod_1.z.unknown()),
+        id: zod_1.z.string(),
+        lastModifiedDate: zod_1.z.string(),
+        createdDate: zod_1.z.string(),
+        _links: validationSchemaStorage.lazy("GenericLinks").optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("UserProperty"));
+    validationSchemaStorage.register("UserPropertyCreate", zod_1.z
+        .object({
+        value: zod_1.z.object({}).catchall(zod_1.z.unknown()),
+    })
+        .strict()
+        .describe("UserPropertyCreate"));
+    validationSchemaStorage.register("UserPropertyKeyArray", zod_1.z
+        .object({
+        results: zod_1.z.array(zod_1.z
+            .object({
+            key: zod_1.z.string().optional(),
+        })
+            .catchall(zod_1.z.unknown())),
+        start: zod_1.z.number().int().optional(),
+        limit: zod_1.z.number().int().optional(),
+        size: zod_1.z.number().int().optional(),
+        _links: validationSchemaStorage.lazy("GenericLinks").optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("UserPropertyKeyArray"));
+    validationSchemaStorage.register("UserPropertyUpdate", zod_1.z
+        .object({
+        value: zod_1.z.object({}).catchall(zod_1.z.unknown()),
+    })
+        .strict()
+        .describe("UserPropertyUpdate"));
+    validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+}
+exports.registerUserPropertiesValidationSchemas = registerUserPropertiesValidationSchemas;
+//# sourceMappingURL=userProperties.js.map

package/lib/openapi/v1/models/userProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userProperties.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/userProperties.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAA8E;AAsC9E,SAAgB,uCAAuC,CACrD,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,cAAc,EACd,OAAC;SACE,MAAM,CAAC;QACN,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;QACf,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;QACzC,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;QACd,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE;QAC5B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE;KAChE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,cAAc,CAAC,CAC5B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,oBAAoB,EACpB,OAAC;SACE,MAAM,CAAC;QACN,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;KAC1C,CAAC;SACD,MAAM,EAAE;SACR,QAAQ,CAAC,oBAAoB,CAAC,CAClC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,sBAAsB,EACtB,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,OAAC,CAAC,KAAK,CACd,OAAC;aACE,MAAM,CAAC;YACN,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC3B,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;QACD,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QAClC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QAClC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACjC,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE;KAChE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,sBAAsB,CAAC,CACpC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,oBAAoB,EACpB,OAAC;SACE,MAAM,CAAC;QACN,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;KAC1C,CAAC;SACD,MAAM,EAAE;SACR,QAAQ,CAAC,oBAAoB,CAAC,CAClC,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AAvDD,0FAuDC"}

package/lib/openapi/v1/models/users.d.ts

@@ -0,0 +1,98 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+import { type GenericAccountId, type GenericLinks, type GenericUserKey, type GenericUserName, type Icon, type OperationCheckResult, type Space, type UserDetails } from "./common";
+export interface AccountIdEmailRecord extends Record<string, unknown> {
+    accountId: string;
+    email: string;
+}
+export type AccountIdEmailRecordArray = AccountIdEmailRecord[];
+export interface BulkUserLookup extends Record<string, unknown> {
+    type: "known" | "unknown" | "anonymous" | "user";
+    /**
+     * This property is no longer available and will be removed from the documentation
+     * soon.
+     * Use `accountId` instead.
+     * See the [deprecation
+     * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    username?: GenericUserName | null;
+    /**
+     * This property is no longer available and will be removed from the documentation
+     * soon.
+     * Use `accountId` instead.
+     * See the [deprecation
+     * notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    userKey?: GenericUserKey | null;
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products.
+     * For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
+     */
+    accountId: GenericAccountId | null;
+    /** The account type of the user, may return empty string if unavailable. */
+    accountType: string;
+    /**
+     * The email address of the user. Depending on the user's privacy setting, this
+     * may return an empty string.
+     */
+    email: string;
+    /** The public name or nickname of the user. Will always contain a value. */
+    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;
+    /**
+     * The displays name of the user. Depending on the user's privacy setting, this
+     * may be the same as publicName.
+     */
+    displayName: string;
+    /**
+     * This displays user time zone. Depending on the user's privacy setting, this may
+     * return null.
+     */
+    timeZone?: string | null;
+    /** Whether the user is an external collaborator user */
+    isExternalCollaborator?: boolean;
+    operations?: OperationCheckResult[];
+    details?: UserDetails;
+    personalSpace?: Space | null;
+    _expandable: {
+        operations?: string;
+        details?: string;
+        personalSpace?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links: GenericLinks;
+}
+export interface BulkUserLookupArray extends Record<string, unknown> {
+    results: BulkUserLookup[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+}
+export interface UserAnonymous extends Record<string, unknown> {
+    type: 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;
+    displayName: string;
+    operations?: OperationCheckResult[];
+    /** Whether the user is an external collaborator user */
+    isExternalCollaborator?: boolean;
+    _expandable?: {
+        operations?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    _links: GenericLinks;
+}
+export declare function registerUsersValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;

package/lib/openapi/v1/models/users.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerUsersValidationSchemas = 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");
+const common_1 = require("./common");
+function registerUsersValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("AccountIdEmailRecord", zod_1.z
+        .object({
+        accountId: zod_1.z.string(),
+        email: zod_1.z.string(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("AccountIdEmailRecord"));
+    validationSchemaStorage.register("AccountIdEmailRecordArray", zod_1.z
+        .array(validationSchemaStorage.lazy("AccountIdEmailRecord"))
+        .describe("AccountIdEmailRecordArray"));
+    validationSchemaStorage.register("BulkUserLookup", zod_1.z
+        .object({
+        type: zod_1.z.enum(["known", "unknown", "anonymous", "user"]),
+        username: zod_1.z
+            .nullable(validationSchemaStorage.lazy("GenericUserName"))
+            .optional(),
+        userKey: zod_1.z
+            .nullable(validationSchemaStorage.lazy("GenericUserKey"))
+            .optional(),
+        accountId: zod_1.z.nullable(validationSchemaStorage.lazy("GenericAccountId")),
+        accountType: zod_1.z.string(),
+        email: zod_1.z.string(),
+        publicName: zod_1.z.string(),
+        profilePicture: zod_1.z.nullable(validationSchemaStorage.lazy("Icon")),
+        displayName: zod_1.z.string(),
+        timeZone: zod_1.z.nullable(zod_1.z.string()).optional(),
+        isExternalCollaborator: zod_1.z.boolean().optional(),
+        operations: zod_1.z
+            .array(validationSchemaStorage.lazy("OperationCheckResult"))
+            .optional(),
+        details: validationSchemaStorage.lazy("UserDetails").optional(),
+        personalSpace: zod_1.z
+            .nullable(validationSchemaStorage.lazy("Space"))
+            .optional(),
+        _expandable: zod_1.z
+            .object({
+            operations: zod_1.z.string().optional(),
+            details: zod_1.z.string().optional(),
+            personalSpace: zod_1.z.string().optional(),
+        })
+            .catchall(zod_1.z.unknown()),
+        _links: validationSchemaStorage.lazy("GenericLinks"),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("BulkUserLookup"));
+    validationSchemaStorage.register("BulkUserLookupArray", zod_1.z
+        .object({
+        results: zod_1.z.array(validationSchemaStorage.lazy("BulkUserLookup")),
+        start: zod_1.z.number().int(),
+        limit: zod_1.z.number().int(),
+        size: zod_1.z.number().int(),
+        _links: validationSchemaStorage.lazy("GenericLinks"),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("BulkUserLookupArray"));
+    validationSchemaStorage.register("UserAnonymous", zod_1.z
+        .object({
+        type: zod_1.z.string(),
+        profilePicture: zod_1.z.nullable(validationSchemaStorage.lazy("Icon")),
+        displayName: zod_1.z.string(),
+        operations: zod_1.z
+            .array(validationSchemaStorage.lazy("OperationCheckResult"))
+            .optional(),
+        isExternalCollaborator: zod_1.z.boolean().optional(),
+        _expandable: zod_1.z
+            .object({
+            operations: zod_1.z.string().optional(),
+        })
+            .catchall(zod_1.z.unknown())
+            .optional(),
+        _links: validationSchemaStorage.lazy("GenericLinks"),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("UserAnonymous"));
+    validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+}
+exports.registerUsersValidationSchemas = registerUsersValidationSchemas;
+//# sourceMappingURL=users.js.map

package/lib/openapi/v1/models/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/users.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAUkB;AA+FlB,SAAgB,8BAA8B,CAC5C,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,sBAAsB,EACtB,OAAC;SACE,MAAM,CAAC;QACN,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;KAClB,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,sBAAsB,CAAC,CACpC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,2BAA2B,EAC3B,OAAC;SACE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;SAC3D,QAAQ,CAAC,2BAA2B,CAAC,CACzC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,gBAAgB,EAChB,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QACvD,QAAQ,EAAE,OAAC;aACR,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;aACzD,QAAQ,EAAE;QACb,OAAO,EAAE,OAAC;aACP,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACxD,QAAQ,EAAE;QACb,SAAS,EAAE,OAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACvE,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;QACtB,cAAc,EAAE,OAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChE,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,QAAQ,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;QAC3C,sBAAsB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC9C,UAAU,EAAE,OAAC;aACV,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;aAC3D,QAAQ,EAAE;QACb,OAAO,EAAE,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;QAC/D,aAAa,EAAE,OAAC;aACb,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC/C,QAAQ,EAAE;QACb,WAAW,EAAE,OAAC;aACX,MAAM,CAAC;YACN,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACjC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC9B,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACrC,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;QACxB,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;KACrD,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,gBAAgB,CAAC,CAC9B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,qBAAqB,EACrB,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAChE,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACvB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACvB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACtB,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;KACrD,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,qBAAqB,CAAC,CACnC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,eAAe,EACf,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;QAChB,cAAc,EAAE,OAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChE,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,UAAU,EAAE,OAAC;aACV,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;aAC3D,QAAQ,EAAE;QACb,sBAAsB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC9C,WAAW,EAAE,OAAC;aACX,MAAM,CAAC;YACN,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAClC,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;aACrB,QAAQ,EAAE;QACb,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;KACrD,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,eAAe,CAAC,CAC7B,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AA7FD,wEA6FC"}

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

@@ -0,0 +1,54 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+export declare class AnalyticsService extends CommonHttpService {
+    /**
+     * Get the total number of distinct viewers a piece of content has.
+     *
+     * @returns Returns the total number of distinct viewers for the content.
+     * @path {GET} /wiki/rest/api/analytics/content/{contentId}/viewers
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:analytics.content:confluence
+     */
+    getViewers({ contentId, fromDate, }: {
+        /** The ID of the content to get the viewers for. */
+        contentId: string;
+        /**
+         * The number of views for the content since the date.
+         *
+         * @example 2021-03-21T00:00:00.000Z
+         */
+        fromDate?: string;
+    }): Promise<{
+        /** The content ID. */
+        id?: number;
+        /** The total number of distinct viewers for the content. */
+        count?: number;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Get the total number of views a piece of content has.
+     *
+     * @returns Returns the total number of views for the content.
+     * @path {GET} /wiki/rest/api/analytics/content/{contentId}/views
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:analytics.content:confluence
+     */
+    getViews({ contentId, fromDate, }: {
+        /** The ID of the content to get the views for. */
+        contentId: string;
+        /**
+         * The number of views for the content since the date.
+         *
+         * @example 2021-03-21T00:00:00.000Z
+         */
+        fromDate?: string;
+    }): Promise<{
+        /** The content ID. */
+        id?: number;
+        /** The total number of views for the content. */
+        count?: number;
+    } & {
+        [key: string]: unknown;
+    }>;
+    static initialize(): void;
+}

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

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsService = 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");
+const commonHttpClient = require("../core/CommonHttpClient");
+const CommonHttpService_1 = require("../core/CommonHttpService");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+class AnalyticsService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Get the total number of distinct viewers a piece of content has.
+     *
+     * @returns Returns the total number of distinct viewers for the content.
+     * @path {GET} /wiki/rest/api/analytics/content/{contentId}/viewers
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:analytics.content:confluence
+     */
+    getViewers({ contentId, fromDate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/analytics/content/{contentId}/viewers",
+            method: "GET",
+            pathParams: {
+                contentId,
+            },
+            query: {
+                fromDate,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AnalyticsService.getViewers.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Get the total number of views a piece of content has.
+     *
+     * @returns Returns the total number of views for the content.
+     * @path {GET} /wiki/rest/api/analytics/content/{contentId}/views
+     * @scopes-current read:confluence-content.summary
+     * @scopes-beta read:analytics.content:confluence
+     */
+    getViews({ contentId, fromDate, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/wiki/rest/api/analytics/content/{contentId}/views",
+            method: "GET",
+            pathParams: {
+                contentId,
+            },
+            query: {
+                fromDate,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("AnalyticsService.getViews.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AnalyticsService.getViewers.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                id: zod_1.z.number().int().optional(),
+                count: zod_1.z.number().int().optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("AnalyticsService.getViewers.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AnalyticsService.getViews.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                id: zod_1.z.number().int().optional(),
+                count: zod_1.z.number().int().optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("AnalyticsService.getViews.response"));
+    }
+}
+exports.AnalyticsService = AnalyticsService;
+//# sourceMappingURL=AnalyticsService.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/AnalyticsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,wEAAqE;AACrE,MAAa,gBAAiB,SAAQ,qCAAiB;IACrD;;;;;;;OAOG;IACH,UAAU,CAAC,EACT,SAAS,EACT,QAAQ,GAUT;QAUC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sDAAsD;YAC5D,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,QAAQ;aACT;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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,sCAAsC,CACvC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;OAOG;IACH,QAAQ,CAAC,EACP,SAAS,EACT,QAAQ,GAUT;QAUC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oDAAoD;YAC1D,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,SAAS;aACV;YACD,KAAK,EAAE;gBACL,QAAQ;aACT;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,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,oCAAoC,CAAC,CACxE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,sCAAsC,EACtC,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,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC/B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;aACnC,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,sCAAsC,CAAC,CACpD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,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,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC/B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;aACnC,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;IACJ,CAAC;CACF;AArKD,4CAqKC"}

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

@@ -0,0 +1,163 @@
+import * as commonHttpClient from "../core/CommonHttpClient";
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type AuditRecord, type AuditRecordArray, type AuditRecordCreate, type RetentionPeriod } from "../models/audit";
+export declare class AuditService extends CommonHttpService {
+    /**
+     * Creates a record in the audit log.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the record is created in the audit log.
+     * @path {POST} /wiki/rest/api/audit
+     * @scopes-current read:audit-log:confluence, write:audit-log:confluence
+     */
+    createAuditRecord({ auditRecordCreate, }: {
+        /** The record to be created in the audit log. */
+        auditRecordCreate: AuditRecordCreate;
+    }): Promise<AuditRecord>;
+    /**
+     * Exports audit records as a CSV file or ZIP file.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns * status: 200, mediaType: application/zip
+     *
+     *    Returned if the requested export of the audit records is returned.
+     *
+     *  * status: 200, mediaType: text/csv
+     *
+     *    Returned if the requested export of the audit records is returned.
+     * @path {GET} /wiki/rest/api/audit/export
+     * @scopes-current read:audit-log:confluence
+     */
+    exportAuditRecords({ startDate, endDate, searchString, format, }: {
+        /**
+         * Filters the exported results to the records on or after the `startDate`.
+         * The `startDate` must be specified as [epoch
+         * time](https://www.epochconverter.com/) in milliseconds.
+         */
+        startDate?: string;
+        /**
+         * Filters the exported results to the records on or before the `endDate`.
+         * The `endDate` must be specified as [epoch
+         * time](https://www.epochconverter.com/) in milliseconds.
+         */
+        endDate?: string;
+        /**
+         * Filters the exported results to records that have string property values
+         * matching the `searchString`.
+         */
+        searchString?: string;
+        /** The format of the export file for the audit records. */
+        format?: "csv" | "zip";
+    }): Promise<commonHttpClient.WithResponse<{
+        status: 200;
+        mediaType: "application/zip" | "text/csv";
+        body: Blob;
+    }>>;
+    /**
+     * Returns all records in the audit log, optionally for a certain date range.
+     * This contains information about events like space exports, group membership
+     * changes, app installations, etc. For more information, see
+     * [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html)
+     * in the Confluence administrator's guide.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the requested records are returned.
+     * @path {GET} /wiki/rest/api/audit
+     * @scopes-current read:audit-log:confluence
+     */
+    getAuditRecords({ startDate, endDate, searchString, start, limit, }: {
+        /**
+         * Filters the results to the records on or after the `startDate`.
+         * The `startDate` must be specified as [epoch
+         * time](https://www.epochconverter.com/) in milliseconds.
+         */
+        startDate?: string;
+        /**
+         * Filters the results to the records on or before the `endDate`.
+         * The `endDate` must be specified as [epoch
+         * time](https://www.epochconverter.com/) in milliseconds.
+         */
+        endDate?: string;
+        /**
+         * Filters the results to records that have string property values
+         * matching the `searchString`.
+         */
+        searchString?: string;
+        /** The starting index of the returned records. */
+        start?: number;
+        /**
+         * The maximum number of records to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<AuditRecordArray>;
+    /**
+     * Returns records from the audit log, for a time period back from the current
+     * date. For example, you can use this method to get the last 3 months of records.
+     *
+     * This contains information about events like space exports, group membership
+     * changes, app installations, etc. For more information, see
+     * [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html)
+     * in the Confluence administrator's guide.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the requested records are returned.
+     * @path {GET} /wiki/rest/api/audit/since
+     * @scopes-current read:audit-log:confluence
+     */
+    getAuditRecordsForTimePeriod({ number, units, searchString, start, limit, }: {
+        /** The number of units for the time period. */
+        number?: number;
+        /** The unit of time that the time period is measured in. */
+        units?: "NANOS" | "MICROS" | "MILLIS" | "SECONDS" | "MINUTES" | "HOURS" | "HALF_DAYS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "DECADES" | "CENTURIES";
+        /**
+         * Filters the results to records that have string property values
+         * matching the `searchString`.
+         */
+        searchString?: string;
+        /** The starting index of the returned records. */
+        start?: number;
+        /**
+         * The maximum number of records to return per page.
+         * Note, this may be restricted by fixed system limits.
+         */
+        limit?: number;
+    }): Promise<AuditRecordArray>;
+    /**
+     * Returns the retention period for records in the audit log. The retention
+     * period is how long an audit record is kept for, from creation date until
+     * it is deleted.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the requested retention period is returned.
+     * @path {GET} /wiki/rest/api/audit/retention
+     * @scopes-current read:audit-log:confluence
+     */
+    getRetentionPeriod(): Promise<RetentionPeriod>;
+    /**
+     * Sets the retention period for records in the audit log. The retention period
+     * can be set to a maximum of 1 year.
+     *
+     * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
+     * 'Confluence Administrator' global permission.
+     *
+     * @returns Returned if the retention period is updated.
+     * @path {PUT} /wiki/rest/api/audit/retention
+     * @scopes-current write:audit-log:confluence
+     */
+    setRetentionPeriod({ retentionPeriod, }: {
+        /** The updated retention period. */
+        retentionPeriod: RetentionPeriod;
+    }): Promise<RetentionPeriod>;
+    static initialize(): void;
+}