@devopness/sdk-js 3.1.10 → 3.2.1

package/README.md

@@ -9,7 +9,9 @@ Devopness SDK includes a pre-defined set of classes that provide convenient acce
 ## Usage
 
 ### Install/Upgrade
+
 Use your favourite package manager to install Devopness SDK as a dependency of your project:
+
 ```bash
 # Using npm
 npm install @devopness/sdk-js
@@ -34,107 +36,160 @@ The name of the methods at services is the same as the operation name in the doc
 Devopness API. You can consult the URL of an endpoint to see the operation name. For instance,
 the URL to endpoint `POST /users/login` in the documentation is: `/#operation/login`
 
-### Authenticating
+### Authentication
+
+#### Authentication with Personal Access Token
 
-To authenticate, just invoke the `login` method on the `users` service:
+Ensure you have a Personal Access Token from Devopness. If you don't have one, see [Add a Personal Access Token](https://www.devopness.com/docs/api-tokens/personal-access-tokens/add-personal-access-token).
+
+**Option 1: Pass token during initialization**
 
 ```javascript
-async function authenticate(email, pass) {
-  const userTokens = await devopnessApi.users.loginUser({ email: email, password: pass });
-  // The `accessToken` must be set every time a token is obtained or refreshed.
-  devopnessApi.accessToken = userTokens.data.access_token;
-}
+import { DevopnessApiClient } from '@devopness/sdk-js'
+
+const devopnessApi = new DevopnessApiClient({
+  apiToken: 'your-personal-access-token-here'
+});
+
+const currentUser = await devopnessApi.users.getUserMe();
+```
+
+**Option 2: Set token after initialization**
+
+```javascript
+import { DevopnessApiClient } from '@devopness/sdk-js'
+
+const devopnessApi = new DevopnessApiClient();
+devopnessApi.apiToken = 'your-personal-access-token-here';
 
-// invoke the authentication method
-authenticate('user@email.com', 'secret-password');
+const currentUser = await devopnessApi.users.getUserMe();
 ```
 
