@devopness/sdk-js 2.4.0 → 2.6.1

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

@@ -0,0 +1,41 @@
+/**
+ * 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 { PipelineStep } from '../../generated/models';
+import { PipelineStepCreate } from '../../generated/models';
+/**
+ * PipelinesStepsApiService - Auto-generated
+ */
+export declare class PipelinesStepsApiService extends ApiBaseService {
+    /**
+     *
+     * @summary Creates a step for a pipeline
+     * @param {number} pipelineId Unique ID of the pipeline to add the step to
+     * @param {PipelineStepCreate} pipelineStepCreate A JSON object containing pipeline script data
+     */
+    createPipelineStep(pipelineId: number, pipelineStepCreate: PipelineStepCreate): Promise<ApiResponse<PipelineStep>>;
+    /**
+     *
+     * @summary Link a step to a pipeline
+     * @param {number} pipelineId Unique ID of the pipeline
+     * @param {number} stepId Unique ID of the step to be linked
+     */
+    linkStepToPipeline(pipelineId: number, stepId: number): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Unlink a step from a pipeline
+     * @param {number} pipelineId Unique ID of the pipeline
+     * @param {number} stepId Unique ID of the step to be unlinked
+     */
+    unlinkStepFromPipeline(pipelineId: number, stepId: number): Promise<ApiResponse<void>>;
+}

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

