@devopness/sdk-js 2.32.0 → 2.34.0

package/README.md

@@ -74,25 +74,51 @@ getUserProfile();
 This package includes TypeScript declarations for every method.
 TypeScript versions `>= 3.8` are supported.
 
-Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you'e using the latest version of this package, you can rely on the Devopness API documentation for checking the input and return types of each API endpoint.
+>Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you'e using the latest version of this package, you can rely on the Devopness API documentation for checking the input and return types of each API endpoint.
+
+## Development & Testing
+To build and test the SDK locally, [**fork this repository**](https://github.com/devopness/devopness/fork) and follow these steps:
+
+### With Docker
+#### Pre-requisites
+- [Docker](https://www.docker.com/products/docker-desktop/)
+- [make](https://www.gnu.org/software/make/)
+  - `make` is pre-installed in most Linux systems. In `macOS` it is included as part of the `Xcode` command line utils
+### Setup and run in local environment
+#### 1. Build Docker Image
+```
+make build-image
+```
+
+#### 2. Install Dependencies
+```
+make npm-ci
+```
 
-## Building and testing
-To build and test the SDK locally, follow these steps:
-1. Clone de repository
+#### 3. Build SDK
 ```
-git clone https://github.com/devopness/devopness.git
+make build-sdk-js
 ```
-2. Install missing dependencies
 
-This command will install all modules listed as dependencies in [package.json](package.json). A working Java Runtime Environment is also required. Please, check out the installation instructions for your operating system.
+#### 4. Run Tests
+```
+make test
+```
+
+### Without Docker
+
+#### 1. Install missing dependencies
+This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions for your operating system.
 ```
 npm install
 ```
-3. Build
+
+#### 2. Build SDK
 ```
-npm run build-api-models
+npm run build
 ```
-4. Run tests
+
+#### 3. Run tests
 ```
 npm run test
 ```

package/dist/api/generated/apis/environments-servers-api.d.ts

@@ -11,7 +11,6 @@
  */
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
-import { EnvironmentLinkItem } from '../../generated/models';
 import { Server } from '../../generated/models';
 import { ServerEnvironmentCreate } from '../../generated/models';
 import { ServerRelation } from '../../generated/models';
@@ -26,14 +25,6 @@ export declare class EnvironmentsServersApiService extends ApiBaseService {
      * @param {ServerEnvironmentCreate} serverEnvironmentCreate A JSON object containing the resource data
      */
     addEnvironmentServer(environmentId: number, serverEnvironmentCreate: ServerEnvironmentCreate): Promise<ApiResponse<Server>>;
-    /**
-     *
-     * @summary Link a server to an environment
-     * @param {number} environmentId Unique ID of the environment
-     * @param {number} serverId Unique ID of the server to be linked
-     * @param {EnvironmentLinkItem} [environmentLinkItem] A JSON object containing environment server link optional parameters
-     */
-    linkServerToEnvironment(environmentId: number, serverId: number, environmentLinkItem?: EnvironmentLinkItem): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Return a list of all servers belonging to a environment
@@ -42,18 +33,4 @@ export declare class EnvironmentsServersApiService extends ApiBaseService {
      * @param {number} [perPage] Number of items returned per page
      */
     listEnvironmentServers(environmentId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<ServerRelation>>>;
-    /**
-     *
-     * @summary Replace all linked servers by new ones. Immediately deploying all changes to previously and newly linked servers
-     * @param {number} environmentId Unique ID of the environment
-     * @param {EnvironmentLinkItem} environmentLinkItem A JSON object containing environment server link parameters
-     */
-    replaceLinkedServers(environmentId: number, environmentLinkItem: EnvironmentLinkItem): Promise<ApiResponse<void>>;
-    /**
-     *
-     * @summary Unlink/Remove a server from an environment
-     * @param {number} environmentId Unique ID of the environment
-     * @param {number} serverId Unique ID of the server to unlink
-     */
-    unlinkServerFromEnvironment(environmentId: number, serverId: number): Promise<ApiResponse<void>>;
 }

package/dist/api/generated/apis/environments-servers-api.js

@@ -49,27 +49,6 @@ class EnvironmentsServersApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
-    /**
-     *
-     * @summary Link a server to an environment
-     * @param {number} environmentId Unique ID of the environment
-     * @param {number} serverId Unique ID of the server to be linked
-     * @param {EnvironmentLinkItem} [environmentLinkItem] A JSON object containing environment server link optional parameters
-     */
-    linkServerToEnvironment(environmentId, serverId, environmentLinkItem) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (environmentId === null || environmentId === undefined) {
-                throw new Exceptions_1.ArgumentNullException('environmentId', 'linkServerToEnvironment');
-            }
-            if (serverId === null || serverId === undefined) {
-                throw new Exceptions_1.ArgumentNullException('serverId', 'linkServerToEnvironment');
-            }
-            let queryString = '';
-            const requestUrl = '/environments/{environment_id}/servers/{server_id}/link' + (queryString ? `?${queryString}` : '');
-            const response = yield this.post(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))).replace(`{${"server_id"}}`, encodeURIComponent(String(serverId))), environmentLinkItem);
-            return new ApiResponse_1.ApiResponse(response);
-        });
-    }
     /**
      *
      * @summary Return a list of all servers belonging to a environment
@@ -95,45 +74,5 @@ class EnvironmentsServersApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
-    /**
-     *
-     * @summary Replace all linked servers by new ones. Immediately deploying all changes to previously and newly linked servers
-     * @param {number} environmentId Unique ID of the environment
-     * @param {EnvironmentLinkItem} environmentLinkItem A JSON object containing environment server link parameters
-     */
-    replaceLinkedServers(environmentId, environmentLinkItem) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (environmentId === null || environmentId === undefined) {
-                throw new Exceptions_1.ArgumentNullException('environmentId', 'replaceLinkedServers');
-            }
-            if (environmentLinkItem === null || environmentLinkItem === undefined) {
-                throw new Exceptions_1.ArgumentNullException('environmentLinkItem', 'replaceLinkedServers');
-            }
-            let queryString = '';
-            const requestUrl = '/environments/{environment_id}/servers/replace-linked-servers' + (queryString ? `?${queryString}` : '');
-            const response = yield this.post(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))), environmentLinkItem);
-            return new ApiResponse_1.ApiResponse(response);
-        });
-    }
-    /**
-     *
-     * @summary Unlink/Remove a server from an environment
-     * @param {number} environmentId Unique ID of the environment
-     * @param {number} serverId Unique ID of the server to unlink
-     */
-    unlinkServerFromEnvironment(environmentId, serverId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (environmentId === null || environmentId === undefined) {
-                throw new Exceptions_1.ArgumentNullException('environmentId', 'unlinkServerFromEnvironment');
-            }
-            if (serverId === null || serverId === undefined) {
-                throw new Exceptions_1.ArgumentNullException('serverId', 'unlinkServerFromEnvironment');
-            }
-            let queryString = '';
-            const requestUrl = '/environments/{environment_id}/servers/{server_id}/unlink' + (queryString ? `?${queryString}` : '');
-            const response = yield this.delete(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))).replace(`{${"server_id"}}`, encodeURIComponent(String(serverId))));
-            return new ApiResponse_1.ApiResponse(response);
-        });
-    }
 }
 exports.EnvironmentsServersApiService = EnvironmentsServersApiService;