-In the example above, `userTokens` is an instance of `ApiResponse` and the `data` property has the data requested from the API. See [ApiResponse.ts](https://github.com/devopness/devopness/blob/main/packages/sdks/javascript/src/common/ApiResponse.ts) for reference.
+#### Authentication with Project API Token
 
-### Invoking authentication protected endpoints
-Once an authentication token is set, any protected endpoint can be invoked.
-Example retrieving current user details:
+Ensure you have a Project API Token from Devopness. If you don't have one, see [Add a Project API Token](https://www.devopness.com/docs/api-tokens/project-api-tokens/add-project-api-token).
 
 ```javascript
-async function getUserProfile() {
-    // invoke the authentication method to ensure an auth token
-    // is retrieved and set to the SDK instance
-    await authenticate('user@email.com', 'secret-password');
+import { DevopnessApiClient } from '@devopness/sdk-js'
+
+const devopnessApi = new DevopnessApiClient({
+  apiToken: 'your-project-api-token-here'
+});
+
+const project = await devopnessApi.projects.getProject(projectId);
+```
+
+#### Authentication with Login (Deprecated)
+
+> **Warning:** Email/password authentication is no longer supported. API requests using this method return 4xx errors.
+
+### Invoking authentication-protected endpoints
+
+Once authenticated, you can invoke protected endpoints. Here's an example of retrieving user details and listing projects:
 
-    // Now that we're authenticated, we can invoke methods on any services.
-    // Here we're invoking the `getUserMe()` method on the `users` service
+```javascript
+import { DevopnessApiClient } from '@devopness/sdk-js'
+
+const devopnessApi = new DevopnessApiClient({
+  apiToken: process.env.DEVOPNESS_API_TOKEN
+});
+
+async function getUserProfile() {
+  try {
+    // Retrieve current user details
     const currentUser = await devopnessApi.users.getUserMe();
-    console.log('Successfully retrieved user profile: ', currentUser);
+    console.log('User ID:', currentUser.data.id);
+  } catch (error) {
+    console.error('Error:', error.message);
+  }
 }
 
 getUserProfile();
 ```
 
 ### TypeScript support
+
 This package includes TypeScript declarations for every method.
 TypeScript versions `>= 4.4` 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're 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. It can be installed with the following command:
+
   ```
   xcode-select --install
   ```
+
 ### Setup and run in local environment
+
 #### 1. Navigate to the project directory
+
 ```shell
 cd packages/sdks/javascript/
 ```
 
 #### 2. Build Docker Image
+
 ```
 make build-image
 ```
 
 #### 3. Install Dependencies
+
 ```
 make npm-ci
 ```
 
 #### 4. Build SDK
+
 ```
 make build-sdk-js
 ```
 
 #### 5. Run Tests
+
 ```
 make test
 ```
 
 ### Without Docker
+
 Installing on ``Linux`` or ``macOS`` systems.
 
 #### 1. Navigate to the project directory
+
 ```shell
 cd packages/sdks/javascript/
 ```
 
 #### 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.
+
 ```
 npm install
 ```
 
 #### 3. Build SDK
+
 ```
 npm run build
 ```
 
 #### 4. Run tests
+
 ```
 npm run test
 ```

package/dist/api/generated/apis/cron-jobs-api.d.ts

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { CronJob } from '../../generated/models';
+import { CronJobDeploy } from '../../generated/models';
 import { CronJobEnvironmentCreate } from '../../generated/models';
 import { CronJobRelation } from '../../generated/models';
 import { CronJobUpdate } from '../../generated/models';
@@ -32,6 +33,13 @@ export declare class CronJobsApiService extends ApiBaseService {
      * @param {number} cronJobId The ID of the cron job.
      */
     deleteCronJob(cronJobId: number): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Deploy a Cron Job
+     * @param {number} cronJobId The ID of the cron job.
+     * @param {CronJobDeploy} cronJobDeploy A JSON object containing the resource data
+     */
+    deployCronJob(cronJobId: number, cronJobDeploy: CronJobDeploy): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Get a Cron Job by ID

package/dist/api/generated/apis/cron-jobs-api.js

@@ -65,6 +65,26 @@ class CronJobsApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Deploy a Cron Job
+     * @param {number} cronJobId The ID of the cron job.
+     * @param {CronJobDeploy} cronJobDeploy A JSON object containing the resource data
+     */
+    deployCronJob(cronJobId, cronJobDeploy) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (cronJobId === null || cronJobId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('cronJobId', 'deployCronJob');
+            }
+            if (cronJobDeploy === null || cronJobDeploy === undefined) {
+                throw new Exceptions_1.ArgumentNullException('cronJobDeploy', 'deployCronJob');
+            }
+            let queryString = '';
+            const requestUrl = '/cron-jobs/{cron_job_id}/deploy' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"cron_job_id"}}`, encodeURIComponent(String(cronJobId))), cronJobDeploy);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Get a Cron Job by ID

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

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { Daemon } from '../../generated/models';
+import { DaemonDeploy } from '../../generated/models';
 import { DaemonEnvironmentCreate } from '../../generated/models';
 import { DaemonGetStatus } from '../../generated/models';
 import { DaemonRelation } from '../../generated/models';
@@ -36,6 +37,13 @@ export declare class DaemonsApiService extends ApiBaseService {
      * @param {number} daemonId The ID of the daemon.
      */
     deleteDaemon(daemonId: number): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Deploy a Daemon
+     * @param {number} daemonId The ID of the daemon.
+     * @param {DaemonDeploy} daemonDeploy A JSON object containing the resource data
+     */
+    deployDaemon(daemonId: number, daemonDeploy: DaemonDeploy): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Get a Daemon by ID

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

@@ -65,6 +65,26 @@ class DaemonsApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Deploy a Daemon
+     * @param {number} daemonId The ID of the daemon.
+     * @param {DaemonDeploy} daemonDeploy A JSON object containing the resource data
+     */
+    deployDaemon(daemonId, daemonDeploy) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (daemonId === null || daemonId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('daemonId', 'deployDaemon');
+            }
+            if (daemonDeploy === null || daemonDeploy === undefined) {
+                throw new Exceptions_1.ArgumentNullException('daemonDeploy', 'deployDaemon');
+            }
+            let queryString = '';
+            const requestUrl = '/daemons/{daemon_id}/deploy' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"daemon_id"}}`, encodeURIComponent(String(daemonId))), daemonDeploy);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Get a Daemon by ID

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

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { NetworkRule } from '../../generated/models';
+import { NetworkRuleDeploy } from '../../generated/models';
 import { NetworkRuleEnvironmentCreate } from '../../generated/models';
 import { NetworkRuleRelation } from '../../generated/models';
 import { NetworkRuleUpdate } from '../../generated/models';
