@devopness/sdk-js 2.17.0 → 2.19.0

package/dist/api/generated/apis/projects-daemons-api.d.ts

@@ -12,7 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { Daemon } from '../../generated/models';
-import { DaemonCreate } from '../../generated/models';
+import { DaemonProjectCreate } from '../../generated/models';
 import { DaemonRelation } from '../../generated/models';
 /**
  * ProjectsDaemonsApiService - Auto-generated
@@ -20,15 +20,15 @@ import { DaemonRelation } from '../../generated/models';
 export declare class ProjectsDaemonsApiService extends ApiBaseService {
     /**
      *
-     * @summary Add a daemon to the given project
-     * @param {number} projectId The project numeric Id
-     * @param {DaemonCreate} daemonCreate A JSON object containing daemon data
+     * @summary Add a Daemon to the given project
+     * @param {number} projectId The ID of the project.
+     * @param {DaemonProjectCreate} daemonProjectCreate A JSON object containing the resource data
      */
-    addDaemonToProject(projectId: number, daemonCreate: DaemonCreate): Promise<ApiResponse<Daemon>>;
+    addProjectDaemon(projectId: number, daemonProjectCreate: DaemonProjectCreate): Promise<ApiResponse<Daemon>>;
     /**
      *
-     * @summary Returns a list of all daemons belonging to a project
-     * @param {number} projectId Numeric ID of the project to get daemons from
+     * @summary Return a list of all Daemons belonging to a project
+     * @param {number} projectId The ID of the project.
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
      */

package/dist/api/generated/apis/projects-daemons-api.js

@@ -31,28 +31,28 @@ const Exceptions_1 = require("../../../common/Exceptions");
 class ProjectsDaemonsApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
-     * @summary Add a daemon to the given project
-     * @param {number} projectId The project numeric Id
-     * @param {DaemonCreate} daemonCreate A JSON object containing daemon data
+     * @summary Add a Daemon to the given project
+     * @param {number} projectId The ID of the project.
+     * @param {DaemonProjectCreate} daemonProjectCreate A JSON object containing the resource data
      */
-    addDaemonToProject(projectId, daemonCreate) {
+    addProjectDaemon(projectId, daemonProjectCreate) {
         return __awaiter(this, void 0, void 0, function* () {
             if (projectId === null || projectId === undefined) {
-                throw new Exceptions_1.ArgumentNullException('projectId', 'addDaemonToProject');
+                throw new Exceptions_1.ArgumentNullException('projectId', 'addProjectDaemon');
             }
-            if (daemonCreate === null || daemonCreate === undefined) {
-                throw new Exceptions_1.ArgumentNullException('daemonCreate', 'addDaemonToProject');
+            if (daemonProjectCreate === null || daemonProjectCreate === undefined) {
+                throw new Exceptions_1.ArgumentNullException('daemonProjectCreate', 'addProjectDaemon');
             }
             let queryString = '';
             const requestUrl = '/projects/{project_id}/daemons' + (queryString ? `?${queryString}` : '');
-            const response = yield this.post(requestUrl.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId))), daemonCreate);
+            const response = yield this.post(requestUrl.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId))), daemonProjectCreate);
             return new ApiResponse_1.ApiResponse(response);
         });
     }
     /**
      *
-     * @summary Returns a list of all daemons belonging to a project
-     * @param {number} projectId Numeric ID of the project to get daemons from
+     * @summary Return a list of all Daemons belonging to a project
+     * @param {number} projectId The ID of the project.
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
      */

package/dist/api/generated/apis/projects-network-rules-api.d.ts