@@ -0,0 +1,93 @@
+"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.PipelinesStepsApiService = void 0;
+const ApiBaseService_1 = require("../../../services/ApiBaseService");
+const ApiResponse_1 = require("../../../common/ApiResponse");
+const Exceptions_1 = require("../../../common/Exceptions");
+/**
+ * PipelinesStepsApiService - Auto-generated
+ */
+class PipelinesStepsApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary Creates a step for a pipeline
+     * @param {number} pipelineId Unique ID of the pipeline to add the step to
+     * @param {PipelineStepCreate} pipelineStepCreate A JSON object containing pipeline script data
+     */
+    createPipelineStep(pipelineId, pipelineStepCreate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (pipelineId === null || pipelineId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('pipelineId', 'createPipelineStep');
+            }
+            if (pipelineStepCreate === null || pipelineStepCreate === undefined) {
+                throw new Exceptions_1.ArgumentNullException('pipelineStepCreate', 'createPipelineStep');
+            }
+            let queryString = '';
+            const requestUrl = '/pipelines/{pipeline_id}/steps' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"pipeline_id"}}`, encodeURIComponent(String(pipelineId))), pipelineStepCreate);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary Link a step to a pipeline
+     * @param {number} pipelineId Unique ID of the pipeline
+     * @param {number} stepId Unique ID of the step to be linked
+     */
+    linkStepToPipeline(pipelineId, stepId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (pipelineId === null || pipelineId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('pipelineId', 'linkStepToPipeline');
+            }
+            if (stepId === null || stepId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('stepId', 'linkStepToPipeline');
+            }
+            let queryString = '';
+            const requestUrl = '/pipelines/{pipeline_id}/steps/{step_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"pipeline_id"}}`, encodeURIComponent(String(pipelineId))).replace(`{${"step_id"}}`, encodeURIComponent(String(stepId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary Unlink a step from a pipeline
+     * @param {number} pipelineId Unique ID of the pipeline
+     * @param {number} stepId Unique ID of the step to be unlinked
+     */
+    unlinkStepFromPipeline(pipelineId, stepId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (pipelineId === null || pipelineId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('pipelineId', 'unlinkStepFromPipeline');
+            }
+            if (stepId === null || stepId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('stepId', 'unlinkStepFromPipeline');
+            }
+            let queryString = '';
+            const requestUrl = '/pipelines/{pipeline_id}/steps/{step_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.delete(requestUrl.replace(`{${"pipeline_id"}}`, encodeURIComponent(String(pipelineId))).replace(`{${"step_id"}}`, encodeURIComponent(String(stepId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+}
+exports.PipelinesStepsApiService = PipelinesStepsApiService;

package/dist/api/generated/models/application-last-deployment.d.ts

@@ -0,0 +1,130 @@
+/**
+ * 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 { ActionData } from './action-data';
+import { ActionHookRequest } from './action-hook-request';
+import { ActionStatus } from './action-status';
+import { ActionSummary } from './action-summary';
+import { ActionTriggeredFrom } from './action-triggered-from';
+import { ActionType } from './action-type';
+import { EnvironmentRelation } from './environment-relation';
+import { ProjectRelation } from './project-relation';
+import { ServerAction } from './server-action';
+import { UserRelation } from './user-relation';
+/**
+ *
+ * @export
+ * @interface ApplicationLastDeployment
+ */
+export interface ApplicationLastDeployment {
+    /**
+     * The Id of the given action
+     * @type {number}
+     * @memberof ApplicationLastDeployment
+     */
+    id: number;
+    /**
+     *
+     * @type {ActionStatus}
+     * @memberof ApplicationLastDeployment
+     */
+    status: ActionStatus;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof ApplicationLastDeployment
+     */
+    type: ActionType;
+    /**
+     * Human readable version of the action type
+     * @type {string}
+     * @memberof ApplicationLastDeployment
+     */
+    type_human_readable: string;
+    /**
+     *
+     * @type {ActionSummary}
+     * @memberof ApplicationLastDeployment
+     */
+    summary?: ActionSummary;
+    /**
+     * The permalink URL to the action details on Devopness web app
+     * @type {string}
+     * @memberof ApplicationLastDeployment
+     */
+    url_web_permalink: string;
+    /**
+     *
+     * @type {ActionData}
+     * @memberof ApplicationLastDeployment
+     */
+    action_data: ActionData | null;
+    /**
+     * List of actions dispatched to servers
+     * @type {Array<ServerAction>}
+     * @memberof ApplicationLastDeployment
+     */
+    servers?: Array<ServerAction>;
+    /**
+     *
+     * @type {EnvironmentRelation}
+     * @memberof ApplicationLastDeployment
+     */
+    environment?: EnvironmentRelation;
+    /**
+     *
+     * @type {ActionTriggeredFrom}
+     * @memberof ApplicationLastDeployment
+     */
+    triggered_from: ActionTriggeredFrom;
+    /**
+     *
+     * @type {UserRelation}
+     * @memberof ApplicationLastDeployment
+     */
+    triggered_by_user?: UserRelation;
+    /**
+     *
+     * @type {ProjectRelation}
+     * @memberof ApplicationLastDeployment
+     */
+    project?: ProjectRelation;
+    /**
+     *
+     * @type {ActionHookRequest}
+     * @memberof ApplicationLastDeployment
+     */
+    hook_requests?: ActionHookRequest;
+    /**
+     * The date and time when the action started execution (i.e., left the `pending/queued` status)
+     * @type {string}
+     * @memberof ApplicationLastDeployment
+     */
+    started_at?: string | null;
+    /**
+     * The date and time when the action has finished execution
+     * @type {string}
+     * @memberof ApplicationLastDeployment
+     */
+    completed_at?: string | null;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof ApplicationLastDeployment
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof ApplicationLastDeployment
+     */
+    updated_at?: string;
+}

package/dist/api/generated/models/application-last-deployment.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/application-last-deployments.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { Action } from './action';
+import { ApplicationLastDeployment } from './application-last-deployment';
 /**
  * Latest deployment created to application and the more recent completed deployment
  * @export
@@ -18,14 +18,14 @@ import { Action } from './action';
 export interface ApplicationLastDeployments {
     /**
      *
-     * @type {Action}
+     * @type {ApplicationLastDeployment}
      * @memberof ApplicationLastDeployments
      */
-    latest?: Action | null;
+    latest?: ApplicationLastDeployment | null;
     /**
      *
-     * @type {Action}
+     * @type {ApplicationLastDeployment}
      * @memberof ApplicationLastDeployments
      */
-    live?: Action | null;
+    live?: ApplicationLastDeployment | null;
 }

package/dist/api/generated/models/application-options.d.ts

@@ -11,6 +11,7 @@
  */
 import { DeploymentDefaultStep } from './deployment-default-step';
 import { LanguageRuntime } from './language-runtime';
+import { ScriptRunner } from './script-runner';
 /**
  *
  * @export
@@ -29,4 +30,10 @@ export interface ApplicationOptions {
      * @memberof ApplicationOptions
      */
     language_runtimes: Array<LanguageRuntime>;
+    /**
+     *
+     * @type {Array<ScriptRunner>}
+     * @memberof ApplicationOptions
+     */
+    script_runners: Array<ScriptRunner>;
 }

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

@@ -22,6 +22,7 @@ export * from './api-error-errors-field-name';
 export * from './application';
 export * from './application-create';
 export * from './application-deployment';
+export * from './application-last-deployment';
 export * from './application-last-deployments';
 export * from './application-options';
 export * from './application-pipeline';
@@ -117,6 +118,9 @@ export * from './operating-system';
 export * from './operating-system-supported-versions';
 export * from './pipeline';
 export * from './pipeline-create';
+export * from './pipeline-step';
+export * from './pipeline-step-create';
+export * from './pipeline-step-runner-name';
 export * from './project';
 export * from './project-create';
 export * from './project-relation';
@@ -128,6 +132,7 @@ export * from './resource-event';
 export * from './resource-type';
 export * from './script';
 export * from './script-create';
+export * from './script-runner';
 export * from './script-update';
 export * from './server';
 export * from './server-action';

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

@@ -38,6 +38,7 @@ __exportStar(require("./api-error-errors-field-name"), exports);
 __exportStar(require("./application"), exports);
 __exportStar(require("./application-create"), exports);
 __exportStar(require("./application-deployment"), exports);
+__exportStar(require("./application-last-deployment"), exports);
 __exportStar(require("./application-last-deployments"), exports);
 __exportStar(require("./application-options"), exports);
 __exportStar(require("./application-pipeline"), exports);
@@ -133,6 +134,9 @@ __exportStar(require("./operating-system"), exports);
 __exportStar(require("./operating-system-supported-versions"), exports);
 __exportStar(require("./pipeline"), exports);
 __exportStar(require("./pipeline-create"), exports);
+__exportStar(require("./pipeline-step"), exports);
+__exportStar(require("./pipeline-step-create"), exports);
+__exportStar(require("./pipeline-step-runner-name"), exports);
 __exportStar(require("./project"), exports);
 __exportStar(require("./project-create"), exports);
 __exportStar(require("./project-relation"), exports);
@@ -144,6 +148,7 @@ __exportStar(require("./resource-event"), exports);
 __exportStar(require("./resource-type"), exports);
 __exportStar(require("./script"), exports);
 __exportStar(require("./script-create"), exports);
+__exportStar(require("./script-runner"), exports);
 __exportStar(require("./script-update"), exports);
 __exportStar(require("./server"), exports);
 __exportStar(require("./server-action"), exports);

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

@@ -0,0 +1,43 @@
+/**
+ * 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 { PipelineStepRunnerName } from './pipeline-step-runner-name';
+/**
+ *
+ * @export
+ * @interface PipelineStepCreate
+ */
+export interface PipelineStepCreate {
+    /**
+     * Name/short description of the script
+     * @type {string}
+     * @memberof PipelineStepCreate
+     */
+    name: string;
+    /**
+     * A command line or multiline bash script
+     * @type {string}
+     * @memberof PipelineStepCreate
+     */
+    command: string;
+    /**
+     *
+     * @type {PipelineStepRunnerName}
+     * @memberof PipelineStepCreate
+     */
+    runner: PipelineStepRunnerName;
+    /**
+     * The name of the Unix user on behalf of which the script will be executed
+     * @type {string}
+     * @memberof PipelineStepCreate
+     */
+    run_as_user?: string;
+}

package/dist/api/generated/models/pipeline-step-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/pipeline-step-runner-name.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+/**
+ * Name of the script runner that will run the script
+ * @export
+ * @enum {string}
+ */
+export declare enum PipelineStepRunnerName {
+    Composer = "composer",
+    Custom = "custom",
+    Npm = "npm",
+    Pip = "pip",
+    Yarn = "yarn"
+}

package/dist/api/generated/models/pipeline-step-runner-name.js

@@ -0,0 +1,28 @@
+"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 });
+exports.PipelineStepRunnerName = void 0;
+/**
+ * Name of the script runner that will run the script
+ * @export
+ * @enum {string}
+ */
+var PipelineStepRunnerName;
+(function (PipelineStepRunnerName) {
+    PipelineStepRunnerName["Composer"] = "composer";
+    PipelineStepRunnerName["Custom"] = "custom";
+    PipelineStepRunnerName["Npm"] = "npm";
+    PipelineStepRunnerName["Pip"] = "pip";
+    PipelineStepRunnerName["Yarn"] = "yarn";
+})(PipelineStepRunnerName = exports.PipelineStepRunnerName || (exports.PipelineStepRunnerName = {}));

package/dist/api/generated/models/pipeline-step.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 { PipelineStepRunnerName } from './pipeline-step-runner-name';
+/**
+ *
+ * @export
+ * @interface PipelineStep
+ */
+export interface PipelineStep {
+    /**
+     * The Id of the given script
+     * @type {number}
+     * @memberof PipelineStep
+     */
+    id: number;
+    /**
+     * The id of the user that own the script
+     * @type {number}
+     * @memberof PipelineStep
+     */
+    created_by: number;
+    /**
+     * Name/short description of the script
+     * @type {string}
+     * @memberof PipelineStep
+     */
+    name: string;
+    /**
+     * A command line or multiline bash script
+     * @type {string}
+     * @memberof PipelineStep
+     */
+    command: string;
+    /**
+     *
+     * @type {PipelineStepRunnerName}
+     * @memberof PipelineStep
+     */
+    runner: PipelineStepRunnerName;
+    /**
+     * The name of the Unix user on behalf of which the script will be executed
+     * @type {string}
+     * @memberof PipelineStep
+     */
+    run_as_user: string;
+    /**
+     * The relative order of the script execution in case the event has multiple scripts attached
+     * @type {number}
+     * @memberof PipelineStep
+     */
+    trigger_order: number;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof PipelineStep
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof PipelineStep
+     */
+    updated_at?: string;
+}

package/dist/api/generated/models/pipeline-step.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/script-runner.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 ScriptRunner
+ */
+export interface ScriptRunner {
+    /**
+     * How to call the runner in CLI
+     * @type {string}
+     * @memberof ScriptRunner
+     */
+    value: string;
+    /**
+     * The formatted name of the runner
+     * @type {string}
+     * @memberof ScriptRunner
+     */
+    human_readable: string;
+    /**
+     * A brief description about the runner
+     * @type {string}
+     * @memberof ScriptRunner
+     */
+    hint: string;
+}

package/dist/api/generated/models/script-runner.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/services/PipelineService.d.ts

@@ -1,5 +1,7 @@
 import { PipelinesApiService } from "../api/generated/apis/pipelines-api";
 import { PipelinesResourcesApiService } from "../api/generated/apis/pipelines-resources-api";
+import { PipelinesStepsApiService } from "../api/generated/apis/pipelines-steps-api";
 export declare class PipelineService extends PipelinesApiService {
     resources: PipelinesResourcesApiService;
+    steps: PipelinesStepsApiService;
 }

package/dist/services/PipelineService.js

@@ -3,10 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PipelineService = void 0;
 const pipelines_api_1 = require("../api/generated/apis/pipelines-api");
 const pipelines_resources_api_1 = require("../api/generated/apis/pipelines-resources-api");
+const pipelines_steps_api_1 = require("../api/generated/apis/pipelines-steps-api");
 class PipelineService extends pipelines_api_1.PipelinesApiService {
     constructor() {
         super(...arguments);
         this.resources = new pipelines_resources_api_1.PipelinesResourcesApiService();
+        this.steps = new pipelines_steps_api_1.PipelinesStepsApiService();
     }
 }
 exports.PipelineService = PipelineService;

package/package.json

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