@@ -32,6 +33,13 @@ export declare class NetworkRulesApiService extends ApiBaseService {
      * @param {number} networkRuleId The ID of the network rule.
      */
     deleteNetworkRule(networkRuleId: number): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Deploy a Network Rule
+     * @param {number} networkRuleId The ID of the network rule.
+     * @param {NetworkRuleDeploy} networkRuleDeploy A JSON object containing the resource data
+     */
+    deployNetworkRule(networkRuleId: number, networkRuleDeploy: NetworkRuleDeploy): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Get a Network Rule by ID

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

@@ -65,6 +65,26 @@ class NetworkRulesApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Deploy a Network Rule
+     * @param {number} networkRuleId The ID of the network rule.
+     * @param {NetworkRuleDeploy} networkRuleDeploy A JSON object containing the resource data
+     */
+    deployNetworkRule(networkRuleId, networkRuleDeploy) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (networkRuleId === null || networkRuleId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('networkRuleId', 'deployNetworkRule');
+            }
+            if (networkRuleDeploy === null || networkRuleDeploy === undefined) {
+                throw new Exceptions_1.ArgumentNullException('networkRuleDeploy', 'deployNetworkRule');
+            }
+            let queryString = '';
+            const requestUrl = '/network-rules/{network_rule_id}/deploy' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"network_rule_id"}}`, encodeURIComponent(String(networkRuleId))), networkRuleDeploy);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Get a Network Rule by ID

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

@@ -41,6 +41,12 @@ export declare class ServersApiService extends ApiBaseService {
      * @param {boolean} [destroyServerDisks] Indicates whether disks associated with a cloud server should be deleted after the server is destroyed
      */
     deleteServer(serverId: number, destroyServerDisks?: boolean): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Deploy a Server
+     * @param {number} serverId The ID of the server.
+     */
+    deployServer(serverId: number): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Get a server by ID

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

@@ -93,6 +93,22 @@ class ServersApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Deploy a Server
+     * @param {number} serverId The ID of the server.
+     */
+    deployServer(serverId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (serverId === null || serverId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('serverId', 'deployServer');
+            }
+            let queryString = '';
+            const requestUrl = '/servers/{server_id}/deploy' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"server_id"}}`, encodeURIComponent(String(serverId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Get a server by ID

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

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { Service } from '../../generated/models';
+import { ServiceDeploy } from '../../generated/models';
 import { ServiceEnvironmentCreate } from '../../generated/models';
 import { ServiceGetStatus } from '../../generated/models';
 import { ServiceRelation } from '../../generated/models';
@@ -37,6 +38,13 @@ export declare class ServicesApiService extends ApiBaseService {
      * @param {number} serviceId The ID of the service.
      */
     deleteService(serviceId: number): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Deploy a Service
+     * @param {number} serviceId The ID of the service.
+     * @param {ServiceDeploy} serviceDeploy A JSON object containing the resource data
+     */
+    deployService(serviceId: number, serviceDeploy: ServiceDeploy): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Get details of a single service

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

@@ -65,6 +65,26 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Deploy a Service
+     * @param {number} serviceId The ID of the service.
+     * @param {ServiceDeploy} serviceDeploy A JSON object containing the resource data
+     */
+    deployService(serviceId, serviceDeploy) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (serviceId === null || serviceId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('serviceId', 'deployService');
+            }
+            if (serviceDeploy === null || serviceDeploy === undefined) {
+                throw new Exceptions_1.ArgumentNullException('serviceDeploy', 'deployService');
+            }
+            let queryString = '';
+            const requestUrl = '/services/{service_id}/deploy' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"service_id"}}`, encodeURIComponent(String(serviceId))), serviceDeploy);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Get details of a single service

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

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { SshKey } from '../../generated/models';
+import { SshKeyDeploy } from '../../generated/models';
 import { SshKeyEnvironmentCreate } from '../../generated/models';
 import { SshKeyRelation } from '../../generated/models';
 import { SshKeyUpdate } from '../../generated/models';
@@ -32,6 +33,13 @@ export declare class SSHKeysApiService extends ApiBaseService {
      * @param {number} sshKeyId The ID of the ssh key.
      */
     deleteSshKey(sshKeyId: number): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Deploy a SSH Key
+     * @param {number} sshKeyId The ID of the ssh key.
+     * @param {SshKeyDeploy} sshKeyDeploy A JSON object containing the resource data
+     */
+    deploySshKey(sshKeyId: number, sshKeyDeploy: SshKeyDeploy): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Get a SSH key by ID

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

@@ -65,6 +65,26 @@ class SSHKeysApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Deploy a SSH Key
+     * @param {number} sshKeyId The ID of the ssh key.
+     * @param {SshKeyDeploy} sshKeyDeploy A JSON object containing the resource data
+     */
+    deploySshKey(sshKeyId, sshKeyDeploy) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (sshKeyId === null || sshKeyId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('sshKeyId', 'deploySshKey');
+            }
+            if (sshKeyDeploy === null || sshKeyDeploy === undefined) {
+                throw new Exceptions_1.ArgumentNullException('sshKeyDeploy', 'deploySshKey');
+            }
+            let queryString = '';
+            const requestUrl = '/ssh-keys/{ssh_key_id}/deploy' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"ssh_key_id"}}`, encodeURIComponent(String(sshKeyId))), sshKeyDeploy);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Get a SSH key by ID

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

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { SslCertificate } from '../../generated/models';
+import { SslCertificateDeploy } from '../../generated/models';
 import { SslCertificateEnvironmentCreate } from '../../generated/models';
 import { SslCertificateRelation } from '../../generated/models';
 /**
@@ -31,6 +32,13 @@ export declare class SSLCertificatesApiService extends ApiBaseService {
      * @param {number} sslCertificateId The ID of the ssl certificate.
      */
     deleteSslCertificate(sslCertificateId: number): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Deploy a SSL Certificate
