@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,151 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+import { type GenericAccountId, type GenericLinks, type GenericUserKey, type GenericUserName } from "./common";
+export interface AffectedObject extends Record<string, unknown> {
+    name: string;
+    objectType: string;
+}
+export interface AuditRecord extends Record<string, unknown> {
+    author: {
+        type: "user";
+        displayName: string;
+        operations: {
+            [key: string]: unknown;
+        } | 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.
+         */
+        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;
+        accountType?: string;
+        externalCollaborator?: boolean;
+        /** Whether the user is an external collaborator user */
+        isExternalCollaborator?: boolean;
+        /** The public name or nickname of the user. Will always contain a value. */
+        publicName?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    remoteAddress: string;
+    /** The creation date-time of the audit record, as a timestamp. */
+    creationDate: number;
+    summary: string;
+    description: string;
+    category: string;
+    sysAdmin: boolean;
+    superAdmin?: boolean;
+    affectedObject: AffectedObject;
+    changedValues: ChangedValue[];
+    associatedObjects: AffectedObject[];
+}
+export interface AuditRecordArray extends Record<string, unknown> {
+    results: AuditRecord[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+}
+export interface AuditRecordCreate extends Record<string, unknown> {
+    /**
+     * The user that actioned the event. If `author` is not specified, then all
+     * `author` properties will be set to null/empty, except for `type` which
+     * will be set to 'user'.
+     */
+    author?: {
+        /** Set to 'user'. */
+        type: "user";
+        /** The name that is displayed on the audit log in the Confluence UI. */
+        displayName?: string;
+        /** Always defaults to null. */
+        operations?: {
+            [key: string]: unknown;
+        };
+        /**
+         * 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;
+    } & {
+        [key: string]: unknown;
+    };
+    /** The IP address of the computer where the event was initiated from. */
+    remoteAddress: string;
+    /**
+     * The creation date-time of the audit record, as a timestamp. This is converted
+     * to a date-time display in the Confluence UI. If the `creationDate` is not
+     * specified, then it will be set to the timestamp for the current date-time.
+     */
+    creationDate?: number;
+    /**
+     * The summary of the event, which is displayed in the 'Change' column on
+     * the audit log in the Confluence UI.
+     */
+    summary?: string;
+    /**
+     * A long description of the event, which is displayed in the 'Description'
+     * field on the audit log in the Confluence UI.
+     */
+    description?: string;
+    /**
+     * The category of the event, which is displayed in the 'Event type' column
+     * on the audit log in the Confluence UI.
+     */
+    category?: string;
+    /** Indicates whether the event was actioned by a system administrator. */
+    sysAdmin?: boolean;
+    affectedObject?: AffectedObject;
+    /** The values that were changed in the event. */
+    changedValues?: ChangedValue[];
+    /**
+     * Objects that were associated with the event. For example, if the event
+     * was a space permission change then the associated object would be the
+     * space.
+     */
+    associatedObjects?: AffectedObject[];
+}
+export interface ChangedValue extends Record<string, unknown> {
+    name: string;
+    oldValue: string;
+    hiddenOldValue?: string;
+    newValue: string;
+    hiddenNewValue?: string;
+}
+export interface RetentionPeriod extends Record<string, unknown> {
+    /** The number of units for the retention period. */
+    number: number;
+    /** The unit of time that the retention period is measured in. */
+    units: "NANOS" | "MICROS" | "MILLIS" | "SECONDS" | "MINUTES" | "HOURS" | "HALF_DAYS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "DECADES" | "CENTURIES" | "MILLENNIA" | "ERAS" | "FOREVER";
+}
+export declare function registerAuditValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;

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

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerAuditValidationSchemas = 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 registerAuditValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("AffectedObject", zod_1.z
+        .object({
+        name: zod_1.z.string(),
+        objectType: zod_1.z.string(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("AffectedObject"));
+    validationSchemaStorage.register("AuditRecord", zod_1.z
+        .object({
+        author: zod_1.z
+            .object({
+            type: zod_1.z.enum(["user"]),
+            displayName: zod_1.z.string(),
+            operations: zod_1.z.nullable(zod_1.z.object({}).catchall(zod_1.z.unknown())),
+            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"))
+                .optional(),
+            accountType: zod_1.z.string().optional(),
+            externalCollaborator: zod_1.z.boolean().optional(),
+            isExternalCollaborator: zod_1.z.boolean().optional(),
+            publicName: zod_1.z.string().optional(),
+        })
+            .catchall(zod_1.z.unknown()),
+        remoteAddress: zod_1.z.string(),
+        creationDate: zod_1.z.number().int(),
+        summary: zod_1.z.string(),
+        description: zod_1.z.string(),
+        category: zod_1.z.string(),
+        sysAdmin: zod_1.z.boolean(),
+        superAdmin: zod_1.z.boolean().optional(),
+        affectedObject: validationSchemaStorage.lazy("AffectedObject"),
+        changedValues: zod_1.z.array(validationSchemaStorage.lazy("ChangedValue")),
+        associatedObjects: zod_1.z.array(validationSchemaStorage.lazy("AffectedObject")),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("AuditRecord"));
+    validationSchemaStorage.register("AuditRecordArray", zod_1.z
+        .object({
+        results: zod_1.z.array(validationSchemaStorage.lazy("AuditRecord")),
+        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("AuditRecordArray"));
+    validationSchemaStorage.register("AuditRecordCreate", zod_1.z
+        .object({
+        author: zod_1.z
+            .object({
+            type: zod_1.z.enum(["user"]),
+            displayName: zod_1.z.string().optional(),
+            operations: zod_1.z.object({}).catchall(zod_1.z.unknown()).optional(),
+            username: zod_1.z
+                .nullable(validationSchemaStorage.lazy("GenericUserName"))
+                .optional(),
+            userKey: zod_1.z
+                .nullable(validationSchemaStorage.lazy("GenericUserKey"))
+                .optional(),
+        })
+            .catchall(zod_1.z.unknown())
+            .optional(),
+        remoteAddress: zod_1.z.string(),
+        creationDate: zod_1.z.number().int().optional(),
+        summary: zod_1.z.string().optional(),
+        description: zod_1.z.string().optional(),
+        category: zod_1.z.string().optional(),
+        sysAdmin: zod_1.z.boolean().optional(),
+        affectedObject: validationSchemaStorage
+            .lazy("AffectedObject")
+            .optional(),
+        changedValues: zod_1.z
+            .array(validationSchemaStorage.lazy("ChangedValue"))
+            .optional(),
+        associatedObjects: zod_1.z
+            .array(validationSchemaStorage.lazy("AffectedObject"))
+            .optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("AuditRecordCreate"));
+    validationSchemaStorage.register("ChangedValue", zod_1.z
+        .object({
+        name: zod_1.z.string(),
+        oldValue: zod_1.z.string(),
+        hiddenOldValue: zod_1.z.string().optional(),
+        newValue: zod_1.z.string(),
+        hiddenNewValue: zod_1.z.string().optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("ChangedValue"));
+    validationSchemaStorage.register("RetentionPeriod", zod_1.z
+        .object({
+        number: zod_1.z.number().int(),
+        units: zod_1.z.enum([
+            "NANOS",
+            "MICROS",
+            "MILLIS",
+            "SECONDS",
+            "MINUTES",
+            "HOURS",
+            "HALF_DAYS",
+            "DAYS",
+            "WEEKS",
+            "MONTHS",
+            "YEARS",
+            "DECADES",
+            "CENTURIES",
+            "MILLENNIA",
+            "ERAS",
+            "FOREVER",
+        ]),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("RetentionPeriod"));
+    validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+}
+exports.registerAuditValidationSchemas = registerAuditValidationSchemas;
+//# sourceMappingURL=audit.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"audit.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/audit.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAMkB;AAoKlB,SAAgB,8BAA8B,CAC5C,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,gBAAgB,EAChB,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;QAChB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;KACvB,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,gBAAgB,CAAC,CAC9B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,aAAa,EACb,OAAC;SACE,MAAM,CAAC;QACN,MAAM,EAAE,OAAC;aACN,MAAM,CAAC;YACN,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;YACtB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;YACvB,UAAU,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YAC1D,QAAQ,EAAE,OAAC;iBACR,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;iBACzD,QAAQ,EAAE;YACb,OAAO,EAAE,OAAC;iBACP,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;iBACxD,QAAQ,EAAE;YACb,SAAS,EAAE,OAAC;iBACT,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;iBAC1D,QAAQ,EAAE;YACb,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAClC,oBAAoB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;YAC5C,sBAAsB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;YAC9C,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAClC,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;QACxB,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;QACzB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QAC9B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;QACnB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;QACpB,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE;QACrB,UAAU,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAClC,cAAc,EAAE,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC;QAC9D,aAAa,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACpE,iBAAiB,EAAE,OAAC,CAAC,KAAK,CACxB,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAC/C;KACF,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,aAAa,CAAC,CAC3B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,kBAAkB,EAClB,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC7D,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,kBAAkB,CAAC,CAChC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,mBAAmB,EACnB,OAAC;SACE,MAAM,CAAC;QACN,MAAM,EAAE,OAAC;aACN,MAAM,CAAC;YACN,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;YACtB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAClC,UAAU,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;YACzD,QAAQ,EAAE,OAAC;iBACR,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;iBACzD,QAAQ,EAAE;YACb,OAAO,EAAE,OAAC;iBACP,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;iBACxD,QAAQ,EAAE;SACd,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;aACrB,QAAQ,EAAE;QACb,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;QACzB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACzC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAChC,cAAc,EAAE,uBAAuB;aACpC,IAAI,CAAC,gBAAgB,CAAC;aACtB,QAAQ,EAAE;QACb,aAAa,EAAE,OAAC;aACb,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;aACnD,QAAQ,EAAE;QACb,iBAAiB,EAAE,OAAC;aACjB,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACrD,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,mBAAmB,CAAC,CACjC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,cAAc,EACd,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;QAChB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;QACpB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACrC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;QACpB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KACtC,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,cAAc,CAAC,CAC5B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,iBAAiB,EACjB,OAAC;SACE,MAAM,CAAC;QACN,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACxB,KAAK,EAAE,OAAC,CAAC,IAAI,CAAC;YACZ,OAAO;YACP,QAAQ;YACR,QAAQ;YACR,SAAS;YACT,SAAS;YACT,OAAO;YACP,WAAW;YACX,MAAM;YACN,OAAO;YACP,QAAQ;YACR,OAAO;YACP,SAAS;YACT,WAAW;YACX,WAAW;YACX,MAAM;YACN,SAAS;SACV,CAAC;KACH,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,iBAAiB,CAAC,CAC/B,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AAhJD,wEAgJC"}