@resolution/confluence-api-client 0.2.0

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

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSettingsValidationSchemas = 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 registerSettingsValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("LookAndFeelSelection", zod_1.z
+        .object({
+        spaceKey: zod_1.z.string(),
+        lookAndFeelType: zod_1.z.enum(["global", "custom", "theme"]),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("LookAndFeelSelection"));
+    validationSchemaStorage.register("LookAndFeelSettings", zod_1.z
+        .object({
+        selected: zod_1.z.enum(["global", "custom"]),
+        global: validationSchemaStorage.lazy("LookAndFeel"),
+        theme: validationSchemaStorage.lazy("LookAndFeel").optional(),
+        custom: validationSchemaStorage.lazy("LookAndFeel"),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("LookAndFeelSettings"));
+    validationSchemaStorage.register("LookAndFeelWithLinks", zod_1.z
+        .intersection(validationSchemaStorage.lazy("LookAndFeel"), zod_1.z
+        .object({
+        _links: validationSchemaStorage.lazy("GenericLinks").optional(),
+    })
+        .catchall(zod_1.z.unknown()))
+        .describe("LookAndFeelWithLinks"));
+    validationSchemaStorage.register("SystemInfoEntity", zod_1.z
+        .object({
+        cloudId: zod_1.z.string(),
+        commitHash: zod_1.z.string(),
+        baseUrl: zod_1.z.string().optional(),
+        fallbackBaseUrl: zod_1.z.string().optional(),
+        edition: zod_1.z.string().optional(),
+        siteTitle: zod_1.z.string().optional(),
+        defaultLocale: zod_1.z.string().optional(),
+        defaultTimeZone: zod_1.z.string().optional(),
+        microsPerimeter: zod_1.z.string().optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SystemInfoEntity"));
+    validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+}
+exports.registerSettingsValidationSchemas = registerSettingsValidationSchemas;
+//# sourceMappingURL=settings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/settings.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAIkB;AAkClB,SAAgB,iCAAiC,CAC/C,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,sBAAsB,EACtB,OAAC;SACE,MAAM,CAAC;QACN,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;QACpB,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;KACvD,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,sBAAsB,CAAC,CACpC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,qBAAqB,EACrB,OAAC;SACE,MAAM,CAAC;QACN,QAAQ,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACtC,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC;QACnD,KAAK,EAAE,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;QAC7D,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC;KACpD,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,qBAAqB,CAAC,CACnC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,sBAAsB,EACtB,OAAC;SACE,YAAY,CACX,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC,EAC3C,OAAC;SACE,MAAM,CAAC;QACN,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE;KAChE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;SACA,QAAQ,CAAC,sBAAsB,CAAC,CACpC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,kBAAkB,EAClB,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;QACnB,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;QACtB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACtC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACpC,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACtC,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,kBAAkB,CAAC,CAChC,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AAxDD,8EAwDC"}

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

@@ -0,0 +1,118 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+import { type GenericLinks, type OperationCheckResult, type Space, type User } from "./common";
+/** The name property will soon be deprecated in favor of using id. */
+export interface GroupCreate extends Record<string, unknown> {
+    type: "group";
+    /** @deprecated */
+    name?: string;
+    id?: string;
+}
+export interface SpaceArray extends Record<string, unknown> {
+    results: (Space | null)[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+}
+/** This is the request object used when creating a new space. */
+export interface SpaceCreate extends Record<string, unknown> {
+    /**
+     * The key for the new space. Format: See [Space
+     * keys](https://confluence.atlassian.com/x/lqNMMQ).
+     */
+    key: string;
+    /** The name of the new space. */
+    name: string;
+    /**
+     * The description of the new/updated space. Note, only the 'plain' representation
+     * can be used for the description when creating or updating a space.
+     */
+    description?: SpaceDescriptionCreate | null;
+    /**
+     * The permissions for the new space. If no permissions are provided, the
+     * [Confluence default space
+     * permissions](https://confluence.atlassian.com/x/UAgzKw#CreateaSpace-Spacepermissions)
+     * are applied. Note that if permissions are provided, the space is
+     * created with only the provided set of permissions, not
+     * including the default space permissions. Space permissions
+     * can be modified after creation using the space permissions
+     * endpoints, and a private space can be created using the
+     * create private space endpoint.
+     */
+    permissions?: SpacePermissionCreate[] | null;
+}
+/**
+ * The description of the new/updated space. Note, only the 'plain' representation
+ * can be used for the description when creating or updating a space.
+ */
+export interface SpaceDescriptionCreate extends Record<string, unknown> {
+    plain: {
+        /** The space description. */
+        value?: string;
+        /** Set to 'plain'. */
+        representation?: string;
+    } & {
+        [key: string]: unknown;
+    };
+}
+/**
+ * This object represents a permission for given space. Permissions consist of
+ * at least one operation object with an accompanying subjects object.
+ *
+ * The following combinations of `operation` and `targetType` values are
+ * valid for the `operation` object:
+ *
+ *   - 'create': 'page', 'blogpost', 'comment', 'attachment'
+ *   - 'read': 'space'
+ *   - 'delete': 'page', 'blogpost', 'comment', 'attachment'
+ *   - 'export': 'space'
+ *   - 'administer': 'space'
+ */
+export interface SpacePermissionCreate extends Record<string, unknown> {
+    /** The users and/or groups that the permission applies to. */
+    subjects?: {
+        user?: {
+            results: (User | null)[];
+            size: number;
+        } & {
+            [key: string]: unknown;
+        };
+        group?: {
+            results: GroupCreate[];
+            size: number;
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    };
+    /** An operation and the target entity that it applies to, e.g. create page. */
+    operation: OperationCheckResult;
+    /** Grant anonymous users permission to use the operation. */
+    anonymousAccess: boolean;
+    /**
+     * Grants access to unlicensed users from JIRA Service Desk when used
+     * with the 'read space' operation.
+     */
+    unlicensedAccess: boolean;
+}
+/** The properties of a space that can be updated. */
+export interface SpaceUpdate extends Record<string, unknown> {
+    /** The updated name of the space. */
+    name?: string | null;
+    /**
+     * The description of the new/updated space. Note, only the 'plain' representation
+     * can be used for the description when creating or updating a space.
+     */
+    description?: SpaceDescriptionCreate | null;
+    /** The updated homepage for this space */
+    homepage?: {
+        [key: string]: unknown;
+    } | null;
+    /** The updated type for this space. */
+    type?: string;
+    /** The updated status for this space. */
+    status?: string | null;
+}
+export declare function registerSpaceValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;

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

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSpaceValidationSchemas = 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 registerSpaceValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("GroupCreate", zod_1.z
+        .object({
+        type: zod_1.z.enum(["group"]),
+        name: zod_1.z.string().optional(),
+        id: zod_1.z.string().optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("GroupCreate"));
+    validationSchemaStorage.register("SpaceArray", zod_1.z
+        .object({
+        results: zod_1.z.array(zod_1.z.nullable(validationSchemaStorage.lazy("Space"))),
+        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("SpaceArray"));
+    validationSchemaStorage.register("SpaceCreate", zod_1.z
+        .object({
+        key: zod_1.z.string(),
+        name: zod_1.z.string().max(200),
+        description: zod_1.z
+            .nullable(validationSchemaStorage.lazy("SpaceDescriptionCreate"))
+            .optional(),
+        permissions: zod_1.z
+            .nullable(zod_1.z.array(validationSchemaStorage.lazy("SpacePermissionCreate")))
+            .optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SpaceCreate"));
+    validationSchemaStorage.register("SpaceDescriptionCreate", zod_1.z
+        .object({
+        plain: zod_1.z
+            .object({
+            value: zod_1.z.string().optional(),
+            representation: zod_1.z.string().optional(),
+        })
+            .catchall(zod_1.z.unknown()),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SpaceDescriptionCreate"));
+    validationSchemaStorage.register("SpacePermissionCreate", zod_1.z
+        .object({
+        subjects: zod_1.z
+            .object({
+            user: zod_1.z
+                .object({
+                results: zod_1.z.array(zod_1.z.nullable(validationSchemaStorage.lazy("User"))),
+                size: zod_1.z.number().int(),
+            })
+                .catchall(zod_1.z.unknown())
+                .optional(),
+            group: zod_1.z
+                .object({
+                results: zod_1.z.array(validationSchemaStorage.lazy("GroupCreate")),
+                size: zod_1.z.number().int(),
+            })
+                .catchall(zod_1.z.unknown())
+                .optional(),
+        })
+            .catchall(zod_1.z.unknown())
+            .optional(),
+        operation: validationSchemaStorage.lazy("OperationCheckResult"),
+        anonymousAccess: zod_1.z.boolean(),
+        unlicensedAccess: zod_1.z.boolean(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SpacePermissionCreate"));
+    validationSchemaStorage.register("SpaceUpdate", zod_1.z
+        .object({
+        name: zod_1.z.nullable(zod_1.z.string().max(200)).optional(),
+        description: zod_1.z
+            .nullable(validationSchemaStorage.lazy("SpaceDescriptionCreate"))
+            .optional(),
+        homepage: zod_1.z.nullable(zod_1.z.object({}).catchall(zod_1.z.unknown())).optional(),
+        type: zod_1.z.string().optional(),
+        status: zod_1.z.nullable(zod_1.z.string()).optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SpaceUpdate"));
+    validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+}
+exports.registerSpaceValidationSchemas = registerSpaceValidationSchemas;
+//# sourceMappingURL=space.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"space.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/space.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAMkB;AAmHlB,SAAgB,8BAA8B,CAC5C,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,aAAa,EACb,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC;QACvB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC1B,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,aAAa,CAAC,CAC3B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,YAAY,EACZ,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACnE,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,YAAY,CAAC,CAC1B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,aAAa,EACb,OAAC;SACE,MAAM,CAAC;QACN,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;QACf,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;QACzB,WAAW,EAAE,OAAC;aACX,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;aAChE,QAAQ,EAAE;QACb,WAAW,EAAE,OAAC;aACX,QAAQ,CACP,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAC/D;aACA,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,aAAa,CAAC,CAC3B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,wBAAwB,EACxB,OAAC;SACE,MAAM,CAAC;QACN,KAAK,EAAE,OAAC;aACL,MAAM,CAAC;YACN,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC5B,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACtC,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;KACzB,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,wBAAwB,CAAC,CACtC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,uBAAuB,EACvB,OAAC;SACE,MAAM,CAAC;QACN,QAAQ,EAAE,OAAC;aACR,MAAM,CAAC;YACN,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC,CAAC,KAAK,CACd,OAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CACjD;gBACD,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;aACvB,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;iBACrB,QAAQ,EAAE;YACb,KAAK,EAAE,OAAC;iBACL,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC7D,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;aACvB,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;iBACrB,QAAQ,EAAE;SACd,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;aACrB,QAAQ,EAAE;QACb,SAAS,EAAE,uBAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC;QAC/D,eAAe,EAAE,OAAC,CAAC,OAAO,EAAE;QAC5B,gBAAgB,EAAE,OAAC,CAAC,OAAO,EAAE;KAC9B,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,uBAAuB,CAAC,CACrC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,aAAa,EACb,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE;QAChD,WAAW,EAAE,OAAC;aACX,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;aAChE,QAAQ,EAAE;QACb,QAAQ,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;QACnE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,MAAM,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KAC1C,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,aAAa,CAAC,CAC3B,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AA3GD,wEA2GC"}

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

@@ -0,0 +1,128 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+import { type GenericLinks } from "./common";
+/** The user or group that the permission applies to. */
+export interface PermissionSubject extends Record<string, unknown> {
+    type: "user" | "group";
+    /**
+     * for `type=user`, identifier should be user's accountId or `anonymous` for
+     * anonymous users
+     *
+     * for `type=group`, identifier should be the groupId. We are deprecating
+     * groupName support in mid-2024
+     * for this field but still accept it in the interim.
+     */
+    identifier: string;
+}
+/**
+ * This object represents a list of space permissions for custom content type for
+ * an individual user. Permissions consist of
+ * a subjects object and a list with at least one operation object.
+ */
+export interface SpacePermissionCustomContent extends Record<string, unknown> {
+    /** The user or group that the permission applies to. */
+    subject: PermissionSubject;
+    operations: ({
+        /** The operation type */
+        key: "read" | "create" | "delete";
+        /** The custom content type */
+        target: string;
+        /** Grant or restrict access */
+        access: boolean;
+    } & {
+        [key: string]: unknown;
+    })[];
+}
+/**
+ * This object represents the request for the single space permission. Permissions
+ * consist of
+ * one operation object with an accompanying subjects object.
+ *
+ * The following combinations of `operation.key` and `operation.target` values are
+ * valid for the `operation` object:
+ * ``` bash
+ * 'create': 'page', 'blogpost', 'comment', 'attachment'
+ * 'read': 'space'
+ * 'delete': 'page', 'blogpost', 'comment', 'attachment', 'space'
+ * 'export': 'space'
+ * 'administer': 'space'
+ * 'archive': 'page'
+ * 'restrict_content': 'space'
+ * ```
+ *
+ * For example, to enable Delete Own permission, set the `operation` object to the
+ * following:
+ * ```
+ * "operation": {
+ *     "key": "delete",
+ *     "target": "space"
+ * }
+ * ```
+ * To enable Add/Delete Restrictions permissions, set the `operation` object to
+ * the following:
+ * ```
+ * "operation": {
+ *     "key": "restrict_content",
+ *     "target": "space"
+ * }
+ * ```
+ */
+export interface SpacePermissionRequest extends Record<string, unknown> {
+    /** The user or group that the permission applies to. */
+    subject: PermissionSubject;
+    operation: {
+        key: "administer" | "archive" | "copy" | "create" | "delete" | "export" | "move" | "purge" | "purge_version" | "read" | "restore" | "restrict_content" | "update" | "use";
+        /** The space or content type that the operation applies to. */
+        target: "page" | "blogpost" | "comment" | "attachment" | "space";
+    } & {
+        [key: string]: unknown;
+    };
+    _links?: GenericLinks;
+}
+/**
+ * This object represents a single space permission. Permissions consist of
+ * at least one operation object with an accompanying subjects object.
+ *
+ * The following combinations of `operation.key` and `operation.target` values are
+ * valid for the `operation` object:
+ * ``` bash
+ * 'create': 'page', 'blogpost', 'comment', 'attachment'
+ * 'read': 'space'
+ * 'delete': 'page', 'blogpost', 'comment', 'attachment', 'space'
+ * 'export': 'space'
+ * 'administer': 'space'
+ * 'archive': 'page'
+ * 'restrict_content': 'space'
+ * ```
+ *
+ * For example, to enable Delete Own permission, set the `operation` object to the
+ * following:
+ * ```
+ * "operation": {
+ *     "key": "delete",
+ *     "target": "space"
+ * }
+ * ```
+ * To enable Add/Delete Restrictions permissions, set the `operation` object to
+ * the following:
+ * ```
+ * "operation": {
+ *     "key": "restrict_content",
+ *     "target": "space"
+ * }
+ * ```
+ */
+export interface SpacePermissionV2 extends Record<string, unknown> {
+    id: number;
+    /** The user or group that the permission applies to. */
+    subject: PermissionSubject;
+    operation: {
+        key: "administer" | "archive" | "copy" | "create" | "delete" | "export" | "move" | "purge" | "purge_version" | "read" | "restore" | "restrict_content" | "update" | "use";
+        /** The space or content type that the operation applies to. */
+        target: "page" | "blogpost" | "comment" | "attachment" | "space";
+    } & {
+        [key: string]: unknown;
+    };
+    _links?: GenericLinks;
+}
+export declare function registerSpacePermissionsValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;

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

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSpacePermissionsValidationSchemas = 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 registerSpacePermissionsValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("PermissionSubject", zod_1.z
+        .object({
+        type: zod_1.z.enum(["user", "group"]),
+        identifier: zod_1.z.string(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("PermissionSubject"));
+    validationSchemaStorage.register("SpacePermissionCustomContent", zod_1.z
+        .object({
+        subject: validationSchemaStorage.lazy("PermissionSubject"),
+        operations: zod_1.z.array(zod_1.z
+            .object({
+            key: zod_1.z.enum(["read", "create", "delete"]),
+            target: zod_1.z.string(),
+            access: zod_1.z.boolean(),
+        })
+            .catchall(zod_1.z.unknown())),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SpacePermissionCustomContent"));
+    validationSchemaStorage.register("SpacePermissionRequest", zod_1.z
+        .object({
+        subject: validationSchemaStorage.lazy("PermissionSubject"),
+        operation: zod_1.z
+            .object({
+            key: zod_1.z.enum([
+                "administer",
+                "archive",
+                "copy",
+                "create",
+                "delete",
+                "export",
+                "move",
+                "purge",
+                "purge_version",
+                "read",
+                "restore",
+                "restrict_content",
+                "update",
+                "use",
+            ]),
+            target: zod_1.z.enum([
+                "page",
+                "blogpost",
+                "comment",
+                "attachment",
+                "space",
+            ]),
+        })
+            .catchall(zod_1.z.unknown()),
+        _links: validationSchemaStorage.lazy("GenericLinks").optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SpacePermissionRequest"));
+    validationSchemaStorage.register("SpacePermissionV2", zod_1.z
+        .object({
+        id: zod_1.z.number().int(),
+        subject: validationSchemaStorage.lazy("PermissionSubject"),
+        operation: zod_1.z
+            .object({
+            key: zod_1.z.enum([
+                "administer",
+                "archive",
+                "copy",
+                "create",
+                "delete",
+                "export",
+                "move",
+                "purge",
+                "purge_version",
+                "read",
+                "restore",
+                "restrict_content",
+                "update",
+                "use",
+            ]),
+            target: zod_1.z.enum([
+                "page",
+                "blogpost",
+                "comment",
+                "attachment",
+                "space",
+            ]),
+        })
+            .catchall(zod_1.z.unknown()),
+        _links: validationSchemaStorage.lazy("GenericLinks").optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SpacePermissionV2"));
+    validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+}
+exports.registerSpacePermissionsValidationSchemas = registerSpacePermissionsValidationSchemas;
+//# sourceMappingURL=spacePermissions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"spacePermissions.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/spacePermissions.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAA8E;AAyJ9E,SAAgB,yCAAyC,CACvD,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,mBAAmB,EACnB,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/B,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;KACvB,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,mBAAmB,CAAC,CACjC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,8BAA8B,EAC9B,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,uBAAuB,CAAC,IAAI,CAAC,mBAAmB,CAAC;QAC1D,UAAU,EAAE,OAAC,CAAC,KAAK,CACjB,OAAC;aACE,MAAM,CAAC;YACN,GAAG,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACzC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;YAClB,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE;SACpB,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;KACF,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,8BAA8B,CAAC,CAC5C,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,wBAAwB,EACxB,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,uBAAuB,CAAC,IAAI,CAAC,mBAAmB,CAAC;QAC1D,SAAS,EAAE,OAAC;aACT,MAAM,CAAC;YACN,GAAG,EAAE,OAAC,CAAC,IAAI,CAAC;gBACV,YAAY;gBACZ,SAAS;gBACT,MAAM;gBACN,QAAQ;gBACR,QAAQ;gBACR,QAAQ;gBACR,MAAM;gBACN,OAAO;gBACP,eAAe;gBACf,MAAM;gBACN,SAAS;gBACT,kBAAkB;gBAClB,QAAQ;gBACR,KAAK;aACN,CAAC;YACF,MAAM,EAAE,OAAC,CAAC,IAAI,CAAC;gBACb,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,YAAY;gBACZ,OAAO;aACR,CAAC;SACH,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;QACxB,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE;KAChE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,wBAAwB,CAAC,CACtC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,mBAAmB,EACnB,OAAC;SACE,MAAM,CAAC;QACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACpB,OAAO,EAAE,uBAAuB,CAAC,IAAI,CAAC,mBAAmB,CAAC;QAC1D,SAAS,EAAE,OAAC;aACT,MAAM,CAAC;YACN,GAAG,EAAE,OAAC,CAAC,IAAI,CAAC;gBACV,YAAY;gBACZ,SAAS;gBACT,MAAM;gBACN,QAAQ;gBACR,QAAQ;gBACR,QAAQ;gBACR,MAAM;gBACN,OAAO;gBACP,eAAe;gBACf,MAAM;gBACN,SAAS;gBACT,kBAAkB;gBAClB,QAAQ;gBACR,KAAK;aACN,CAAC;YACF,MAAM,EAAE,OAAC,CAAC,IAAI,CAAC;gBACb,MAAM;gBACN,UAAU;gBACV,SAAS;gBACT,YAAY;gBACZ,OAAO;aACR,CAAC;SACH,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;QACxB,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE;KAChE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,mBAAmB,CAAC,CACjC,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AA3GD,8FA2GC"}

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

@@ -0,0 +1,96 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+import { type GenericLinks, type Space, type VersionV1 } from "./common";
+/**
+ * The value of the property. This can be empty or a complex object. 64KB Size
+ * Limit
+ * For example,
+ * ```
+ * "value": {
+ *   "example1": "value",
+ *   "example2": true,
+ *   "example3": 123,
+ *   "example4": ["value1", "value2"],
+ * }
+ * ```
+ */
+export type PropertyValue = string[] | boolean | {
+    [key: string]: unknown;
+} | string;
+export interface SpacePropertyArray extends Record<string, unknown> {
+    results: SpacePropertyV1[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+}
+export interface SpacePropertyCreate extends Record<string, unknown> {
+    /** The key of the new property. */
+    key: string;
+    /**
+     * The value of the property. This can be empty or a complex object. 64KB Size
+     * Limit
+     * For example,
+     * ```
+     * "value": {
+     *   "example1": "value",
+     *   "example2": true,
+     *   "example3": 123,
+     *   "example4": ["value1", "value2"],
+     * }
+     * ```
+     */
+    value: PropertyValue;
+    space?: {
+        /** The key of the space */
+        key?: string;
+    } & {
+        [key: string]: unknown;
+    };
+}
+export interface SpacePropertyCreateNoKey extends Record<string, unknown> {
+    /**
+     * The value of the property. This can be empty or a complex object. 64KB Size
+     * Limit
+     * For example,
+     * ```
+     * "value": {
+     *   "example1": "value",
+     *   "example2": true,
+     *   "example3": 123,
+     *   "example4": ["value1", "value2"],
+     * }
+     * ```
+     */
+    value: PropertyValue;
+}
+export interface SpacePropertyUpdate extends Record<string, unknown> {
+    key?: string;
+    value: string[] | boolean | {
+        [key: string]: unknown;
+    } | string;
+    version: VersionV1 | null;
+    space?: {
+        /** The key of the space */
+        key?: string;
+    } & {
+        [key: string]: unknown;
+    };
+}
+export interface SpacePropertyV1 extends Record<string, unknown> {
+    id: string;
+    key: string;
+    value: string[] | boolean | {
+        [key: string]: unknown;
+    } | string;
+    version?: VersionV1 | null;
+    space?: Space | null;
+    _links?: GenericLinks;
+    _expandable: {
+        version?: string;
+        space?: string;
+    } & {
+        [key: string]: unknown;
+    };
+}
+export declare function registerSpacePropertiesValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;