+     * @param {number} sslCertificateId The ID of the ssl certificate.
+     * @param {SslCertificateDeploy} sslCertificateDeploy A JSON object containing the resource data
+     */
+    deploySslCertificate(sslCertificateId: number, sslCertificateDeploy: SslCertificateDeploy): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Get details of a single SSL certificate

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

@@ -65,6 +65,26 @@ class SSLCertificatesApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Deploy a SSL Certificate
+     * @param {number} sslCertificateId The ID of the ssl certificate.
+     * @param {SslCertificateDeploy} sslCertificateDeploy A JSON object containing the resource data
+     */
+    deploySslCertificate(sslCertificateId, sslCertificateDeploy) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (sslCertificateId === null || sslCertificateId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('sslCertificateId', 'deploySslCertificate');
+            }
+            if (sslCertificateDeploy === null || sslCertificateDeploy === undefined) {
+                throw new Exceptions_1.ArgumentNullException('sslCertificateDeploy', 'deploySslCertificate');
+            }
+            let queryString = '';
+            const requestUrl = '/ssl-certificates/{ssl_certificate_id}/deploy' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"ssl_certificate_id"}}`, encodeURIComponent(String(sslCertificateId))), sslCertificateDeploy);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Get details of a single SSL certificate

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

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { Subnet } from '../../generated/models';
+import { SubnetRelation } from '../../generated/models';
 /**
  * SubnetsApiService - Auto-generated
  */
@@ -28,4 +29,12 @@ export declare class SubnetsApiService extends ApiBaseService {
      * @param {number} subnetId The ID of the subnet.
      */
     getSubnet(subnetId: number): Promise<ApiResponse<Subnet>>;
+    /**
+     *
+     * @summary Return a list of all subnets belonging to an environment
+     * @param {number} environmentId The ID of the environment.
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listEnvironmentSubnets(environmentId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<SubnetRelation>>>;
 }

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

@@ -61,5 +61,30 @@ class SubnetsApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Return a list of all subnets belonging to an environment
+     * @param {number} environmentId The ID of the environment.
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listEnvironmentSubnets(environmentId, page, perPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (environmentId === null || environmentId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('environmentId', 'listEnvironmentSubnets');
+            }
+            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 = '/environments/{environment_id}/subnets' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
 }
 exports.SubnetsApiService = SubnetsApiService;

package/dist/api/generated/apis/virtual-hosts-api.d.ts

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { VirtualHost } from '../../generated/models';
+import { VirtualHostDeploy } from '../../generated/models';
 import { VirtualHostEnvironmentCreate } from '../../generated/models';
 import { VirtualHostGetStatus } from '../../generated/models';
 import { VirtualHostRelation } from '../../generated/models';
@@ -33,6 +34,13 @@ export declare class VirtualHostsApiService extends ApiBaseService {
      * @param {number} virtualHostId The ID of the virtual host.
      */
     deleteVirtualHost(virtualHostId: number): Promise<ApiResponse<void>>;
+    /**
+     *
+     * @summary Deploy a Virtual Host
+     * @param {number} virtualHostId The ID of the virtual host.
+     * @param {VirtualHostDeploy} virtualHostDeploy A JSON object containing the resource data
+     */
+    deployVirtualHost(virtualHostId: number, virtualHostDeploy: VirtualHostDeploy): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Get current status of a virtual host

package/dist/api/generated/apis/virtual-hosts-api.js

@@ -65,6 +65,26 @@ class VirtualHostsApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Deploy a Virtual Host
+     * @param {number} virtualHostId The ID of the virtual host.
+     * @param {VirtualHostDeploy} virtualHostDeploy A JSON object containing the resource data
+     */
+    deployVirtualHost(virtualHostId, virtualHostDeploy) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (virtualHostId === null || virtualHostId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('virtualHostId', 'deployVirtualHost');
+            }
+            if (virtualHostDeploy === null || virtualHostDeploy === undefined) {
+                throw new Exceptions_1.ArgumentNullException('virtualHostDeploy', 'deployVirtualHost');
+            }
+            let queryString = '';
+            const requestUrl = '/virtual-hosts/{virtual_host_id}/deploy' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"virtual_host_id"}}`, encodeURIComponent(String(virtualHostId))), virtualHostDeploy);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Get current status of a virtual host

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

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CronJobDeploy
+ */
+export interface CronJobDeploy {
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof CronJobDeploy
+     */
+    servers?: Array<number>;
+}

