@resolution/jira-api-client 0.5.5 → 0.5.6

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.5.6](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.5.5...v0.5.6) (2024-07-05)
+
+
+### Bug Fixes
+
+* confluence api constructor options, improve docs ([194e14f](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/194e14fe351b6a17a442105f6b27931ee7e6cf27))
+
+
+
+
+
 ## [0.5.5](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.5.4...v0.5.5) (2024-07-02)
 
 **Note:** Version bump only for package @resolution/jira-api-client

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { type ApiClientAceOptions, type ApiClientApOptions, type ApiClientForgeApiExternalOptions, type ApiClientForgeApiOptions, ApiError, type JiraApiClientForgeBridgeOptions } from "@resolution/atlassian-api-common";
+import { type ApiClientAceOptions, type ApiClientApOptions, type ApiClientForgeApiExternalOptions, type ApiClientForgeApiOptions, type ApiClientForgeBridgeJiraOptions, ApiError } from "@resolution/atlassian-api-common";
 import { BaseJiraPlatformApiClient } from "./openapi/platform/BaseJiraPlatformApiClient";
 import { BaseJiraServiceManagementApiClient } from "./openapi/serviceManagement/BaseJiraServiceManagementApiClient";
 import { BaseJiraSoftwareApiClient } from "./openapi/software/BaseJiraSoftwareApiClient";
@@ -6,48 +6,76 @@ export * from "./openapi/platform/BaseJiraPlatformApiClient";
 export * from "./openapi/software/BaseJiraSoftwareApiClient";
 export * from "./openapi/serviceManagement/BaseJiraServiceManagementApiClient";
 export { ApiError };
+export { ApiClientForgeApiOptions, ApiClientForgeApiExternalOptions, ApiClientForgeBridgeJiraOptions, ApiClientAceOptions, ApiClientApOptions, };
 /**
  * The Jira Cloud Platform REST API Client.
+ *
+ * @category API Clients
  */
 export declare class JiraPlatformApi extends BaseJiraPlatformApiClient {
-    protected options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions;
-    constructor(options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions);
+    protected options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | ApiClientForgeBridgeJiraOptions | ApiClientAceOptions | ApiClientApOptions;
+    /**
+     * @category Constructor
+     */
+    constructor(options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | ApiClientForgeBridgeJiraOptions | ApiClientAceOptions | ApiClientApOptions);
     /**
      * Switches the API client to the app context.
+     *
+     * @category Impersonalization
      */
     asApp: () => JiraPlatformApi;
     /**
      * Switches the API client to the user context.
+     *
+     * @category Impersonalization
      */
     asUser: (userAccountId: string) => JiraPlatformApi;
 }
 /**
  * The Jira Cloud Software REST API Client.
+ *
+ * @category API Clients
  */
 export declare class JiraSoftwareApi extends BaseJiraSoftwareApiClient {
-    protected options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions;
-    constructor(options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions);
+    protected options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | ApiClientForgeBridgeJiraOptions | ApiClientAceOptions | ApiClientApOptions;
+    /**
+     * @category Constructor
+     */
+    constructor(options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | ApiClientForgeBridgeJiraOptions | ApiClientAceOptions | ApiClientApOptions);
     /**
      * Switches the API client to the app context.
+     *
+     * @category Impersonalization
      */
     asApp: () => JiraSoftwareApi;
     /**
      * Switches the API client to the user context.
+     *
+     * @category Impersonalization
      */
     asUser: (userAccountId: string) => JiraSoftwareApi;
 }
 /**
  * The Jira Cloud Service Management REST API Client.
+ *
+ * @category API Clients
  */
 export declare class JiraServiceManagementApi extends BaseJiraServiceManagementApiClient {
-    protected options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions;
-    constructor(options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions);
+    protected options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | ApiClientForgeBridgeJiraOptions | ApiClientAceOptions | ApiClientApOptions;
+    /**
+     * @category Constructor
+     */
+    constructor(options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | ApiClientForgeBridgeJiraOptions | ApiClientAceOptions | ApiClientApOptions);
     /**
      * Switches the API client to the app context.
+     *
+     * @category Impersonalization
      */
     asApp: () => JiraServiceManagementApi;
     /**
      * Switches the API client to the user context.
+     *
+     * @category Impersonalization
      */
     asUser: (userAccountId: string) => JiraServiceManagementApi;
 }

package/lib/index.js

