@devopness/sdk-js 2.75.0 → 2.76.0

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

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+import { ApiBaseService } from "../../../services/ApiBaseService";
+import { ApiResponse } from "../../../common/ApiResponse";
+import { Hook } from '../../generated/models';
+import { HookPipelineCreate } from '../../generated/models';
+import { HookRelation } from '../../generated/models';
+/**
+ * PipelinesHooksApiService - Auto-generated
+ */
+export declare class PipelinesHooksApiService extends ApiBaseService {
+    /**
+     *
+     * @summary Create a hook to a specific pipeline
+     * @param {string} hookType The hook type.
+     * @param {number} pipelineId The ID of the pipeline that will be executed by the created action
+     * @param {HookPipelineCreate} hookPipelineCreate A JSON object containing the resource data
+     */
+    addPipelineHook(hookType: string, pipelineId: number, hookPipelineCreate: HookPipelineCreate): Promise<ApiResponse<Hook>>;
+    /**
+     *
+     * @summary List all hooks in an pipeline
+     * @param {number} pipelineId The ID of the pipeline.
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listPipelineHooks(pipelineId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<HookRelation>>>;
+}

package/dist/api/generated/apis/pipelines-hooks-api.js

@@ -0,0 +1,82 @@
+"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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PipelinesHooksApiService = void 0;
+const ApiBaseService_1 = require("../../../services/ApiBaseService");
+const ApiResponse_1 = require("../../../common/ApiResponse");
+const Exceptions_1 = require("../../../common/Exceptions");
+/**
+ * PipelinesHooksApiService - Auto-generated
+ */
+class PipelinesHooksApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary Create a hook to a specific pipeline
+     * @param {string} hookType The hook type.
+     * @param {number} pipelineId The ID of the pipeline that will be executed by the created action
+     * @param {HookPipelineCreate} hookPipelineCreate A JSON object containing the resource data
+     */
+    addPipelineHook(hookType, pipelineId, hookPipelineCreate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (hookType === null || hookType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('hookType', 'addPipelineHook');
+            }
+            if (pipelineId === null || pipelineId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('pipelineId', 'addPipelineHook');
+            }
+            if (hookPipelineCreate === null || hookPipelineCreate === undefined) {
+                throw new Exceptions_1.ArgumentNullException('hookPipelineCreate', 'addPipelineHook');
+            }
+            let queryString = '';
+            const requestUrl = '/pipelines/{pipeline_id}/hooks/{hook_type}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"hook_type"}}`, encodeURIComponent(String(hookType))).replace(`{${"pipeline_id"}}`, encodeURIComponent(String(pipelineId))), hookPipelineCreate);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary List all hooks in an pipeline
+     * @param {number} pipelineId The ID of the pipeline.
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listPipelineHooks(pipelineId, page, perPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (pipelineId === null || pipelineId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('pipelineId', 'listPipelineHooks');
+            }
+            let queryString = '';
+            const queryParams = { page: page, per_page: perPage, };
+            for (const key in queryParams) {
+                if (queryParams[key] === undefined || queryParams[key] === null) {
+                    continue;
+                }
+                queryString += (queryString ? '&' : '') + `${key}=${encodeURI(queryParams[key])}`;
+            }
+            const requestUrl = '/pipelines/{pipeline_id}/hooks' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"pipeline_id"}}`, encodeURIComponent(String(pipelineId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+}
+exports.PipelinesHooksApiService = PipelinesHooksApiService;

package/dist/api/generated/models/hook-pipeline-create.d.ts

@@ -0,0 +1,83 @@
+/**
+ * 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.
+ */
+import { ActionType } from './action-type';
+import { HookIncomingSettings } from './hook-incoming-settings';
+import { HookOutgoingSettings } from './hook-outgoing-settings';
+import { HookTriggerWhen } from './hook-trigger-when';
+import { ResourceType } from './resource-type';
+/**
+ *
+ * @export
+ * @interface HookPipelineCreate
+ */
+export interface HookPipelineCreate {
+    /**
+     * The name of the outgoing hook. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof HookPipelineCreate
+     */
+    name: string;
+    /**
+     *
+     * @type {ResourceType}
+     * @memberof HookPipelineCreate
+     */
+    resource_type: ResourceType;
+    /**
+     * The hooks\' resource ID.
+     * @type {number}
+     * @memberof HookPipelineCreate
+     */
+    resource_id: number;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof HookPipelineCreate
+     */
+    action_type: ActionType;
+    /**
+     * Determines if the hook is currently active.
+     * @type {boolean}
+     * @memberof HookPipelineCreate
+     */
+    active?: boolean;
+    /**
+     * Tells if requests to this hook must only be accepted when a HTTP header is sent with a message authentication code ([HMAC](https://en.wikipedia.org/wiki/HMAC)) generated based on the secret provided by Devopness and shared by user with external sources. This field is required when <code>type</code> is <code>in</code>.
+     * @type {boolean}
+     * @memberof HookPipelineCreate
+     */
+    requires_secret?: boolean;
+    /**
+     * The cryptographic hash function to be used by Devopness when validating digitally signed incoming requests for hooks that require secret validation. This field is required when <code>requires_secret</code> is <code>true</code>.  Must be one of <code>sha256</code> Must not be greater than 20 characters.
+     * @type {string}
+     * @memberof HookPipelineCreate
+     */
+    secret_algorithm?: string;
+    /**
+     * The name of the HTTP request header from which the request digital signature should be extracted. This field is required when <code>requires_secret</code> is <code>true</code>. Must not be greater than 64 characters.
+     * @type {string}
+     * @memberof HookPipelineCreate
+     */
+    secret_header_name?: string;
+    /**
+     *
+     * @type {HookTriggerWhen}
+     * @memberof HookPipelineCreate
+     */
+    trigger_when?: HookTriggerWhen;
+    /**
+     *
+     * @type {HookIncomingSettings | HookOutgoingSettings}
+     * @memberof HookPipelineCreate
+     */
+    settings?: HookIncomingSettings | HookOutgoingSettings;
+}

package/dist/api/generated/models/hook-pipeline-create.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/hook-relation.d.ts

@@ -93,6 +93,12 @@ export interface HookRelation {
      * @memberof HookRelation
      */
     environment_id: number;
+    /**
+     * The ID of the pipeline executed by this hook
+     * @type {number}
+     * @memberof HookRelation
+     */
+    pipeline_id: number | null;
     /**
      *
      * @type {ResourceType}

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

@@ -94,6 +94,12 @@ export interface Hook {
      * @memberof Hook
      */
     environment_id: number;
+    /**
+     * The ID of the pipeline executed by this hook
+     * @type {number}
+     * @memberof Hook
+     */
+    pipeline_id: number | null;
     /**
      *
      * @type {ResourceType}

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

@@ -80,6 +80,7 @@ export * from './hook-incoming-settings';
 export * from './hook-outgoing-request-header';
 export * from './hook-outgoing-settings';
 export * from './hook-outgoing-trigger-when-condition';
+export * from './hook-pipeline-create';
 export * from './hook-relation';
 export * from './hook-request';
 export * from './hook-request-relation';

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

@@ -96,6 +96,7 @@ __exportStar(require("./hook-incoming-settings"), exports);
 __exportStar(require("./hook-outgoing-request-header"), exports);
 __exportStar(require("./hook-outgoing-settings"), exports);
 __exportStar(require("./hook-outgoing-trigger-when-condition"), exports);
+__exportStar(require("./hook-pipeline-create"), exports);
 __exportStar(require("./hook-relation"), exports);
 __exportStar(require("./hook-request"), exports);
 __exportStar(require("./hook-request-relation"), exports);

package/package.json

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