package/dist/api/generated/models/cron-job-deploy.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-deploy.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface DaemonDeploy
+ */
+export interface DaemonDeploy {
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof DaemonDeploy
+     */
+    servers?: Array<number>;
+}

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

@@ -84,12 +84,14 @@ export * from './credential-source-provider';
 export * from './credential-update';
 export * from './credits';
 export * from './cron-job';
+export * from './cron-job-deploy';
 export * from './cron-job-environment-create';
 export * from './cron-job-options';
 export * from './cron-job-pattern';
 export * from './cron-job-relation';
 export * from './cron-job-update';
 export * from './daemon';
+export * from './daemon-deploy';
 export * from './daemon-environment-create';
 export * from './daemon-get-status';
 export * from './daemon-relation';
@@ -148,6 +150,7 @@ export * from './network-provision-input-settings-digital-ocean';
 export * from './network-provision-input-settings-gcp';
 export * from './network-relation';
 export * from './network-rule';
+export * from './network-rule-deploy';
 export * from './network-rule-direction';
 export * from './network-rule-environment-create';
 export * from './network-rule-options';
@@ -227,6 +230,7 @@ export * from './server-relation';
 export * from './server-status';
 export * from './server-update';
 export * from './service';
+export * from './service-deploy';
 export * from './service-environment-create';
 export * from './service-get-status';
 export * from './service-initial-state';
