@resolution/confluence-api-client 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.2.0 (2024-06-07)
+
+
+### Features
+
+* first confluence API version ([d580ceb](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/d580cebbab7334f2290c08a307bea5eed8a372a5))

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2024 resolution Reichert Network Solutions GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+# confluence-api-client
+
+Atlassian Confluence API client based on OpenAPI schema.
+
+Compatible with the following request/fetch Atlassian libraries:
+
+ * [atlassian-connect-express](https://bitbucket.org/atlassian/atlassian-connect-express)
+ * [atlassian-connect-js](https://bitbucket.org/atlassian/atlassian-connect-js)
+ * [@forge/api](https://developer.atlassian.com/cloud/jira/platform/forge/)
+ * [@forge/bridge](https://developer.atlassian.com/cloud/jira/platform/forge/)
+
+More details will follow.

package/lib/index.d.ts

@@ -0,0 +1,36 @@
+import { type ApiClientAceOptions, type ApiClientApOptions, type ApiClientForgeApiExternalOptions, type ApiClientForgeApiOptions, ApiError, type ConfluenceApiClientForgeBridgeOptions, type JiraApiClientForgeBridgeOptions } from "@resolution/atlassian-api-common";
+import { BaseConfluenceApiV1Client } from "./openapi/v1/BaseConfluenceApiV1Client";
+import { BaseConfluenceApiV2Client } from "./openapi/v2/BaseConfluenceApiV2Client";
+export * from "./openapi/v1/BaseConfluenceApiV1Client";
+export * from "./openapi/v2/BaseConfluenceApiV2Client";
+export { ApiError };
+/**
+ * The Confluence REST API V2 Client.
+ */
+export declare class ConfluenceApi extends BaseConfluenceApiV2Client {
+    protected options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | ConfluenceApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions;
+    constructor(options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | ConfluenceApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions);
+    /**
+     * Switches the API client to the app context.
+     */
+    asApp: () => ConfluenceApi;
+    /**
+     * Switches the API client to the user context.
+     */
+    asUser: (userAccountId: string) => ConfluenceApi;
+}
+/**
+ * The Confluence REST API V1 Client.
+ */
+export declare class ConfluenceApiV1 extends BaseConfluenceApiV1Client {
+    protected options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions;
+    constructor(options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions);
+    /**
+     * Switches the API client to the app context.
+     */
+    asApp: () => ConfluenceApiV1;
+    /**
+     * Switches the API client to the user context.
+     */
+    asUser: (userAccountId: string) => ConfluenceApiV1;
+}

package/lib/index.js

@@ -0,0 +1,64 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfluenceApiV1 = exports.ConfluenceApi = exports.ApiError = void 0;
+const atlassian_api_common_1 = require("@resolution/atlassian-api-common");
+Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return atlassian_api_common_1.ApiError; } });
+const BaseConfluenceApiV1Client_1 = require("./openapi/v1/BaseConfluenceApiV1Client");
+const BaseConfluenceApiV2Client_1 = require("./openapi/v2/BaseConfluenceApiV2Client");
+__exportStar(require("./openapi/v1/BaseConfluenceApiV1Client"), exports);
+__exportStar(require("./openapi/v2/BaseConfluenceApiV2Client"), exports);
+const validationSchemaStorage_1 = require("./openapi/v1/validationSchemaStorage");
+const validationSchemaStorage_2 = require("./openapi/v2/validationSchemaStorage");
+validationSchemaStorage_2.validationSchemaStorage.setErrorClass(atlassian_api_common_1.ApiError);
+validationSchemaStorage_1.validationSchemaStorage.setErrorClass(atlassian_api_common_1.ApiError);
+/**
+ * The Confluence REST API V2 Client.
+ */
+class ConfluenceApi extends BaseConfluenceApiV2Client_1.BaseConfluenceApiV2Client {
+    constructor(options) {
+        super((0, atlassian_api_common_1.getApiClientOptions)(options));
+        this.options = options;
+        /**
+         * Switches the API client to the app context.
+         */
+        this.asApp = (0, atlassian_api_common_1.createAsAppMethod)();
+        /**
+         * Switches the API client to the user context.
+         */
+        this.asUser = (0, atlassian_api_common_1.createAsUserMethod)();
+    }
+}
+exports.ConfluenceApi = ConfluenceApi;
+/**
+ * The Confluence REST API V1 Client.
+ */
+class ConfluenceApiV1 extends BaseConfluenceApiV1Client_1.BaseConfluenceApiV1Client {
+    constructor(options) {
+        super((0, atlassian_api_common_1.getApiClientOptions)(options));
+        this.options = options;
+        /**
+         * Switches the API client to the app context.
+         */
+        this.asApp = (0, atlassian_api_common_1.createAsAppMethod)();
+        /**
+         * Switches the API client to the user context.
+         */
+        this.asUser = (0, atlassian_api_common_1.createAsUserMethod)();
+    }
+}
+exports.ConfluenceApiV1 = ConfluenceApiV1;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2EAW0C;AAQjC,yFAdP,+BAAQ,OAcO;AANjB,sFAAmF;AACnF,sFAAmF;AAEnF,yEAAuD;AACvD,yEAAuD;AAIvD,kFAAkH;AAClH,kFAAkH;AAElH,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AACxD,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AAExD;;GAEG;AACH,MAAa,aAAc,SAAQ,qDAAyB;IAC1D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAKxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAAwB,CAAC;QAClD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAAwB,CAAC;IATpD,CAAC;CAUF;AApBD,sCAoBC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAIxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IARtD,CAAC;CASF;AAnBD,0CAmBC"}

package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts

@@ -0,0 +1,133 @@
+import * as commonHttpClient from "./core/CommonHttpClient";
+import { CommonHttpService } from "./core/CommonHttpService";
+import type { AffectedObject, AuditRecord, AuditRecordArray, AuditRecordCreate, ChangedValue, RetentionPeriod } from "./models/audit";
+import type { AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, Icon, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, User, UserArray, UserDetails, VersionV1, WebResourceDependencies } from "./models/common";
+import type { ButtonLookAndFeel, ContainerLookAndFeel, ContentBlueprintDraft, ContentBodyCreateStorage, ContentChildType, ContentCreate, ContentHistory, ContentLookAndFeel, ContentMetadata, ContentUpdate, Embeddable, GlobalSpaceIdentifier, GroupArray, HeaderLookAndFeel, HorizontalHeaderLookAndFeel, MenusLookAndFeel, NavigationLookAndFeel, ScreenLookAndFeel, SearchFieldLookAndFeel, SpaceDescriptionV1, SpacePermissionV1, SuperBatchWebResources, TopNavigationLookAndFeel, UsersUserKeys } from "./models/content";
+import type { AttachmentPropertiesUpdateBody } from "./models/contentAttachments";
+import type { AsyncContentBody } from "./models/contentBody";
+import type { CopyPageHierarchyRequest, CopyPageHierarchyTitleOptions, CopyPageRequest, CopyPageRequestDestination } from "./models/contentChildrenAndDescendants";
+import type { LabelCreateArray } from "./models/contentLabels";
+import type { MacroInstance } from "./models/contentMacroBody";
+import type { ContentPermissionRequest, PermissionCheckResponse, PermissionSubjectWithGroupId } from "./models/contentPermissions";
+import type { ContentPropertyArray, ContentPropertyCreate, ContentPropertyCreateNoKey, ContentPropertyUpdate, ContentPropertyV1 } from "./models/contentProperties";
+import type { ContentRestrictionAddOrUpdateArray, ContentRestrictionArray, ContentRestrictionUpdate } from "./models/contentRestrictions";
+import type { AvailableContentStates, ContentState, ContentStateBulkSetTaskUpdate, ContentStateFailure, ContentStateResponse, ContentStateRestInput, ContentStateSettings } from "./models/contentStates";
+import type { VersionArray, VersionRestore } from "./models/contentVersions";
+import type { SpaceWatch, SpaceWatchArray, UserWatch, Watch, WatchArray, WatchUser } from "./models/contentWatches";
+import type { ConnectModule, ConnectModules, DynamicModulesErrorMessage } from "./models/dynamicModules";
+import type { AccountId, GroupName } from "./models/group";
+import type { TaskPageResponse, TaskStatusUpdate, TaskV1 } from "./models/inlineTasks";
+import type { LabelDetails, LabeledContent, LabeledContentPageResponse, LabeledContentType } from "./models/labelInfo";
+import type { LongTaskStatus, LongTaskStatusArray, LongTaskStatusWithLinks } from "./models/longRunningTask";
+import type { Relation, RelationArray, RelationData } from "./models/relation";
+import type { Breadcrumb, ContainerSummary, SearchPageResponseSearchResult, SearchResult } from "./models/search";
+import type { LookAndFeelSelection, LookAndFeelSettings, LookAndFeelWithLinks, SystemInfoEntity } from "./models/settings";
+import type { GroupCreate, SpaceArray, SpaceCreate, SpaceDescriptionCreate, SpacePermissionCreate, SpaceUpdate } from "./models/space";
+import type { PermissionSubject, SpacePermissionCustomContent, SpacePermissionRequest, SpacePermissionV2 } from "./models/spacePermissions";
+import type { PropertyValue, SpacePropertyArray, SpacePropertyCreate, SpacePropertyCreateNoKey, SpacePropertyUpdate, SpacePropertyV1 } from "./models/spaceProperties";
+import type { SpaceSettingsUpdate } from "./models/spaceSettings";
+import type { BlueprintTemplate, BlueprintTemplateArray, ContentTemplate, ContentTemplateArray, ContentTemplateBody, ContentTemplateBodyCreate, ContentTemplateCreate, ContentTemplateUpdate } from "./models/template";
+import type { ThemeArray, ThemeNoLinks, ThemeUpdate } from "./models/themes";
+import type { UserProperty, UserPropertyCreate, UserPropertyKeyArray, UserPropertyUpdate } from "./models/userProperties";
+import type { AccountIdEmailRecord, AccountIdEmailRecordArray, BulkUserLookup, BulkUserLookupArray, UserAnonymous } from "./models/users";
+import { AnalyticsService } from "./services/AnalyticsService";
+import { AuditService } from "./services/AuditService";
+import { ContentAttachmentsService } from "./services/ContentAttachmentsService";
+import { ContentBodyService } from "./services/ContentBodyService";
+import { ContentChildrenAndDescendantsService } from "./services/ContentChildrenAndDescendantsService";
+import { ContentCommentsService } from "./services/ContentCommentsService";
+import { ContentLabelsService } from "./services/ContentLabelsService";
+import { ContentMacroBodyService } from "./services/ContentMacroBodyService";
+import { ContentPermissionsService } from "./services/ContentPermissionsService";
+import { ContentPropertiesService } from "./services/ContentPropertiesService";
+import { ContentRestrictionsService } from "./services/ContentRestrictionsService";
+import { ContentService } from "./services/ContentService";
+import { ContentStatesService } from "./services/ContentStatesService";
+import { ContentVersionsService } from "./services/ContentVersionsService";
+import { ContentWatchesService } from "./services/ContentWatchesService";
+import { DynamicModulesService } from "./services/DynamicModulesService";
+import { ExperimentalService } from "./services/ExperimentalService";
+import { GroupService } from "./services/GroupService";
+import { InlineTasksService } from "./services/InlineTasksService";
+import { LabelInfoService } from "./services/LabelInfoService";
+import { LongRunningTaskService } from "./services/LongRunningTaskService";
+import { RelationService } from "./services/RelationService";
+import { SearchService } from "./services/SearchService";
+import { SettingsService } from "./services/SettingsService";
+import { SpacePermissionsService } from "./services/SpacePermissionsService";
+import { SpacePropertiesService } from "./services/SpacePropertiesService";
+import { SpaceService } from "./services/SpaceService";
+import { SpaceSettingsService } from "./services/SpaceSettingsService";
+import { TemplateService } from "./services/TemplateService";
+import { ThemesService } from "./services/ThemesService";
+import { UserPropertiesService } from "./services/UserPropertiesService";
+import { UsersService } from "./services/UsersService";
+export type BaseConfluenceApiV1ClientOptions = Partial<commonHttpClient.CommonHttpClientOptions>;
+export declare class BaseConfluenceApiV1ClientError extends commonHttpClient.CommonHttpClientError {
+    name: string;
+}
+/**
+ * The Confluence Cloud REST API
+ *
+ * This document describes the REST API and resources provided by Confluence. The
+ * REST APIs are for developers who want to integrate Confluence into their
+ * application and for administrators who want to script interactions with the
+ * Confluence server.Confluence's REST APIs provide access to resources (data
+ * entities) via URI paths. To use a REST API, your application will make an HTTP
+ * request and parse the response. The response format is JSON. Your methods will
+ * be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST
+ * API is based on open standards, you can use any web development language to
+ * access the API.
+ *
+ * @version 1.0.0
+ */
+export declare class BaseConfluenceApiV1Client extends CommonHttpService {
+    client: commonHttpClient.CommonHttpClient;
+    getClient: () => commonHttpClient.CommonHttpClient;
+    analytics: AnalyticsService;
+    audit: AuditService;
+    contentAttachments: ContentAttachmentsService;
+    contentBody: ContentBodyService;
+    contentChildrenAndDescendants: ContentChildrenAndDescendantsService;
+    /** @deprecated */
+    contentComments: ContentCommentsService;
+    contentLabels: ContentLabelsService;
+    contentMacroBody: ContentMacroBodyService;
+    contentPermissions: ContentPermissionsService;
+    /** @deprecated */
+    contentProperties: ContentPropertiesService;
+    contentRestrictions: ContentRestrictionsService;
+    content: ContentService;
+    contentStates: ContentStatesService;
+    contentVersions: ContentVersionsService;
+    contentWatches: ContentWatchesService;
+    dynamicModules: DynamicModulesService;
+    /** APIs in this section can change without any prior deprecation notice. */
+    experimental: ExperimentalService;
+    /**
+     * **[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/)
+     * The standard Atlassian group names are default names only and can be edited or
+     * deleted.**  For example, an admin or Atlassian support could delete the default
+     * group jira-software-users or rename it to jsw-users at any point.
+     */
+    group: GroupService;
+    /** @deprecated */
+    inlineTasks: InlineTasksService;
+    labelInfo: LabelInfoService;
+    longRunningTask: LongRunningTaskService;
+    relation: RelationService;
+    search: SearchService;
+    settings: SettingsService;
+    spacePermissions: SpacePermissionsService;
+    /** @deprecated */
+    spaceProperties: SpacePropertiesService;
+    space: SpaceService;
+    spaceSettings: SpaceSettingsService;
+    template: TemplateService;
+    themes: ThemesService;
+    userProperties: UserPropertiesService;
+    users: UsersService;
+    constructor(options?: BaseConfluenceApiV1ClientOptions);
+    static createClientWithServices: typeof commonHttpClient.createClientWithServices;
+}
+export type { AccountId, GroupName, AccountIdEmailRecord, AccountIdEmailRecordArray, BulkUserLookup, BulkUserLookupArray, UserAnonymous, AffectedObject, AuditRecord, AuditRecordArray, AuditRecordCreate, ChangedValue, RetentionPeriod, AsyncContentBody, AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, Icon, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, User, UserArray, UserDetails, VersionV1, WebResourceDependencies, AttachmentPropertiesUpdateBody, AvailableContentStates, ContentState, ContentStateBulkSetTaskUpdate, ContentStateFailure, ContentStateResponse, ContentStateRestInput, ContentStateSettings, BlueprintTemplate, BlueprintTemplateArray, ContentTemplate, ContentTemplateArray, ContentTemplateBody, ContentTemplateBodyCreate, ContentTemplateCreate, ContentTemplateUpdate, Breadcrumb, ContainerSummary, SearchPageResponseSearchResult, SearchResult, ButtonLookAndFeel, ContainerLookAndFeel, ContentBlueprintDraft, ContentBodyCreateStorage, ContentChildType, ContentCreate, ContentHistory, ContentLookAndFeel, ContentMetadata, ContentUpdate, Embeddable, GlobalSpaceIdentifier, GroupArray, HeaderLookAndFeel, HorizontalHeaderLookAndFeel, MenusLookAndFeel, NavigationLookAndFeel, ScreenLookAndFeel, SearchFieldLookAndFeel, SpaceDescriptionV1, SpacePermissionV1, SuperBatchWebResources, TopNavigationLookAndFeel, UsersUserKeys, ConnectModule, ConnectModules, DynamicModulesErrorMessage, ContentPermissionRequest, PermissionCheckResponse, PermissionSubjectWithGroupId, ContentPropertyArray, ContentPropertyCreate, ContentPropertyCreateNoKey, ContentPropertyUpdate, ContentPropertyV1, ContentRestrictionAddOrUpdateArray, ContentRestrictionArray, ContentRestrictionUpdate, CopyPageHierarchyRequest, CopyPageHierarchyTitleOptions, CopyPageRequest, CopyPageRequestDestination, GroupCreate, SpaceArray, SpaceCreate, SpaceDescriptionCreate, SpacePermissionCreate, SpaceUpdate, LabelCreateArray, LabelDetails, LabeledContent, LabeledContentPageResponse, LabeledContentType, LongTaskStatus, LongTaskStatusArray, LongTaskStatusWithLinks, LookAndFeelSelection, LookAndFeelSettings, LookAndFeelWithLinks, SystemInfoEntity, MacroInstance, PermissionSubject, SpacePermissionCustomContent, SpacePermissionRequest, SpacePermissionV2, PropertyValue, SpacePropertyArray, SpacePropertyCreate, SpacePropertyCreateNoKey, SpacePropertyUpdate, SpacePropertyV1, Relation, RelationArray, RelationData, SpaceSettingsUpdate, SpaceWatch, SpaceWatchArray, UserWatch, Watch, WatchArray, WatchUser, TaskPageResponse, TaskStatusUpdate, TaskV1, ThemeArray, ThemeNoLinks, ThemeUpdate, UserProperty, UserPropertyCreate, UserPropertyKeyArray, UserPropertyUpdate, VersionArray, VersionRestore, };

package/lib/openapi/v1/BaseConfluenceApiV1Client.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseConfluenceApiV1Client = exports.BaseConfluenceApiV1ClientError = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const commonHttpClient = require("./core/CommonHttpClient");
+const CommonHttpService_1 = require("./core/CommonHttpService");
+const AnalyticsService_1 = require("./services/AnalyticsService");
+const AuditService_1 = require("./services/AuditService");
+const ContentAttachmentsService_1 = require("./services/ContentAttachmentsService");
+const ContentBodyService_1 = require("./services/ContentBodyService");
+const ContentChildrenAndDescendantsService_1 = require("./services/ContentChildrenAndDescendantsService");
+const ContentCommentsService_1 = require("./services/ContentCommentsService");
+const ContentLabelsService_1 = require("./services/ContentLabelsService");
+const ContentMacroBodyService_1 = require("./services/ContentMacroBodyService");
+const ContentPermissionsService_1 = require("./services/ContentPermissionsService");
+const ContentPropertiesService_1 = require("./services/ContentPropertiesService");
+const ContentRestrictionsService_1 = require("./services/ContentRestrictionsService");
+const ContentService_1 = require("./services/ContentService");
+const ContentStatesService_1 = require("./services/ContentStatesService");
+const ContentVersionsService_1 = require("./services/ContentVersionsService");
+const ContentWatchesService_1 = require("./services/ContentWatchesService");
+const DynamicModulesService_1 = require("./services/DynamicModulesService");
+const ExperimentalService_1 = require("./services/ExperimentalService");
+const GroupService_1 = require("./services/GroupService");
+const InlineTasksService_1 = require("./services/InlineTasksService");
+const LabelInfoService_1 = require("./services/LabelInfoService");
+const LongRunningTaskService_1 = require("./services/LongRunningTaskService");
+const RelationService_1 = require("./services/RelationService");
+const SearchService_1 = require("./services/SearchService");
+const SettingsService_1 = require("./services/SettingsService");
+const SpacePermissionsService_1 = require("./services/SpacePermissionsService");
+const SpacePropertiesService_1 = require("./services/SpacePropertiesService");
+const SpaceService_1 = require("./services/SpaceService");
+const SpaceSettingsService_1 = require("./services/SpaceSettingsService");
+const TemplateService_1 = require("./services/TemplateService");
+const ThemesService_1 = require("./services/ThemesService");
+const UserPropertiesService_1 = require("./services/UserPropertiesService");
+const UsersService_1 = require("./services/UsersService");
+const validationSchemaStorage_1 = require("./validationSchemaStorage");
+class BaseConfluenceApiV1ClientError extends commonHttpClient.CommonHttpClientError {
+    constructor() {
+        super(...arguments);
+        this.name = "BaseConfluenceApiV1ClientError";
+    }
+}
+exports.BaseConfluenceApiV1ClientError = BaseConfluenceApiV1ClientError;
+/**
+ * The Confluence Cloud REST API
+ *
+ * This document describes the REST API and resources provided by Confluence. The
+ * REST APIs are for developers who want to integrate Confluence into their
+ * application and for administrators who want to script interactions with the
+ * Confluence server.Confluence's REST APIs provide access to resources (data
+ * entities) via URI paths. To use a REST API, your application will make an HTTP
+ * request and parse the response. The response format is JSON. Your methods will
+ * be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST
+ * API is based on open standards, you can use any web development language to
+ * access the API.
+ *
+ * @version 1.0.0
+ */
+class BaseConfluenceApiV1Client extends CommonHttpService_1.CommonHttpService {
+    constructor(options) {
+        super(() => this.client);
+        this.client = new commonHttpClient.CommonHttpClient({
+            baseUrl: "//your-domain.atlassian.net",
+            binaryResponseType: "blob",
+            errorClass: BaseConfluenceApiV1ClientError,
+        });
+        this.getClient = () => this.client;
+        this.analytics = new AnalyticsService_1.AnalyticsService(this.getClient);
+        this.audit = new AuditService_1.AuditService(this.getClient);
+        this.contentAttachments = new ContentAttachmentsService_1.ContentAttachmentsService(this.getClient);
+        this.contentBody = new ContentBodyService_1.ContentBodyService(this.getClient);
+        this.contentChildrenAndDescendants = new ContentChildrenAndDescendantsService_1.ContentChildrenAndDescendantsService(this.getClient);
+        /** @deprecated */
+        this.contentComments = new ContentCommentsService_1.ContentCommentsService(this.getClient);
+        this.contentLabels = new ContentLabelsService_1.ContentLabelsService(this.getClient);
+        this.contentMacroBody = new ContentMacroBodyService_1.ContentMacroBodyService(this.getClient);
+        this.contentPermissions = new ContentPermissionsService_1.ContentPermissionsService(this.getClient);
+        /** @deprecated */
+        this.contentProperties = new ContentPropertiesService_1.ContentPropertiesService(this.getClient);
+        this.contentRestrictions = new ContentRestrictionsService_1.ContentRestrictionsService(this.getClient);
+        this.content = new ContentService_1.ContentService(this.getClient);
+        this.contentStates = new ContentStatesService_1.ContentStatesService(this.getClient);
+        this.contentVersions = new ContentVersionsService_1.ContentVersionsService(this.getClient);
+        this.contentWatches = new ContentWatchesService_1.ContentWatchesService(this.getClient);
+        this.dynamicModules = new DynamicModulesService_1.DynamicModulesService(this.getClient);
+        /** APIs in this section can change without any prior deprecation notice. */
+        this.experimental = new ExperimentalService_1.ExperimentalService(this.getClient);
+        /**
+         * **[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/)
+         * The standard Atlassian group names are default names only and can be edited or
+         * deleted.**  For example, an admin or Atlassian support could delete the default
+         * group jira-software-users or rename it to jsw-users at any point.
+         */
+        this.group = new GroupService_1.GroupService(this.getClient);
+        /** @deprecated */
+        this.inlineTasks = new InlineTasksService_1.InlineTasksService(this.getClient);
+        this.labelInfo = new LabelInfoService_1.LabelInfoService(this.getClient);
+        this.longRunningTask = new LongRunningTaskService_1.LongRunningTaskService(this.getClient);
+        this.relation = new RelationService_1.RelationService(this.getClient);
+        this.search = new SearchService_1.SearchService(this.getClient);
+        this.settings = new SettingsService_1.SettingsService(this.getClient);
+        this.spacePermissions = new SpacePermissionsService_1.SpacePermissionsService(this.getClient);
+        /** @deprecated */
+        this.spaceProperties = new SpacePropertiesService_1.SpacePropertiesService(this.getClient);
+        this.space = new SpaceService_1.SpaceService(this.getClient);
+        this.spaceSettings = new SpaceSettingsService_1.SpaceSettingsService(this.getClient);
+        this.template = new TemplateService_1.TemplateService(this.getClient);
+        this.themes = new ThemesService_1.ThemesService(this.getClient);
+        this.userProperties = new UserPropertiesService_1.UserPropertiesService(this.getClient);
+        this.users = new UsersService_1.UsersService(this.getClient);
+        this.client.setOptions(Object.assign(Object.assign({}, this.client.getOptions()), options));
+    }
+}
+exports.BaseConfluenceApiV1Client = BaseConfluenceApiV1Client;
+BaseConfluenceApiV1Client.createClientWithServices = commonHttpClient.createClientWithServices;
+validationSchemaStorage_1.validationSchemaStorage.setErrorClass(BaseConfluenceApiV1ClientError);
+//# sourceMappingURL=BaseConfluenceApiV1Client.js.map

package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseConfluenceApiV1Client.js","sourceRoot":"","sources":["../../../src/openapi/v1/BaseConfluenceApiV1Client.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,4DAA4D;AAC5D,gEAA6D;AAoM7D,kEAA+D;AAC/D,0DAAuD;AACvD,oFAAiF;AACjF,sEAAmE;AACnE,0GAAuG;AACvG,8EAA2E;AAC3E,0EAAuE;AACvE,gFAA6E;AAC7E,oFAAiF;AACjF,kFAA+E;AAC/E,sFAAmF;AACnF,8DAA2D;AAC3D,0EAAuE;AACvE,8EAA2E;AAC3E,4EAAyE;AACzE,4EAAyE;AACzE,wEAAqE;AACrE,0DAAuD;AACvD,sEAAmE;AACnE,kEAA+D;AAC/D,8EAA2E;AAC3E,gEAA6D;AAC7D,4DAAyD;AACzD,gEAA6D;AAC7D,gFAA6E;AAC7E,8EAA2E;AAC3E,0DAAuD;AACvD,0EAAuE;AACvE,gEAA6D;AAC7D,4DAAyD;AACzD,4EAAyE;AACzE,0DAAuD;AACvD,uEAAoE;AAGpE,MAAa,8BAA+B,SAAQ,gBAAgB,CAAC,qBAAqB;IAA1F;;QACE,SAAI,GAAG,gCAAgC,CAAC;IAC1C,CAAC;CAAA;AAFD,wEAEC;AACD;;;;;;;;;;;;;;GAcG;AACH,MAAa,yBAA0B,SAAQ,qCAAiB;IAoD9D,YAAY,OAA0C;QACpD,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QApD3B,WAAM,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC;YAC7C,OAAO,EAAE,6BAA6B;YACtC,kBAAkB,EAAE,MAAM;YAC1B,UAAU,EAAE,8BAA8B;SAC3C,CAAC,CAAC;QACH,cAAS,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QAC9B,cAAS,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,uBAAkB,GAAG,IAAI,qDAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnE,gBAAW,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,kCAA6B,GAAG,IAAI,2EAAoC,CACtE,IAAI,CAAC,SAAS,CACf,CAAC;QACF,kBAAkB;QAClB,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,kBAAa,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,qBAAgB,GAAG,IAAI,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/D,uBAAkB,GAAG,IAAI,qDAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnE,kBAAkB;QAClB,sBAAiB,GAAG,IAAI,mDAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjE,wBAAmB,GAAG,IAAI,uDAA0B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrE,YAAO,GAAG,IAAI,+BAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,kBAAa,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,mBAAc,GAAG,IAAI,6CAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3D,mBAAc,GAAG,IAAI,6CAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3D,4EAA4E;QAC5E,iBAAY,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvD;;;;;WAKG;QACH,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,kBAAkB;QAClB,gBAAW,GAAG,IAAI,uCAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,cAAS,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,aAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,WAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,aAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,qBAAgB,GAAG,IAAI,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/D,kBAAkB;QAClB,oBAAe,GAAG,IAAI,+CAAsB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7D,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzC,kBAAa,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,aAAQ,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,WAAM,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3C,mBAAc,GAAG,IAAI,6CAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3D,UAAK,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAGvC,IAAI,CAAC,MAAM,CAAC,UAAU,iCACjB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GACxB,OAAO,EACV,CAAC;IACL,CAAC;;AA1DH,8DA4DC;AADQ,kDAAwB,GAAG,gBAAgB,CAAC,wBAAwB,AAA5C,CAA6C;AAE9E,iDAAuB,CAAC,aAAa,CAAC,8BAA8B,CAAC,CAAC"}

package/lib/openapi/v1/core/CommonHttpClient.d.ts

@@ -0,0 +1,196 @@
+export interface CommonHttpClientOptions {
+    baseUrl: string;
+    errorClass: {
+        new (url: URL, request: CommonHttpClientFetchRequest | undefined, response: CommonHttpClientFetchResponse | undefined, options: CommonHttpClientOptions | undefined, message: string): Error;
+    };
+    headers?: CommonHttpClientRequestHeaders;
+    preprocessRequest?: (request: CommonHttpClientRequest) => Promise<CommonHttpClientRequest>;
+    preprocessFetchResponse?: (response: CommonHttpClientFetchResponse, request: CommonHttpClientFetchRequest) => Promise<CommonHttpClientFetchResponse>;
+    fetch?: (url: URL, request: CommonHttpClientFetchRequest) => Promise<CommonHttpClientFetchResponse>;
+    binaryResponseType: "blob" | "readableStream";
+    formatHttpErrorMessage?: (response: CommonHttpClientFetchResponse, request: CommonHttpClientFetchRequest) => string;
+}
+export interface CommonHttpClientRequestHeaders {
+    [headerName: string]: string | undefined | null;
+}
+export interface CommonHttpClientFetchRequestHeaders {
+    [headerName: string]: string;
+}
+/**
+ * Request prepared for the fetch function.
+ */
+export interface CommonHttpClientFetchRequest {
+    /**
+     * HTTP Method.
+     */
+    method: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "PATCH";
+    /**
+     * Request headers.
+     */
+    headers: CommonHttpClientFetchRequestHeaders;
+    /**
+     * Request body.
+     */
+    body?: BodyInit;
+    /**
+     * Cache mode.
+     */
+    cache: "default" | "force-cache" | "no-cache" | "no-store" | "only-if-cached" | "reload";
+    /**
+     * Credentials mode.
+     */
+    credentials: "include" | "omit" | "same-origin";
+    /**
+     * Redirect mode.
+     */
+    redirect: "error" | "follow" | "manual";
+    /**
+     * Custom request properties. Can be used to pass metadata to the fetch function.
+     */
+    customRequestProps?: Record<string, unknown>;
+}
+/**
+ * Request in terms of OpenAPI.
+ */
+export type CommonHttpClientRequest = Omit<CommonHttpClientFetchRequest, "body" | "headers" | "cache" | "credentials" | "redirect"> & {
+    /**
+     * Path to the resource.
+     */
+    path: string;
+    /**
+     * Path parameters, i.e. {id}.
+     */
+    pathParams?: Record<string, unknown>;
+    /**
+     * Query parameters.
+     */
+    query?: Record<string, unknown>;
+    /**
+     * Request body.
+     */
+    body?: unknown;
+    /**
+     * Request headers.
+     */
+    headers?: CommonHttpClientRequestHeaders;
+} & Partial<Pick<CommonHttpClientFetchRequest, "cache" | "credentials" | "redirect">>;
+/**
+ * Response of the fetch function.
+ */
+export interface CommonHttpClientFetchResponse {
+    /**
+     * HTTP status code.
+     */
+    status: number;
+    /**
+     * HTTP status code explanation.
+     */
+    statusText: string;
+    /**
+     * Response body.
+     */
+    body: CommonHttpClientFetchResponseBody;
+    /**
+     * Whether the request was successful. True for 2xx status codes.
+     */
+    ok: boolean;
+    /**
+     * The final URL of the request (after redirects).
+     */
+    url: string;
+    /**
+     * Response headers.
+     */
+    headers: CommonHttpClientResponseHeaders;
+    /**
+     * Custom request properties. Can be used to pass metadata outside the fetch function.
+     */
+    customRequestProps?: Record<string, unknown>;
+}
+export type CommonHttpClientResponseHeaders = Record<string, string> & {
+    "set-cookie"?: string[];
+};
+export type CommonHttpClientFetchResponseBody = {
+    type: "json";
+    data: unknown;
+} | {
+    type: "blob";
+    data: Blob;
+} | {
+    type: "readableStream";
+    data: ReadableStream<Uint8Array>;
+};
+export interface CommonHttpClientResponse<T> {
+    status: number;
+    mediaType?: string;
+    body: T;
+    response: CommonHttpClientFetchResponse;
+}
+export declare class CommonHttpClientError extends Error {
+    readonly url: URL;
+    readonly request: CommonHttpClientFetchRequest | undefined;
+    readonly response: CommonHttpClientFetchResponse | undefined;
+    readonly options: CommonHttpClientOptions | undefined;
+    constructor(url: URL, request: CommonHttpClientFetchRequest | undefined, response: CommonHttpClientFetchResponse | undefined, options: CommonHttpClientOptions | undefined, message: string);
+}
+/**
+ * `extends unknown` is a trick to split the union into individual types.
+ */
+type ResponseByMediaType<T extends CommonHttpClientResponse<unknown>, K extends string> = T extends unknown ? ((a: T) => void) extends (a: {
+    mediaType: K;
+    status: infer _Status;
+    body: infer _Body;
+    response: CommonHttpClientFetchResponse;
+}) => void ? T : never : never;
+export declare function checkReponseMediaType<T extends CommonHttpClientResponse<unknown>, K extends string>(response: T, mediaType: K): response is ResponseByMediaType<T, K> extends never ? ResponseByMediaType<T, "*/*"> : ResponseByMediaType<T, K>;
+export declare function isJsonMediaType(mediaType: string): boolean;
+type AsCreatedResponseFunction<KCreated extends string, KOther extends string> = <T extends CommonHttpClientResponse<unknown>>(response: T) => ({
+    [K in KCreated]: Extract<T, {
+        status: 201;
+    }>["body"];
+} & {
+    created: true;
+}) | ({
+    [K in KOther]: Extract<T, {
+        status: 200;
+    }>["body"];
+} & {
+    created: false;
+});
+export declare function asCreatedResponse<KCreated extends string>(keyCreated: KCreated): AsCreatedResponseFunction<KCreated, KCreated>;
+export declare function asCreatedResponse<KCreated extends string, KOther extends string>(keyCreated: KCreated, keyOther: KOther): AsCreatedResponseFunction<KCreated, KOther>;
+export declare const getBody: <T>({ body }: CommonHttpClientResponse<T>) => T;
+export declare const castResponse: <T extends Omit<CommonHttpClientResponse<unknown>, "response">>() => (response: CommonHttpClientResponse<unknown>) => WithResponse<T>;
+export declare const discardResult: () => void;
+export type WithResponse<T> = T & {
+    response: CommonHttpClientFetchResponse;
+};
+export declare function createClientWithServices<TOptions, TClient extends {
+    getClient(): CommonHttpClient;
+}, TServices extends Record<string, {
+    new (client: CommonHttpClient): unknown;
+}>>(this: {
+    new (options?: TOptions): TClient;
+}, services: TServices, options?: TOptions): TClient & {
+    [K in keyof TServices as K extends string ? Uncapitalize<K extends `${infer TName}Service` ? TName : K> : K]: InstanceType<TServices[K]>;
+};
+export declare class CommonHttpClient {
+    protected options: CommonHttpClientOptions;
+    constructor(options: CommonHttpClientOptions);
+    setOptions(options: CommonHttpClientOptions): void;
+    getOptions(): CommonHttpClientOptions;
+    protected getSearchParams(params: Record<string, unknown>): URLSearchParams;
+    protected buildUrlPath(request: CommonHttpClientRequest): string;
+    protected buildUrl(request: CommonHttpClientRequest): URL;
+    protected fetch(url: URL, request: CommonHttpClientFetchRequest): Promise<CommonHttpClientFetchResponse>;
+    request(request: CommonHttpClientRequest): Promise<CommonHttpClientFetchResponse>;
+    responseHandler(distribution: {
+        [statusCode: string]: {
+            [mediaType: string]: CommonHttpClientFetchResponseBody["type"];
+        };
+    }): (response: CommonHttpClientFetchResponse) => Promise<CommonHttpClientResponse<unknown>>;
+    private cleanupHeaders;
+    protected getRequestBody(request: CommonHttpClientRequest): BodyInit | undefined;
+    protected preprocessRequest(request: CommonHttpClientRequest): Promise<CommonHttpClientRequest>;
+}
+export {};