@devopness/sdk-js 2.109.0 → 2.110.0

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

@@ -12,11 +12,21 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { Variable } from '../../generated/models';
+import { VariableCreate } from '../../generated/models';
+import { VariableRelation } from '../../generated/models';
 import { VariableUpdate } from '../../generated/models';
 /**
  * VariablesApiService - Auto-generated
  */
 export declare class VariablesApiService extends ApiBaseService {
+    /**
+     *
+     * @summary Create a new variable linked to a resource
+     * @param {number} resourceId The resource ID.
+     * @param {string} resourceType The resource type to get variables from.
+     * @param {VariableCreate} variableCreate A JSON object containing the resource data
+     */
+    addVariable(resourceId: number, resourceType: string, variableCreate: VariableCreate): Promise<ApiResponse<Variable>>;
     /**
      *
      * @summary Delete a variable by ID
@@ -29,6 +39,15 @@ export declare class VariablesApiService extends ApiBaseService {
      * @param {number} variableId The ID of the variable.
      */
     getVariable(variableId: number): Promise<ApiResponse<Variable>>;
+    /**
+     *
+     * @summary Return a list of variables belonging to a resource
+     * @param {number} resourceId The resource ID.
+     * @param {string} resourceType The resource type to get variables from.
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listVariablesByResourceType(resourceId: number, resourceType: string, page?: number, perPage?: number): Promise<ApiResponse<Array<VariableRelation>>>;
     /**
      *
      * @summary Update an existing variable

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

@@ -29,6 +29,30 @@ const Exceptions_1 = require("../../../common/Exceptions");
  * VariablesApiService - Auto-generated
  */
 class VariablesApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary Create a new variable linked to a resource
+     * @param {number} resourceId The resource ID.
+     * @param {string} resourceType The resource type to get variables from.
+     * @param {VariableCreate} variableCreate A JSON object containing the resource data
+     */
+    addVariable(resourceId, resourceType, variableCreate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (resourceId === null || resourceId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceId', 'addVariable');
+            }
+            if (resourceType === null || resourceType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceType', 'addVariable');
+            }
+            if (variableCreate === null || variableCreate === undefined) {
+                throw new Exceptions_1.ArgumentNullException('variableCreate', 'addVariable');
+            }
+            let queryString = '';
+            const requestUrl = '/variables/{resource_type}/{resource_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"resource_id"}}`, encodeURIComponent(String(resourceId))).replace(`{${"resource_type"}}`, encodeURIComponent(String(resourceType))), variableCreate);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Delete a variable by ID
@@ -61,6 +85,35 @@ class VariablesApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Return a list of variables belonging to a resource
+     * @param {number} resourceId The resource ID.
+     * @param {string} resourceType The resource type to get variables from.
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listVariablesByResourceType(resourceId, resourceType, page, perPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (resourceId === null || resourceId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceId', 'listVariablesByResourceType');
+            }
+            if (resourceType === null || resourceType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceType', 'listVariablesByResourceType');
+            }
+            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 = '/variables/{resource_type}/{resource_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"resource_id"}}`, encodeURIComponent(String(resourceId))).replace(`{${"resource_type"}}`, encodeURIComponent(String(resourceType))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Update an existing variable

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

@@ -267,6 +267,7 @@ export * from './user-url';
 export * from './user-verify';
 export * from './variable';
 export * from './variable-application-create';
+export * from './variable-create';
 export * from './variable-relation';
 export * from './variable-service-create';
 export * from './variable-target';

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

@@ -283,6 +283,7 @@ __exportStar(require("./user-url"), exports);
 __exportStar(require("./user-verify"), exports);
 __exportStar(require("./variable"), exports);
 __exportStar(require("./variable-application-create"), exports);
+__exportStar(require("./variable-create"), exports);
 __exportStar(require("./variable-relation"), exports);
 __exportStar(require("./variable-service-create"), exports);
 __exportStar(require("./variable-target"), exports);

package/dist/api/generated/models/variable-create.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 { VariableTarget } from './variable-target';
+import { VariableType } from './variable-type';
+/**
+ *
+ * @export
+ * @interface VariableCreate
+ */
+export interface VariableCreate {
+    /**
+     * The unique key used to identify the variable on the target. Must not be greater than 100 characters.
+     * @type {string}
+     * @memberof VariableCreate
+     */
+    key: string;
+    /**
+     * The value to be assigned to this variable when deployed to its target.                 When variable is of type `file`, this is the file content. Must not be greater than 21504 characters.
+     * @type {string}
+     * @memberof VariableCreate
+     */
+    value: string;
+    /**
+     * A text describing the variable, provided by the end user.
+     * @type {string}
+     * @memberof VariableCreate
+     */
+    description?: string;
+    /**
+     *
+     * @type {VariableTarget}
+     * @memberof VariableCreate
+     */
+    target: VariableTarget;
+    /**
+     *
+     * @type {VariableType}
+     * @memberof VariableCreate
+     */
+    type: VariableType;
+    /**
+     * Indicates if the variable value should be visible or not in the deployment logs.
+     * @type {boolean}
+     * @memberof VariableCreate
+     */
+    hidden: boolean;
+}

package/dist/api/generated/models/variable-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/variable-target.d.ts

@@ -28,5 +28,6 @@ export declare enum VariableTarget {
     PhpFpmPhpIni = "php-fpm_php-ini",
     PhpFpmPoolDWwwConf = "php-fpm_pool-d-www-conf",
     RedisConf = "redis-conf",
-    SupervisordConf = "supervisord-conf"
+    SupervisordConf = "supervisord-conf",
+    SysctlConf = "sysctl-conf"
 }

package/dist/api/generated/models/variable-target.js

@@ -34,4 +34,5 @@ var VariableTarget;
     VariableTarget["PhpFpmPoolDWwwConf"] = "php-fpm_pool-d-www-conf";
     VariableTarget["RedisConf"] = "redis-conf";
     VariableTarget["SupervisordConf"] = "supervisord-conf";
+    VariableTarget["SysctlConf"] = "sysctl-conf";
 })(VariableTarget = exports.VariableTarget || (exports.VariableTarget = {}));

package/dist/api/generated/models/variable-targets.d.ts

@@ -52,5 +52,6 @@ export declare enum VariableTargetsNameEnum {
     PhpFpmPhpIni = "php-fpm_php-ini",
     PhpFpmPoolDWwwConf = "php-fpm_pool-d-www-conf",
     RedisConf = "redis-conf",
-    SupervisordConf = "supervisord-conf"
+    SupervisordConf = "supervisord-conf",
+    SysctlConf = "sysctl-conf"
 }

package/dist/api/generated/models/variable-targets.js

@@ -33,4 +33,5 @@ var VariableTargetsNameEnum;
     VariableTargetsNameEnum["PhpFpmPoolDWwwConf"] = "php-fpm_pool-d-www-conf";
     VariableTargetsNameEnum["RedisConf"] = "redis-conf";
     VariableTargetsNameEnum["SupervisordConf"] = "supervisord-conf";
+    VariableTargetsNameEnum["SysctlConf"] = "sysctl-conf";
 })(VariableTargetsNameEnum = exports.VariableTargetsNameEnum || (exports.VariableTargetsNameEnum = {}));

package/package.json

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