@@ -248,10 +252,12 @@ export * from './source-provider-displayable-name';
 export * from './source-provider-name';
 export * from './source-type';
 export * from './ssh-key';
+export * from './ssh-key-deploy';
 export * from './ssh-key-environment-create';
 export * from './ssh-key-relation';
 export * from './ssh-key-update';
 export * from './ssl-certificate';
+export * from './ssl-certificate-deploy';
 export * from './ssl-certificate-environment-create';
 export * from './ssl-certificate-issuer';
 export * from './ssl-certificate-relation';
@@ -324,6 +330,7 @@ export * from './variable-targets';
 export * from './variable-type';
 export * from './variable-update';
 export * from './virtual-host';
+export * from './virtual-host-deploy';
 export * from './virtual-host-environment-create';
 export * from './virtual-host-get-status';
 export * from './virtual-host-options';

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

@@ -100,12 +100,14 @@ __exportStar(require("./credential-source-provider"), exports);
 __exportStar(require("./credential-update"), exports);
 __exportStar(require("./credits"), exports);
 __exportStar(require("./cron-job"), exports);
+__exportStar(require("./cron-job-deploy"), exports);
 __exportStar(require("./cron-job-environment-create"), exports);
 __exportStar(require("./cron-job-options"), exports);
 __exportStar(require("./cron-job-pattern"), exports);
 __exportStar(require("./cron-job-relation"), exports);
 __exportStar(require("./cron-job-update"), exports);
 __exportStar(require("./daemon"), exports);
+__exportStar(require("./daemon-deploy"), exports);
 __exportStar(require("./daemon-environment-create"), exports);
 __exportStar(require("./daemon-get-status"), exports);
 __exportStar(require("./daemon-relation"), exports);