package/dist/api/generated/models/application-environment-create.d.ts

@@ -135,5 +135,5 @@ export interface ApplicationEnvironmentCreate {
      * @type {Array<number>}
      * @memberof ApplicationEnvironmentCreate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

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

@@ -185,12 +185,6 @@ export interface Application {
      * @memberof Application
      */
     environment: EnvironmentRelation;
-    /**
-     *
-     * @type {Array<EnvironmentRelation>}
-     * @memberof Application
-     */
-    environments: Array<EnvironmentRelation>;
     /**
      *
      * @type {Array<ServerRelation>}

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

@@ -50,5 +50,5 @@ export interface CronJobEnvironmentCreate {
      * @type {Array<number>}
      * @memberof CronJobEnvironmentCreate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

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

@@ -56,5 +56,5 @@ export interface CronJobUpdate {
      * @type {Array<number>}
      * @memberof CronJobUpdate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

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

@@ -90,10 +90,10 @@ export interface CronJob {
     project: ProjectRelation | null;
     /**
      *
-     * @type {Array<EnvironmentRelation>}
+     * @type {EnvironmentRelation}
      * @memberof CronJob
      */
-    environments: Array<EnvironmentRelation>;
+    environment: EnvironmentRelation;
     /**
      *
      * @type {Array<ServerRelation>}

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

@@ -50,5 +50,5 @@ export interface DaemonEnvironmentCreate {
      * @type {Array<number>}
      * @memberof DaemonEnvironmentCreate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

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

@@ -62,5 +62,5 @@ export interface DaemonUpdate {
      * @type {Array<number>}
      * @memberof DaemonUpdate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

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

@@ -86,12 +86,6 @@ export interface Daemon {
      * @memberof Daemon
      */
     environment: EnvironmentRelation;
-    /**
-     *
-     * @type {Array<EnvironmentRelation>}
-     * @memberof Daemon
-     */
-    environments: Array<EnvironmentRelation>;
     /**
      *
      * @type {Array<ServerRelation>}

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

@@ -64,5 +64,5 @@ export interface NetworkRuleEnvironmentCreate {
      * @type {Array<number>}
      * @memberof NetworkRuleEnvironmentCreate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

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

@@ -58,5 +58,5 @@ export interface NetworkRuleUpdate {
      * @type {Array<number>}
      * @memberof NetworkRuleUpdate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

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

@@ -93,12 +93,6 @@ export interface NetworkRule {
      * @memberof NetworkRule
      */
     environment: EnvironmentRelation;
-    /**
-     *
-     * @type {Array<EnvironmentRelation>}
-     * @memberof NetworkRule
-     */
-    environments: Array<EnvironmentRelation>;
     /**
      *
      * @type {Array<ServerRelation>}

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

@@ -111,12 +111,6 @@ export interface Server {
      * @memberof Server
      */
     environment: EnvironmentRelation;
-    /**
-     *
-     * @type {Array<EnvironmentRelation>}
-     * @memberof Server
-     */
-    environments: Array<EnvironmentRelation>;
     /**
      * The date and time when the record was created
      * @type {string}

package/dist/api/generated/models/service-environment-create.d.ts

@@ -46,5 +46,5 @@ export interface ServiceEnvironmentCreate {
      * @type {Array<number>}
      * @memberof ServiceEnvironmentCreate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

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

@@ -26,5 +26,5 @@ export interface ServiceUpdate {
      * @type {Array<number>}
      * @memberof ServiceUpdate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

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

@@ -81,12 +81,6 @@ export interface Service {
      * @memberof Service
      */
     environment: EnvironmentRelation;
-    /**
-     *
-     * @type {Array<EnvironmentRelation>}
-     * @memberof Service
-     */
-    environments: Array<EnvironmentRelation>;
     /**
      *
      * @type {UserRelation}

package/dist/api/generated/models/ssh-key-environment-create.d.ts

@@ -32,5 +32,5 @@ export interface SshKeyEnvironmentCreate {
      * @type {Array<number>}
      * @memberof SshKeyEnvironmentCreate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

package/dist/api/generated/models/ssh-key-update.d.ts

@@ -32,5 +32,5 @@ export interface SshKeyUpdate {
      * @type {Array<number>}
      * @memberof SshKeyUpdate
      */
-    servers?: Array<number>;
+    servers: Array<number>;
 }

package/dist/api/generated/models/ssh-key.d.ts

@@ -63,10 +63,10 @@ export interface SshKey {
     created_by_user: UserRelation;
     /**
      *
-     * @type {Array<EnvironmentRelation>}
+     * @type {EnvironmentRelation}
      * @memberof SshKey
      */
-    environments: Array<EnvironmentRelation>;
+    environment: EnvironmentRelation;
     /**
      *
      * @type {Array<ServerRelation>}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { UserRelation } from './user-relation';
 import { VariableTarget } from './variable-target';
 import { VariableType } from './variable-type';
 /**
@@ -71,6 +72,12 @@ export interface VariableRelation {
      * @memberof VariableRelation
      */
     hidden: boolean;
+    /**
+     *
+     * @type {UserRelation}
+     * @memberof VariableRelation
+     */
+    created_by_user: UserRelation;
     /**
      * The date and time when the record was created
      * @type {string}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { UserRelation } from './user-relation';
 import { VariableTarget } from './variable-target';
 import { VariableType } from './variable-type';
 /**
@@ -71,6 +72,12 @@ export interface Variable {
      * @memberof Variable
      */
     hidden: boolean;
+    /**
+     *
+     * @type {UserRelation}
+     * @memberof Variable
+     */
+    created_by_user: UserRelation;
     /**
      * The date and time when the record was created
      * @type {string}

package/package.json

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