@@ -20,15 +20,15 @@ import { NetworkRuleRelation } from '../../generated/models';
 export declare class ProjectsNetworkRulesApiService extends ApiBaseService {
     /**
      *
-     * @summary Add a network rule to the given project
-     * @param {number} projectId The project numeric Id
-     * @param {NetworkRuleCreate} networkRuleCreate A JSON object containing backgroud process data
+     * @summary Add a Network Rule to the given project
+     * @param {number} projectId The ID of the project.
+     * @param {NetworkRuleCreate} networkRuleCreate A JSON object containing the resource data
      */
-    addNetworkRuleToProject(projectId: number, networkRuleCreate: NetworkRuleCreate): Promise<ApiResponse<NetworkRule>>;
+    addProjectNetworkRule(projectId: number, networkRuleCreate: NetworkRuleCreate): Promise<ApiResponse<NetworkRule>>;
     /**
      *
-     * @summary Returns a list of all network rules that applies to a project
-     * @param {number} projectId Numeric ID of the project to get network rules from
+     * @summary Return a list of all Network Rules belonging to a project
+     * @param {number} projectId The ID of the project.
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
      */

package/dist/api/generated/apis/projects-network-rules-api.js

@@ -31,17 +31,17 @@ const Exceptions_1 = require("../../../common/Exceptions");
 class ProjectsNetworkRulesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
-     * @summary Add a network rule to the given project
-     * @param {number} projectId The project numeric Id
-     * @param {NetworkRuleCreate} networkRuleCreate A JSON object containing backgroud process data
+     * @summary Add a Network Rule to the given project
+     * @param {number} projectId The ID of the project.
+     * @param {NetworkRuleCreate} networkRuleCreate A JSON object containing the resource data
      */
-    addNetworkRuleToProject(projectId, networkRuleCreate) {
+    addProjectNetworkRule(projectId, networkRuleCreate) {
         return __awaiter(this, void 0, void 0, function* () {
             if (projectId === null || projectId === undefined) {
-                throw new Exceptions_1.ArgumentNullException('projectId', 'addNetworkRuleToProject');
+                throw new Exceptions_1.ArgumentNullException('projectId', 'addProjectNetworkRule');
             }
             if (networkRuleCreate === null || networkRuleCreate === undefined) {
-                throw new Exceptions_1.ArgumentNullException('networkRuleCreate', 'addNetworkRuleToProject');
+                throw new Exceptions_1.ArgumentNullException('networkRuleCreate', 'addProjectNetworkRule');
             }
             let queryString = '';
             const requestUrl = '/projects/{project_id}/network-rules' + (queryString ? `?${queryString}` : '');
@@ -51,8 +51,8 @@ class ProjectsNetworkRulesApiService extends ApiBaseService_1.ApiBaseService {
     }
     /**
      *
-     * @summary Returns a list of all network rules that applies to a project
-     * @param {number} projectId Numeric ID of the project to get network rules from
+     * @summary Return a list of all Network Rules belonging to a project
+     * @param {number} projectId The ID of the project.
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
      */

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

@@ -18,14 +18,14 @@ import { SslCertificate } from '../../generated/models';
 export declare class SSLCertificatesApiService extends ApiBaseService {
     /**
      *
-     * @summary Delete a SSL certificate
-     * @param {number} sslCertificateId The unique id of the record to be deleted
+     * @summary Delete a given SSL Certificate
+     * @param {number} sslCertificateId The ID of the ssl certificate.
      */
     deleteSslCertificate(sslCertificateId: number): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Get details of a single SSL certificate
-     * @param {number} sslCertificateId Unique ID of the item to be retrieved
+     * @param {number} sslCertificateId The ID of the ssl certificate.
      */
     getSslCertificate(sslCertificateId: number): Promise<ApiResponse<SslCertificate>>;
 }

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

@@ -31,8 +31,8 @@ const Exceptions_1 = require("../../../common/Exceptions");
 class SSLCertificatesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
-     * @summary Delete a SSL certificate
-     * @param {number} sslCertificateId The unique id of the record to be deleted
+     * @summary Delete a given SSL Certificate
+     * @param {number} sslCertificateId The ID of the ssl certificate.
      */
     deleteSslCertificate(sslCertificateId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -48,7 +48,7 @@ class SSLCertificatesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Get details of a single SSL certificate
-     * @param {number} sslCertificateId Unique ID of the item to be retrieved
+     * @param {number} sslCertificateId The ID of the ssl certificate.
      */
     getSslCertificate(sslCertificateId) {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -20,20 +20,20 @@ export declare class VariablesApiService extends ApiBaseService {
     /**
      *
      * @summary Delete a variable by ID
-     * @param {number} variableId The id of the variable
+     * @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
+     * @param {number} variableId The 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
+     * @param {number} variableId The ID of the variable.
+     * @param {VariableUpdate} variableUpdate A JSON object containing the resource data
      */
     updateVariable(variableId: number, variableUpdate: VariableUpdate): Promise<ApiResponse<void>>;
 }

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

@@ -32,7 +32,7 @@ class VariablesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Delete a variable by ID
-     * @param {number} variableId The id of the variable
+     * @param {number} variableId The ID of the variable.
      */
     deleteVariable(variableId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -48,7 +48,7 @@ class VariablesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Get a variable by ID
-     * @param {number} variableId The unique id of the variable
+     * @param {number} variableId The ID of the variable.
      */
     getVariable(variableId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -64,8 +64,8 @@ class VariablesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @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
+     * @param {number} variableId The ID of the variable.
+     * @param {VariableUpdate} variableUpdate A JSON object containing the resource data
      */
     updateVariable(variableId, variableUpdate) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/api/generated/models/cron-job-update.d.ts

@@ -9,7 +9,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { EnvironmentLinkItem } from './environment-link-item';
 /**
  *
  * @export
@@ -53,9 +52,9 @@ export interface CronJobUpdate {
      */
     application_id?: number;
     /**
-     *
-     * @type {Array<EnvironmentLinkItem>}
+     * List of valid resource IDs
+     * @type {Array<number>}
      * @memberof CronJobUpdate
      */
-    environments?: Array<EnvironmentLinkItem>;
+    servers?: Array<number>;
 }

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

@@ -9,7 +9,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { EnvironmentLinkItem } from './environment-link-item';
 /**
  *
  * @export
@@ -17,45 +16,39 @@ import { EnvironmentLinkItem } from './environment-link-item';
  */
 export interface DaemonCreate {
     /**
-     * The name entered by the user (or auto-generated by `devopness`) to uniquely identify the daemon
+     * The command line to be executed to start the daemon. Must not be greater than 255 characters.
      * @type {string}
      * @memberof DaemonCreate
      */
-    name: string;
+    command: string;
     /**
-     * The command line to be executed to start the daemon
-     * @type {string}
+     * The number of daemon process instances of the program to run simultaneously. Must be at least 1. Must not be greater than 99.
+     * @type {number}
      * @memberof DaemonCreate
      */
-    command: string;
+    process_count: number;
     /**
-     * The working directory where the daemon will be relative to when performing disk i/o
+     * The working directory where the daemon will be relative to when performing disk i/o. Must start with one of <code>/</code>.
      * @type {string}
      * @memberof DaemonCreate
      */
     working_directory: string;
     /**
-     * The number of daemon process instances of the program to run simultaneously
-     * @type {number}
-     * @memberof DaemonCreate
-     */
-    process_count: number;
-    /**
-     * The name of the Unix user on behalf of which the daemon will run
+     * The name of the Unix user on behalf of which the daemon will run. Must not be greater than 60 characters.
      * @type {string}
      * @memberof DaemonCreate
      */
     run_as_user: string;
     /**
-     * Indicates if the command was auto_generated by `devopness` itself
-     * @type {boolean}
+     * The name entered by the user (or auto-generated by `devopness`) to uniquely identify the daemon. Must contain only letters, numbers, dashes and underscores. Must not be greater than 60 characters.
+     * @type {string}
      * @memberof DaemonCreate
      */
-    auto_generated?: boolean;
+    name: string;
     /**
-     *
-     * @type {Array<EnvironmentLinkItem>}
+     * List of valid resource IDs
+     * @type {Array<number>}
      * @memberof DaemonCreate
      */
-    environments?: Array<EnvironmentLinkItem>;
+    servers?: Array<number>;
 }

package/dist/api/generated/models/daemon-project-create.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 { EnvironmentLinkItem } from './environment-link-item';
+/**
+ *
+ * @export
+ * @interface DaemonProjectCreate
+ */
+export interface DaemonProjectCreate {
+    /**
+     * The command line to be executed to start the daemon. Must not be greater than 255 characters.
+     * @type {string}
+     * @memberof DaemonProjectCreate
+     */
+    command: string;
+    /**
+     * The number of daemon process instances of the program to run simultaneously. Must be at least 1. Must not be greater than 99.
+     * @type {number}
+     * @memberof DaemonProjectCreate
+     */
+    process_count: number;
+    /**
+     * The working directory where the daemon will be relative to when performing disk i/o. Must start with one of <code>/</code>.
+     * @type {string}
+     * @memberof DaemonProjectCreate
+     */
+    working_directory: string;
+    /**
+     * The name of the Unix user on behalf of which the daemon will run. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof DaemonProjectCreate
+     */
+    run_as_user: string;
+    /**
+     * The name entered by the user (or auto-generated by `devopness`) to uniquely identify the daemon. Must contain only letters, numbers, dashes and underscores. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof DaemonProjectCreate
+     */
+    name: string;
+    /**
+     * Numeric ID of the project to which the cron job belongs to.
+     * @type {number}
+     * @memberof DaemonProjectCreate
+     */
+    project_id: number;
+    /**
+     *
+     * @type {Array<EnvironmentLinkItem>}
+     * @memberof DaemonProjectCreate
+     */
+    environments?: Array<EnvironmentLinkItem>;
+}

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

@@ -18,7 +18,7 @@ import { ApplicationRelation } from './application-relation';
  */
 export interface DaemonRelation {
     /**
-     * The Id of the given daemon
+     * The ID of the given daemon
      * @type {number}
      * @memberof DaemonRelation
      */
@@ -35,6 +35,12 @@ export interface DaemonRelation {
      * @memberof DaemonRelation
      */
     command: string;
+    /**
+     * The name of the Unix user on behalf of which the daemon will be executed
+     * @type {string}
+     * @memberof DaemonRelation
+     */
+    run_as_user: string;
     /**
      * The working directory where the daemon will be relative to when performing disk i/o
      * @type {string}
@@ -48,39 +54,33 @@ export interface DaemonRelation {
      */
     process_count: number;
     /**
-     * The name of the Unix user on behalf of which the daemon will run
-     * @type {string}
-     * @memberof DaemonRelation
-     */
-    run_as_user: string;
-    /**
-     * Indicates if the command was auto_generated by `devopness` itself
+     * Indicates if the daemon was auto_generated by `devopness` itself
      * @type {boolean}
      * @memberof DaemonRelation
      */
-    auto_generated?: boolean;
+    auto_generated: boolean;
     /**
      *
      * @type {ActionRelation}
      * @memberof DaemonRelation
      */
-    last_action?: ActionRelation | null;
+    last_action: ActionRelation | null;
     /**
      *
      * @type {ApplicationRelation}
      * @memberof DaemonRelation
      */
-    application?: ApplicationRelation | null;
+    application: ApplicationRelation | null;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof DaemonRelation
      */
-    created_at?: string;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof DaemonRelation
      */
-    updated_at?: string;
+    updated_at: string;
 }

package/dist/api/generated/models/daemon-restart.d.ts

@@ -16,7 +16,7 @@
  */
 export interface DaemonRestart {
     /**
-     * The unique environment id
+     * The unique environment ID.
      * @type {number}
      * @memberof DaemonRestart
      */

package/dist/api/generated/models/daemon-update.d.ts

@@ -9,7 +9,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { EnvironmentLinkItem } from './environment-link-item';
 /**
  *
  * @export
@@ -17,51 +16,45 @@ import { EnvironmentLinkItem } from './environment-link-item';
  */
 export interface DaemonUpdate {
     /**
-     * The unique id of the given record
-     * @type {number}
+     * The command line to be executed to start the daemon. Must not be greater than 255 characters.
+     * @type {string}
      * @memberof DaemonUpdate
      */
-    id: number;
+    command: string;
     /**
-     * Numeric ID of the application to which the daemon belongs to
+     * The number of daemon process instances of the program to run simultaneously. Must be at least 1. Must not be greater than 99.
      * @type {number}
      * @memberof DaemonUpdate
      */
-    application_id?: number;
+    process_count: number;
     /**
-     * The name entered by the user (or auto-generated by `devopness`) to uniquely identify the daemon
+     * The working directory where the daemon will be relative to when performing disk i/o. Must start with one of <code>/</code>.
      * @type {string}
      * @memberof DaemonUpdate
      */
-    name: string;
+    working_directory: string;
     /**
-     * The command line to be executed to start the daemon
+     * The name of the Unix user on behalf of which the daemon will run. Must not be greater than 60 characters.
      * @type {string}
      * @memberof DaemonUpdate
      */
-    command: string;
+    run_as_user: string;
     /**
-     * The working directory where the daemon will be relative to when performing disk i/o
+     * The name entered by the user (or auto-generated by `devopness`) to uniquely identify the daemon. Must contain only letters, numbers, dashes and underscores. Must not be greater than 60 characters.
      * @type {string}
      * @memberof DaemonUpdate
      */
-    working_directory: string;
+    name: string;
     /**
-     * The number of daemon process instances of the program to run simultaneously
+     * Numeric ID of the project to which the daemon belongs to.
      * @type {number}
      * @memberof DaemonUpdate
      */
-    process_count: number;
-    /**
-     * The name of the Unix user on behalf of which the daemon will run
-     * @type {string}
-     * @memberof DaemonUpdate
-     */
-    run_as_user: string;
+    application_id?: number;
     /**
-     *
-     * @type {Array<EnvironmentLinkItem>}
+     * List of valid resource IDs
+     * @type {Array<number>}
      * @memberof DaemonUpdate
      */
-    environments?: Array<EnvironmentLinkItem>;
+    servers?: Array<number>;
 }

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

@@ -21,7 +21,7 @@ import { ServerRelation } from './server-relation';
  */
 export interface Daemon {
     /**
-     * The Id of the given daemon
+     * The ID of the given daemon
      * @type {number}
      * @memberof Daemon
      */
@@ -38,6 +38,12 @@ export interface Daemon {
      * @memberof Daemon
      */
     command: string;
+    /**
+     * The name of the Unix user on behalf of which the daemon will be executed
+     * @type {string}
+     * @memberof Daemon
+     */
+    run_as_user: string;
     /**
      * The working directory where the daemon will be relative to when performing disk i/o
      * @type {string}
@@ -51,23 +57,23 @@ export interface Daemon {
      */
     process_count: number;
     /**
-     * The name of the Unix user on behalf of which the daemon will run
-     * @type {string}
-     * @memberof Daemon
-     */
-    run_as_user: string;
-    /**
-     * Indicates if the command was auto_generated by `devopness` itself
+     * Indicates if the daemon was auto_generated by `devopness` itself
      * @type {boolean}
      * @memberof Daemon
      */
-    auto_generated?: boolean;
+    auto_generated: boolean;
     /**
      *
      * @type {ProjectRelation}
      * @memberof Daemon
      */
     project: ProjectRelation;
+    /**
+     *
+     * @type {ActionRelation}
+     * @memberof Daemon
+     */
+    last_action: ActionRelation | null;
     /**
      *
      * @type {ApplicationRelation}
@@ -76,32 +82,32 @@ export interface Daemon {
     application: ApplicationRelation | null;
     /**
      *
-     * @type {Array<EnvironmentRelation>}
+     * @type {EnvironmentRelation}
      * @memberof Daemon
      */
-    environments: Array<EnvironmentRelation>;
+    environment: EnvironmentRelation;
     /**
      *
-     * @type {Array<ServerRelation>}
+     * @type {Array<EnvironmentRelation>}
      * @memberof Daemon
      */
-    servers: Array<ServerRelation>;
+    environments: Array<EnvironmentRelation>;
     /**
      *
-     * @type {ActionRelation}
+     * @type {Array<ServerRelation>}
      * @memberof Daemon
      */
-    last_action: ActionRelation | null;
+    servers: Array<ServerRelation>;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof Daemon
      */
-    created_at?: string;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof Daemon
      */
-    updated_at?: string;
+    updated_at: string;
 }