@@ -164,6 +166,7 @@ __exportStar(require("./network-provision-input-settings-digital-ocean"), export
 __exportStar(require("./network-provision-input-settings-gcp"), exports);
 __exportStar(require("./network-relation"), exports);
 __exportStar(require("./network-rule"), exports);
+__exportStar(require("./network-rule-deploy"), exports);
 __exportStar(require("./network-rule-direction"), exports);
 __exportStar(require("./network-rule-environment-create"), exports);
 __exportStar(require("./network-rule-options"), exports);
@@ -243,6 +246,7 @@ __exportStar(require("./server-relation"), exports);
 __exportStar(require("./server-status"), exports);
 __exportStar(require("./server-update"), exports);
 __exportStar(require("./service"), exports);
+__exportStar(require("./service-deploy"), exports);
 __exportStar(require("./service-environment-create"), exports);
 __exportStar(require("./service-get-status"), exports);
 __exportStar(require("./service-initial-state"), exports);
@@ -264,10 +268,12 @@ __exportStar(require("./source-provider-displayable-name"), exports);
 __exportStar(require("./source-provider-name"), exports);
 __exportStar(require("./source-type"), exports);
 __exportStar(require("./ssh-key"), exports);
+__exportStar(require("./ssh-key-deploy"), exports);
 __exportStar(require("./ssh-key-environment-create"), exports);
 __exportStar(require("./ssh-key-relation"), exports);
 __exportStar(require("./ssh-key-update"), exports);
 __exportStar(require("./ssl-certificate"), exports);
+__exportStar(require("./ssl-certificate-deploy"), exports);
 __exportStar(require("./ssl-certificate-environment-create"), exports);
 __exportStar(require("./ssl-certificate-issuer"), exports);
 __exportStar(require("./ssl-certificate-relation"), exports);
@@ -340,6 +346,7 @@ __exportStar(require("./variable-targets"), exports);
 __exportStar(require("./variable-type"), exports);
 __exportStar(require("./variable-update"), exports);
 __exportStar(require("./virtual-host"), exports);
+__exportStar(require("./virtual-host-deploy"), exports);
 __exportStar(require("./virtual-host-environment-create"), exports);
 __exportStar(require("./virtual-host-get-status"), exports);
 __exportStar(require("./virtual-host-options"), exports);

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

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface NetworkRuleDeploy
+ */
+export interface NetworkRuleDeploy {
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof NetworkRuleDeploy
+     */
+    servers?: Array<number>;
+}

package/dist/api/generated/models/network-rule-deploy.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/service-deploy.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ServiceDeploy
+ */
+export interface ServiceDeploy {
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof ServiceDeploy
+     */
+    servers?: Array<number>;
+}

package/dist/api/generated/models/service-deploy.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/ssh-key-deploy.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface SshKeyDeploy
+ */
+export interface SshKeyDeploy {
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof SshKeyDeploy
+     */
+    servers?: Array<number>;
+}

package/dist/api/generated/models/ssh-key-deploy.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/ssl-certificate-deploy.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface SslCertificateDeploy
+ */
+export interface SslCertificateDeploy {
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof SslCertificateDeploy
+     */
+    servers?: Array<number>;
+}

package/dist/api/generated/models/ssl-certificate-deploy.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/subnet-relation.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { NetworkRelation } from './network-relation';
 import { SubnetProvisionInput } from './subnet-provision-input';
 import { SubnetType } from './subnet-type';
 /**
@@ -42,11 +43,11 @@ export interface SubnetRelation {
      */
     created_by: number;
     /**
-     * Numeric ID of the network to which the subnet belongs to
-     * @type {number}
+     *
+     * @type {NetworkRelation}
      * @memberof SubnetRelation
      */
-    network_id: number;
+    network: NetworkRelation | null;
     /**
      * The subnet\'s name
      * @type {string}

package/dist/api/generated/models/virtual-host-deploy.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface VirtualHostDeploy
+ */
+export interface VirtualHostDeploy {
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof VirtualHostDeploy
+     */
+    servers?: Array<number>;
+}

package/dist/api/generated/models/virtual-host-deploy.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/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@devopness/sdk-js",
-  "version": "3.1.10",
+  "version": "3.2.1",
   "publishConfig": {
     "access": "public"
   },
@@ -52,11 +52,11 @@
   "homepage": "https://github.com/devopness/devopness#readme",
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@openapitools/openapi-generator-cli": "^2.28.3",
+    "@openapitools/openapi-generator-cli": "^2.30.0",
     "@types/jest": "^30.0.0",
-    "@typescript-eslint/parser": "^8.54.0",
+    "@typescript-eslint/parser": "^8.56.0",
     "axios-mock-adapter": "^2.1.0",
-    "eslint": "^10.0.0",
+    "eslint": "^10.0.2",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-n": "^17.24.0",
@@ -66,11 +66,11 @@
     "ts-jest": "^29.4.5",
     "typedoc": "^0.28.17",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.55.0"
+    "typescript-eslint": "^8.56.1"
   },
   "dependencies": {
     "@types/parse-link-header": "^2.0.3",
-    "axios": "^1.13.4",
+    "axios": "^1.13.6",
     "parse-link-header": "^2.0.0"
   }
 }