@@ -31,17 +31,26 @@ validationSchemaStorage_2.validationSchemaStorage.setErrorClass(atlassian_api_co
 validationSchemaStorage_3.validationSchemaStorage.setErrorClass(atlassian_api_common_1.ApiError);
 /**
  * The Jira Cloud Platform REST API Client.
+ *
+ * @category API Clients
  */
 class JiraPlatformApi extends BaseJiraPlatformApiClient_1.BaseJiraPlatformApiClient {
+    /**
+     * @category Constructor
+     */
     constructor(options) {
         super((0, atlassian_api_common_1.getApiClientOptions)(options));
         this.options = options;
         /**
          * Switches the API client to the app context.
+         *
+         * @category Impersonalization
          */
         this.asApp = (0, atlassian_api_common_1.createAsAppMethod)();
         /**
          * Switches the API client to the user context.
+         *
+         * @category Impersonalization
          */
         this.asUser = (0, atlassian_api_common_1.createAsUserMethod)();
     }
@@ -49,17 +58,26 @@ class JiraPlatformApi extends BaseJiraPlatformApiClient_1.BaseJiraPlatformApiCli
 exports.JiraPlatformApi = JiraPlatformApi;
 /**
  * The Jira Cloud Software REST API Client.
+ *
+ * @category API Clients
  */
 class JiraSoftwareApi extends BaseJiraSoftwareApiClient_1.BaseJiraSoftwareApiClient {
+    /**
+     * @category Constructor
+     */
     constructor(options) {
         super((0, atlassian_api_common_1.getApiClientOptions)(options));
         this.options = options;
         /**
          * Switches the API client to the app context.
+         *
+         * @category Impersonalization
          */
         this.asApp = (0, atlassian_api_common_1.createAsAppMethod)();
         /**
          * Switches the API client to the user context.
+         *
+         * @category Impersonalization
          */
         this.asUser = (0, atlassian_api_common_1.createAsUserMethod)();
     }
@@ -67,17 +85,26 @@ class JiraSoftwareApi extends BaseJiraSoftwareApiClient_1.BaseJiraSoftwareApiCli
 exports.JiraSoftwareApi = JiraSoftwareApi;
 /**
  * The Jira Cloud Service Management REST API Client.
+ *
+ * @category API Clients
  */
 class JiraServiceManagementApi extends BaseJiraServiceManagementApiClient_1.BaseJiraServiceManagementApiClient {
+    /**
+     * @category Constructor
+     */
     constructor(options) {
         super((0, atlassian_api_common_1.getApiClientOptions)(options));
         this.options = options;
         /**
          * Switches the API client to the app context.
+         *
+         * @category Impersonalization
          */
         this.asApp = (0, atlassian_api_common_1.createAsAppMethod)();
         /**
          * Switches the API client to the user context.
+         *
+         * @category Impersonalization
          */
         this.asUser = (0, atlassian_api_common_1.createAsUserMethod)();
     }

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2EAU0C;AAUjC,yFAfP,+BAAQ,OAeO;AARjB,4FAAyF;AACzF,uHAAoH;AACpH,4FAAyF;AAEzF,+EAA6D;AAC7D,+EAA6D;AAC7D,iGAA+E;AAI/E,wFAAwH;AACxH,iGAA0I;AAC1I,wFAAwH;AAExH,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AACxD,iDAAwC,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AACjE,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AAExD;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAKxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IATtD,CAAC;CAUF;AApBD,0CAoBC;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;AAED;;GAEG;AACH,MAAa,wBAAyB,SAAQ,uEAAkC;IAC9E,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAIxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAAmC,CAAC;QAC7D;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAAmC,CAAC;IAR/D,CAAC;CASF;AAnBD,4DAmBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2EAU0C;AAUjC,yFAdP,+BAAQ,OAcO;AARjB,4FAAyF;AACzF,uHAAoH;AACpH,4FAAyF;AAEzF,+EAA6D;AAC7D,+EAA6D;AAC7D,iGAA+E;AAY/E,wFAAwH;AACxH,iGAA0I;AAC1I,wFAAwH;AAExH,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AACxD,iDAAwC,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AACjE,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AAExD;;;;GAIG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D;;OAEG;IACH,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAKxB;;;;WAIG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;;;WAIG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IAbtD,CAAC;CAcF;AA3BD,0CA2BC;AAED;;;;GAIG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D;;OAEG;IACH,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAIxB;;;;WAIG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;;;WAIG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IAZtD,CAAC;CAaF;AA1BD,0CA0BC;AAED;;;;GAIG;AACH,MAAa,wBAAyB,SAAQ,uEAAkC;IAC9E;;OAEG;IACH,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAIxB;;;;WAIG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAAmC,CAAC;QAC7D;;;;WAIG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAAmC,CAAC;IAZ/D,CAAC;CAaF;AA1BD,4DA0BC"}