@devopness/sdk-js 2.0.1 → 2.3.0

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { Variable } from '../../generated/models';
+import { VariableUpdate } from '../../generated/models';
+/**
+ * VariablesApiService - Auto-generated
+ */
+export declare class VariablesApiService extends ApiBaseService {
+    /**
+     *
+     * @summary Delete a variable by ID
+     * @param {number} variableId The id of the variable
+     */
+    deleteVariable(variableId: number): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Get a variable by ID
+     * @param {number} variableId The unique id of the variable
+     */
+    getVariable(variableId: number): Promise<ApiResponse<Variable>>;
+    /**
+     *
+     * @summary Update an existing variable
+     * @param {number} variableId The unique id of the variable to be updated
+     * @param {VariableUpdate} variableUpdate A JSON object containing variable data
+     */
+    updateVariable(variableId: number, variableUpdate: VariableUpdate): Promise<ApiResponse<void>>;
+}

package/dist/api/generated/apis/variables-api.js

@@ -0,0 +1,85 @@
+"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.VariablesApiService = void 0;
+const ApiBaseService_1 = require("../../../services/ApiBaseService");
+const ApiResponse_1 = require("../../../common/ApiResponse");
+const Exceptions_1 = require("../../../common/Exceptions");
+/**
+ * VariablesApiService - Auto-generated
+ */
+class VariablesApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary Delete a variable by ID
+     * @param {number} variableId The id of the variable
+     */
+    deleteVariable(variableId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (variableId === null || variableId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('variableId', 'deleteVariable');
+            }
+            let queryString = '';
+            const requestUrl = '/variables/{variable_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.delete(requestUrl.replace(`{${"variable_id"}}`, encodeURIComponent(String(variableId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary Get a variable by ID
+     * @param {number} variableId The unique id of the variable
+     */
+    getVariable(variableId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (variableId === null || variableId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('variableId', 'getVariable');
+            }
+            let queryString = '';
+            const requestUrl = '/variables/{variable_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"variable_id"}}`, encodeURIComponent(String(variableId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary Update an existing variable
+     * @param {number} variableId The unique id of the variable to be updated
+     * @param {VariableUpdate} variableUpdate A JSON object containing variable data
+     */
+    updateVariable(variableId, variableUpdate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (variableId === null || variableId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('variableId', 'updateVariable');
+            }
+            if (variableUpdate === null || variableUpdate === undefined) {
+                throw new Exceptions_1.ArgumentNullException('variableUpdate', 'updateVariable');
+            }
+            let queryString = '';
+            const requestUrl = '/variables/{variable_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.put(requestUrl.replace(`{${"variable_id"}}`, encodeURIComponent(String(variableId))), variableUpdate);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+}
+exports.VariablesApiService = VariablesApiService;

package/dist/api/generated/models/{extra-body-params.d.ts → accepted-response-message.d.ts}

@@ -12,13 +12,13 @@
 /**
  *
  * @export
- * @interface ExtraBodyParams
+ * @interface AcceptedResponseMessage
  */
-export interface ExtraBodyParams {
+export interface AcceptedResponseMessage {
     /**
-     * Optional free form list of additional parameters to forward to API operation
+     * Message with information about the response
      * @type {string}
-     * @memberof ExtraBodyParams
+     * @memberof AcceptedResponseMessage
      */
-    params?: string;
+    message: string;
 }

package/dist/api/generated/models/action-data.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { ActionDeploymentData } from './action-deployment-data';
+/**
+ * @type ActionData
+ * Data related to action resource.
+ * @export
+ */
+export declare type ActionData = ActionDeploymentData;

package/dist/api/generated/models/action-deployment-commit.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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.
+ */
+/**
+ * Informations about the commit used on this deployment
+ * @export
+ * @interface ActionDeploymentCommit
+ */
+export interface ActionDeploymentCommit {
+    /**
+     * The ID of the source provider
+     * @type {number}
+     * @memberof ActionDeploymentCommit
+     */
+    source_provider_id: number;
+    /**
+     * The source provider\'s name
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    provider: string;
+    /**
+     * The repository of the deployed application
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    repository: string;
+    /**
+     * The branch used on deployment
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    branch: string;
+    /**
+     * The commit hash used on deployment
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    hash: string;
+    /**
+     * The commit message
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    message: string;
+    /**
+     * The author of the commit
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    author_name: string;
+    /**
+     * The commit author\'s email
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    author_email: string;
+    /**
+     * The date and time when the commit was created
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    committed_at: string;
+    /**
+     * The commit URL on the source provider
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    url: string;
+    /**
+     * The URL to clone the repository on the specific commit
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    clone_url: string;
+    /**
+     * The URL to download the commit source code
+     * @type {string}
+     * @memberof ActionDeploymentCommit
+     */
+    download_url: string;
+}

package/dist/api/generated/models/action-deployment-content.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { DeploymentType } from './deployment-type';
+/**
+ *
+ * @export
+ * @interface ActionDeploymentContent
+ */
+export interface ActionDeploymentContent {
+    /**
+     * The ID of the source provider
+     * @type {number}
+     * @memberof ActionDeploymentContent
+     */
+    provider_id: number;
+    /**
+     * The source provider\'s name
+     * @type {string}
+     * @memberof ActionDeploymentContent
+     */
+    provider_name: string;
+    /**
+     *
+     * @type {DeploymentType}
+     * @memberof ActionDeploymentContent
+     */
+    type: DeploymentType;
+    /**
+     * The repository of the deployed application
+     * @type {string}
+     * @memberof ActionDeploymentContent
+     */
+    repository: string;
+    /**
+     * The branch used on deployment
+     * @type {string}
+     * @memberof ActionDeploymentContent
+     */
+    branch: string;
+    /**
+     * The commit hash defined to be used on deployment
+     * @type {string}
+     * @memberof ActionDeploymentContent
+     */
+    hash: string | null;
+}

package/dist/api/generated/models/action-deployment-data.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { ActionDeploymentCommit } from './action-deployment-commit';
+import { ActionDeploymentContent } from './action-deployment-content';
+/**
+ *
+ * @export
+ * @interface ActionDeploymentData
+ */
+export interface ActionDeploymentData {
+    /**
+     * The name generated to release created by this deployment
+     * @type {string}
+     * @memberof ActionDeploymentData
+     */
+    release_name: string;
+    /**
+     *
+     * @type {ActionDeploymentCommit}
+     * @memberof ActionDeploymentData
+     */
+    commit: ActionDeploymentCommit;
+    /**
+     *
+     * @type {ActionDeploymentContent}
+     * @memberof ActionDeploymentData
+     */
+    deployment: ActionDeploymentContent;
+}

package/dist/api/generated/models/action-hook-request.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { HookRequestRelation } from './hook-request-relation';
+/**
+ * The incoming and outgoing hook request linked to this action
+ * @export
+ * @interface ActionHookRequest
+ */
+export interface ActionHookRequest {
+    /**
+     *
+     * @type {HookRequestRelation}
+     * @memberof ActionHookRequest
+     */
+    incoming?: HookRequestRelation | null;
+    /**
+     *
+     * @type {HookRequestRelation}
+     * @memberof ActionHookRequest
+     */
+    outgoing?: HookRequestRelation | null;
+}

package/dist/api/generated/models/action-hook-request.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/action-list-item-params.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ServerAction } from './server-action';
+/**
+ *
+ * @export
+ * @interface ActionListItemParams
+ */
+export interface ActionListItemParams {
+    /**
+     * List of actions dispatched to servers
+     * @type {Array<ServerAction>}
+     * @memberof ActionListItemParams
+     */
+    servers?: Array<ServerAction>;
+}

package/dist/api/generated/models/action-list-item-params.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/action-list-item.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { ActionListItemParams } from './action-list-item-params';
+import { ActionRelation } from './action-relation';
+/**
+ * @type ActionListItem
+ * @export
+ */
+export declare type ActionListItem = ActionListItemParams & ActionRelation;

package/dist/api/generated/models/action-list-item.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/action-relation.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 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 { ActionStatus } from './action-status';
+import { ActionSummary } from './action-summary';
+import { ActionType } from './action-type';
+import { Resource } from './resource';
+/**
+ *
+ * @export
+ * @interface ActionRelation
+ */
+export interface ActionRelation {
+    /**
+     * The Id of the given action
+     * @type {number}
+     * @memberof ActionRelation
+     */
+    id: number;
+    /**
+     *
+     * @type {ActionStatus}
+     * @memberof ActionRelation
+     */
+    status: ActionStatus;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof ActionRelation
+     */
+    type: ActionType;
+    /**
+     * Human readable version of the action type
+     * @type {string}
+     * @memberof ActionRelation
+     */
+    type_human_readable: string;
+    /**
+     *
+     * @type {Resource}
+     * @memberof ActionRelation
+     */
+    resource: Resource;
+    /**
+     *
+     * @type {ActionSummary}
+     * @memberof ActionRelation
+     */
+    summary?: ActionSummary;
+    /**
+     * The date and time when the action started execution (i.e., left the `pending/queued` status)
+     * @type {string}
+     * @memberof ActionRelation
+     */
+    started_at?: string | null;
+    /**
+     * The date and time when the action has finished execution
+     * @type {string}
+     * @memberof ActionRelation
+     */
+    completed_at?: string | null;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof ActionRelation
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof ActionRelation
+     */
+    updated_at?: string;
+}

package/dist/api/generated/models/action-relation.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/action-status.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+/**
+ * Current item status
+ * @export
+ * @enum {string}
+ */
+export declare enum ActionStatus {
+    Pending = "pending",
+    InProgress = "in-progress",
+    Completed = "completed",
+    Failed = "failed"
+}

package/dist/api/generated/models/{deployment-create.js → action-status.js}

@@ -12,14 +12,16 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeploymentCreateTypeEnum = void 0;
+exports.ActionStatus = void 0;
 /**
-    * @export
-    * @enum {string}
-    */
-var DeploymentCreateTypeEnum;
-(function (DeploymentCreateTypeEnum) {
-    DeploymentCreateTypeEnum["Deploy"] = "deploy";
-    DeploymentCreateTypeEnum["Redeploy"] = "redeploy";
-    DeploymentCreateTypeEnum["Rollback"] = "rollback";
-})(DeploymentCreateTypeEnum = exports.DeploymentCreateTypeEnum || (exports.DeploymentCreateTypeEnum = {}));
+ * Current item status
+ * @export
+ * @enum {string}
+ */
+var ActionStatus;
+(function (ActionStatus) {
+    ActionStatus["Pending"] = "pending";
+    ActionStatus["InProgress"] = "in-progress";
+    ActionStatus["Completed"] = "completed";
+    ActionStatus["Failed"] = "failed";
+})(ActionStatus = exports.ActionStatus || (exports.ActionStatus = {}));

package/dist/api/generated/models/action-step-log.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { ServerActionLogStep } from './server-action-log-step';
+import { ServerRelation } from './server-relation';
+/**
+ *
+ * @export
+ * @interface ActionStepLog
+ */
+export interface ActionStepLog {
+    /**
+     * The date and time when the requested log record was last updated
+     * @type {string}
+     * @memberof ActionStepLog
+     */
+    updated_at: string | null;
+    /**
+     *
+     * @type {ServerRelation}
+     * @memberof ActionStepLog
+     */
+    server?: ServerRelation;
+    /**
+     *
+     * @type {ServerActionLogStep}
+     * @memberof ActionStepLog
+     */
+    step?: ServerActionLogStep | null;
+}