@devopness/sdk-js 2.43.1 → 2.44.1

package/README.md

@@ -49,7 +49,7 @@ async function authenticate(email, pass) {
 authenticate('user@email.com', 'secret-password');
 ```
 
-In the example above, `userTokens` is an instance of `ApiResponse` and the `data` property has the data requested from the API. See [ApiResponse.ts](https://github.com/devopness/devopness/blob/master/src/common/ApiResponse.ts) for reference.
+In the example above, `userTokens` is an instance of `ApiResponse` and the `data` property has the data requested from the API. See [ApiResponse.ts](https://github.com/devopness/devopness/blob/main/packages/sdks/javascript/src/common/ApiResponse.ts) for reference.
 
 ### Invoking authentication protected endpoints
 Once an authentication token is set, any protected endpoint can be invoked.
@@ -106,19 +106,26 @@ make test
 ```
 
 ### Without Docker
+Installing on ``Linux`` or ``macOS`` systems.
 
-#### 1. Install missing dependencies
-This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions for your operating system.
+#### 1. Navigate to the project directory!
+```shell
+cd packages/sdks/javascript/
+```
+
+#### 2. Install missing dependencies
+This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions 
+for your operating system.
 ```
 npm install
 ```
 
-#### 2. Build SDK
+#### 3. Build SDK
 ```
 npm run build
 ```
 
-#### 3. Run tests
+#### 4. Run tests
 ```
 npm run test
 ```

package/dist/api/generated/apis/hooks-api.d.ts

@@ -13,6 +13,7 @@ import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { Hook } from '../../generated/models';
 import { HookCreate } from '../../generated/models';
+import { HookTriggerResponse } from '../../generated/models';
 import { HookUpdate } from '../../generated/models';
 /**
  * HooksApiService - Auto-generated
@@ -44,7 +45,7 @@ export declare class HooksApiService extends ApiBaseService {
      * @summary Trigger an incoming hook associated action
      * @param {string} hookId The ID of the hook.
      */
-    triggerHook(hookId: string): Promise<ApiResponse<void>>;
+    triggerHook(hookId: string): Promise<ApiResponse<HookTriggerResponse>>;
     /**
      *
      * @summary Update an existing hook

package/dist/api/generated/models/hook-trigger-response.d.ts

@@ -0,0 +1,30 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface HookTriggerResponse
+ */
+export interface HookTriggerResponse {
+    /**
+     * Message containing information about the hook being triggered
+     * @type {string}
+     * @memberof HookTriggerResponse
+     */
+    message: string;
+    /**
+     * Optional error object containing details of the server error
+     * @type {object}
+     * @memberof HookTriggerResponse
+     */
+    errors: object | null;
+}

package/dist/api/generated/models/hook-trigger-response.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/index.d.ts

@@ -81,6 +81,7 @@ export * from './hook-outgoing-trigger-when-condition-type';
 export * from './hook-relation';
 export * from './hook-request';
 export * from './hook-request-relation';
+export * from './hook-trigger-response';
 export * from './hook-type';
 export * from './hook-update';
 export * from './hook-variable';

package/dist/api/generated/models/index.js

@@ -97,6 +97,7 @@ __exportStar(require("./hook-outgoing-trigger-when-condition-type"), exports);
 __exportStar(require("./hook-relation"), exports);
 __exportStar(require("./hook-request"), exports);
 __exportStar(require("./hook-request-relation"), exports);
+__exportStar(require("./hook-trigger-response"), exports);
 __exportStar(require("./hook-type"), exports);
 __exportStar(require("./hook-update"), exports);
 __exportStar(require("./hook-variable"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devopness/sdk-js",
-  "version": "2.43.1",
+  "version": "2.44.1",
   "publishConfig": {
     "access": "public"
   },