@devopness/sdk-js 2.16.0 → 2.18.0

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/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

@@ -17,47 +17,41 @@ 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>}

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;
 }

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

@@ -59,6 +59,7 @@ export * from './cron-job-relation';
 export * from './cron-job-update';
 export * from './daemon';
 export * from './daemon-create';
+export * from './daemon-project-create';
 export * from './daemon-relation';
 export * from './daemon-restart';
 export * from './daemon-update';
@@ -214,6 +215,7 @@ export * from './user-tokens';
 export * from './user-update';
 export * from './variable';
 export * from './variable-create';
+export * from './variable-relation';
 export * from './variable-target';
 export * from './variable-type';
 export * from './variable-update';

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

@@ -75,6 +75,7 @@ __exportStar(require("./cron-job-relation"), exports);
 __exportStar(require("./cron-job-update"), exports);
 __exportStar(require("./daemon"), exports);
 __exportStar(require("./daemon-create"), exports);
+__exportStar(require("./daemon-project-create"), exports);
 __exportStar(require("./daemon-relation"), exports);
 __exportStar(require("./daemon-restart"), exports);
 __exportStar(require("./daemon-update"), exports);
@@ -230,6 +231,7 @@ __exportStar(require("./user-tokens"), exports);
 __exportStar(require("./user-update"), exports);
 __exportStar(require("./variable"), exports);
 __exportStar(require("./variable-create"), exports);
+__exportStar(require("./variable-relation"), exports);
 __exportStar(require("./variable-target"), exports);
 __exportStar(require("./variable-type"), exports);
 __exportStar(require("./variable-update"), exports);

package/dist/api/generated/models/network-rule-create.d.ts

@@ -19,7 +19,7 @@ import { NetworkRuleType } from './network-rule-type';
  */
 export interface NetworkRuleCreate {
     /**
-     * The rule\'s name/description/reminder
+     * The rule\'s name/description/reminder. Must be at least 3 characters. Must not be greater than 60 characters.
      * @type {string}
      * @memberof NetworkRuleCreate
      */
@@ -35,27 +35,27 @@ export interface NetworkRuleCreate {
      * @type {NetworkRuleProtocol}
      * @memberof NetworkRuleCreate
      */
-    protocol: NetworkRuleProtocol;
+    protocol?: NetworkRuleProtocol;
     /**
-     * Starting range of the public ipv4 or ipv6 addresses that can access this rule
+     * Starting range of the public ipv4 or ipv6 addresses that can access this rule. Must be a valid IP address.
      * @type {string}
      * @memberof NetworkRuleCreate
      */
-    ip_address_from: string | null;
+    ip_address_from?: string;
     /**
-     * Ending range of the public ipv4 or ipv6 addresses that can access this rule
+     * Ending range of the public ipv4 or ipv6 addresses that can access this rule. Must be a valid IP address.
      * @type {string}
      * @memberof NetworkRuleCreate
      */
-    ip_address_to: string | null;
+    ip_address_to?: string;
     /**
-     * Starting range of network ports to be considered by this rule
+     * Starting range of network ports to be considered by this rule. Must be at least 1. Must not be greater than 65535.
      * @type {number}
      * @memberof NetworkRuleCreate
      */
     port_from: number;
     /**
-     * Ending range of network ports to be considered by this rule
+     * Ending range of network ports to be considered by this rule. Must be at least 1. Must not be greater than 65535.
      * @type {number}
      * @memberof NetworkRuleCreate
      */

package/dist/api/generated/models/network-rule-relation.d.ts

@@ -19,7 +19,7 @@ import { NetworkRuleType } from './network-rule-type';
  */
 export interface NetworkRuleRelation {
     /**
-     * The unique id of the given record
+     * The ID of the given network rule
      * @type {number}
      * @memberof NetworkRuleRelation
      */
@@ -43,45 +43,51 @@ export interface NetworkRuleRelation {
      */
     protocol: NetworkRuleProtocol;
     /**
-     * Starting range of the public ipv4 or ipv6 addresses that can access this rule
-     * @type {string}
+     * Starting range of network ports to be considered by this rule
+     * @type {number}
      * @memberof NetworkRuleRelation
      */
-    ip_address_from?: string | null;
+    port_from: number;
     /**
-     * Ending range of the public ipv4 or ipv6 addresses that can access this rule
+     * Ending range of network ports to be considered by this rule
+     * @type {number}
+     * @memberof NetworkRuleRelation
+     */
+    port_to: number;
+    /**
+     * Starting range of the public ipv4 or ipv6 addresses that can access this rule
      * @type {string}
      * @memberof NetworkRuleRelation
      */
-    ip_address_to?: string | null;
+    ip_address_from: string | null;
     /**
-     * Starting range of network ports to be considered by this rule
-     * @type {number}
+     * Ending range of the public ipv4 or ipv6 addresses that can access this rule
+     * @type {string}
      * @memberof NetworkRuleRelation
      */
-    port_from: number;
+    ip_address_to: string | null;
     /**
-     * Ending range of network ports to be considered by this rule
-     * @type {number}
+     * Indicates if the network rule was auto_generated by `devopness` itself
+     * @type {boolean}
      * @memberof NetworkRuleRelation
      */
-    port_to: number;
+    auto_generated: boolean;
     /**
      *
      * @type {ActionRelation}
      * @memberof NetworkRuleRelation
      */
-    last_action?: ActionRelation | null;
+    last_action: ActionRelation | null;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof NetworkRuleRelation
      */
-    created_at?: string;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof NetworkRuleRelation
      */
-    updated_at?: string;
+    updated_at: string;
 }

package/dist/api/generated/models/network-rule-update.d.ts

@@ -19,13 +19,13 @@ import { NetworkRuleType } from './network-rule-type';
  */
 export interface NetworkRuleUpdate {
     /**
-     * The unique id of the given record
+     * The unique ID of the given network rule.
      * @type {number}
      * @memberof NetworkRuleUpdate
      */
     id: number;
     /**
-     * The rule\'s name/description/reminder
+     * The rule\'s name/description/reminder. Must be at least 3 characters. Must not be greater than 60 characters.
      * @type {string}
      * @memberof NetworkRuleUpdate
      */
@@ -41,19 +41,19 @@ export interface NetworkRuleUpdate {
      * @type {NetworkRuleProtocol}
      * @memberof NetworkRuleUpdate
      */
-    protocol: NetworkRuleProtocol;
+    protocol?: NetworkRuleProtocol;
     /**
-     * Starting range of the public ipv4 or ipv6 addresses that can access this rule
+     * Starting range of the public ipv4 or ipv6 addresses that can access this rule. Must be a valid IP address.
      * @type {string}
      * @memberof NetworkRuleUpdate
      */
-    ip_address_from: string;
+    ip_address_from?: string;
     /**
-     * Ending range of the public ipv4 or ipv6 addresses that can access this rule
+     * Ending range of the public ipv4 or ipv6 addresses that can access this rule. Must be a valid IP address.
      * @type {string}
      * @memberof NetworkRuleUpdate
      */
-    ip_address_to: string;
+    ip_address_to?: string;
     /**
      *
      * @type {Array<EnvironmentLinkItem>}