@devopness/sdk-js 1.104.0 → 1.105.0

package/README.md

@@ -20,7 +20,7 @@ yarn add @devopness/sdk-js
 
 ### Initializing
 
-To initialize the usage of Devopness SDK just import it and create a new instance of `DevopnessApiClient` class.
+To initialize the usage of Devopness SDK, just import it and create a new instance of `DevopnessApiClient` class.
 
 Here is a generic simple example that can be used from `Node.js`, `TypeScript` or `Javascript` applications:
 
@@ -30,8 +30,8 @@ const devopnessApi = new DevopnessApiClient();
 ```
 
 The instance of `DevopnessApiClient` has properties to all services provided by the API.
-The name of the methods at services is the same as operation name in the documentation of the
-Devopness API. You can consult the URL of a endpoint to see the operation name. For instance
+The name of the methods at services is the same as the operation name in the documentation of the
+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
@@ -49,7 +49,7 @@ async function authenticate(email, pass) {
 authenticate('user@email.com', 'secret-password');
 ```
 
-In the example above, `userTokens` is a instance of `ApiResponse` and the `data` property has the data requested from the API. See [ApiResponse.ts](https://github.com/devopness/devopness/blob/master/src/common/ApiResponse.ts) for reference.
+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/master/src/common/ApiResponse.ts) for reference.
 
 ### Invoking authentication protected endpoints
 Once an authentication token is set, any protected endpoint can be invoked.
@@ -74,7 +74,7 @@ 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.
 
 ## Building and testing
 To build and test the SDK locally, follow these steps:

package/dist/api/generated/apis/applications-hooks-api.d.ts

@@ -18,7 +18,7 @@ import { HookRelation } from '../../generated/models';
 export declare class ApplicationsHooksApiService extends ApiBaseService {
     /**
      *
-     * @summary Returns a list of all incoming hooks belonging to an application
+     * @summary Returns a list of all hooks belonging to an application
      * @param {number} applicationId Unique id of the application
      */
     listApplicationHooks(applicationId: number): Promise<ApiResponse<Array<HookRelation>>>;

package/dist/api/generated/apis/applications-hooks-api.js

@@ -31,7 +31,7 @@ const Exceptions_1 = require("../../../common/Exceptions");
 class ApplicationsHooksApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
-     * @summary Returns a list of all incoming hooks belonging to an application
+     * @summary Returns a list of all hooks belonging to an application
      * @param {number} applicationId Unique id of the application
      */
     listApplicationHooks(applicationId) {

package/dist/api/generated/apis/static-data-api.d.ts

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { ApplicationOptions } from '../../generated/models';
+import { CloudProvider } from '../../generated/models';
 import { CronJobOptions } from '../../generated/models';
 import { EnvironmentOptions } from '../../generated/models';
 import { ServerOptions } from '../../generated/models';
@@ -25,6 +26,11 @@ export declare class StaticDataApiService extends ApiBaseService {
      * @summary Lists options of the applications
      */
     listApplicationOptions(): Promise<ApiResponse<ApplicationOptions>>;
+    /**
+     *
+     * @summary Lists cloud providers
+     */
+    listCloudProviders(): Promise<ApiResponse<Array<CloudProvider>>>;
     /**
      *
      * @summary Lists options of the cronjobs

package/dist/api/generated/apis/static-data-api.js

@@ -40,6 +40,18 @@ class StaticDataApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Lists cloud providers
+     */
+    listCloudProviders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let queryString = '';
+            const requestUrl = '/static/cloud-providers' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Lists options of the cronjobs

package/dist/api/generated/models/cloud-provider.d.ts

@@ -9,6 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { CloudProviderSettings } from './cloud-provider-settings';
+import { CloudService } from './cloud-service';
 /**
  *
  * @export
@@ -16,21 +18,39 @@
  */
 export interface CloudProvider {
     /**
-     * The code that uniquely identify a cloud provider
+     * Cloud provider code
      * @type {string}
      * @memberof CloudProvider
      */
     code: string;
     /**
-     * A URL path to the provider\'s logo image
+     * Cloud provider name
      * @type {string}
      * @memberof CloudProvider
      */
-    logo_url: string;
+    name: string;
     /**
-     * The name of the cloud provider
+     * Text describing what is the provider
      * @type {string}
      * @memberof CloudProvider
      */
-    name: string;
+    hint?: string;
+    /**
+     * The provider\'s logo URL.
+     * @type {string}
+     * @memberof CloudProvider
+     */
+    logo_url: string;
+    /**
+     *
+     * @type {Array<CloudService>}
+     * @memberof CloudProvider
+     */
+    cloud_services?: Array<CloudService>;
+    /**
+     *
+     * @type {CloudProviderSettings}
+     * @memberof CloudProvider
+     */
+    settings?: CloudProviderSettings;
 }

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

@@ -34,13 +34,13 @@ export interface CloudService {
      * @type {Array<ProviderRegion>}
      * @memberof CloudService
      */
-    regions: Array<ProviderRegion>;
+    regions?: Array<ProviderRegion>;
     /**
      *
      * @type {Array<OperatingSystem>}
      * @memberof CloudService
      */
-    os: Array<OperatingSystem>;
+    os?: Array<OperatingSystem>;
 }
 /**
     * @export

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

@@ -9,7 +9,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { ActionListItem } from './action-list-item';
 import { ActionRelation } from './action-relation';
 import { ActionStatus } from './action-status';
 import { EnvironmentRelation } from './environment-relation';
@@ -76,12 +75,6 @@ export interface Server {
      * @memberof Server
      */
     status?: ActionStatus;
-    /**
-     * The list of related actions
-     * @type {Array<ActionListItem>}
-     * @memberof Server
-     */
-    actions: Array<ActionListItem>;
     /**
      * The list of environments to which the server is linked to
      * @type {Array<EnvironmentRelation>}

package/dist/services/EnvironmentService.d.ts

@@ -1,4 +1,5 @@
 import { EnvironmentsApiService } from '../api/generated/apis/environments-api';
+import { EnvironmentsActionsApiService } from '../api/generated/apis/environments-actions-api';
 import { EnvironmentsApplicationsApiService } from '../api/generated/apis/environments-applications-api';
 import { EnvironmentsCronJobsApiService } from '../api/generated/apis/environments-cron-jobs-api';
 import { EnvironmentsDaemonsApiService } from '../api/generated/apis/environments-daemons-api';
@@ -9,6 +10,7 @@ import { EnvironmentsServicesApiService } from '../api/generated/apis/environmen
 import { EnvironmentsSSHKeysApiService } from '../api/generated/apis/environments-sshkeys-api';
 import { EnvironmentsTeamsApiService } from '../api/generated/apis/environments-teams-api';
 export declare class EnvironmentService extends EnvironmentsApiService {
+    actions: EnvironmentsActionsApiService;
     applications: EnvironmentsApplicationsApiService;
     cronjobs: EnvironmentsCronJobsApiService;
     daemons: EnvironmentsDaemonsApiService;

package/dist/services/EnvironmentService.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EnvironmentService = void 0;
 const environments_api_1 = require("../api/generated/apis/environments-api");
+const environments_actions_api_1 = require("../api/generated/apis/environments-actions-api");
 const environments_applications_api_1 = require("../api/generated/apis/environments-applications-api");
 const environments_cron_jobs_api_1 = require("../api/generated/apis/environments-cron-jobs-api");
 const environments_daemons_api_1 = require("../api/generated/apis/environments-daemons-api");
@@ -14,6 +15,7 @@ const environments_teams_api_1 = require("../api/generated/apis/environments-tea
 class EnvironmentService extends environments_api_1.EnvironmentsApiService {
     constructor() {
         super(...arguments);
+        this.actions = new environments_actions_api_1.EnvironmentsActionsApiService();
         this.applications = new environments_applications_api_1.EnvironmentsApplicationsApiService();
         this.cronjobs = new environments_cron_jobs_api_1.EnvironmentsCronJobsApiService();
         this.daemons = new environments_daemons_api_1.EnvironmentsDaemonsApiService();

package/dist/services/ProjectService.d.ts

@@ -1,4 +1,5 @@
 import { ProjectsApiService } from '../api/generated/apis/projects-api';
+import { ProjectsActionsApiService } from '../api/generated/apis/projects-actions-api';
 import { ProjectsApplicationsApiService } from '../api/generated/apis/projects-applications-api';
 import { ProjectsCronJobsApiService } from '../api/generated/apis/projects-cron-jobs-api';
 import { ProjectsEnvironmentsApiService } from '../api/generated/apis/projects-environments-api';
@@ -8,6 +9,7 @@ import { ProjectsServicesApiService } from '../api/generated/apis/projects-servi
 import { ProjectsSSHKeysApiService } from '../api/generated/apis/projects-sshkeys-api';
 import { ProjectsDaemonsApiService } from '../api/generated/apis/projects-daemons-api';
 export declare class ProjectService extends ProjectsApiService {
+    actions: ProjectsActionsApiService;
     applications: ProjectsApplicationsApiService;
     cronjobs: ProjectsCronJobsApiService;
     daemons: ProjectsDaemonsApiService;

package/dist/services/ProjectService.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectService = void 0;
 const projects_api_1 = require("../api/generated/apis/projects-api");
+const projects_actions_api_1 = require("../api/generated/apis/projects-actions-api");
 const projects_applications_api_1 = require("../api/generated/apis/projects-applications-api");
 const projects_cron_jobs_api_1 = require("../api/generated/apis/projects-cron-jobs-api");
 const projects_environments_api_1 = require("../api/generated/apis/projects-environments-api");
@@ -13,6 +14,7 @@ const projects_daemons_api_1 = require("../api/generated/apis/projects-daemons-a
 class ProjectService extends projects_api_1.ProjectsApiService {
     constructor() {
         super(...arguments);
+        this.actions = new projects_actions_api_1.ProjectsActionsApiService();
         this.applications = new projects_applications_api_1.ProjectsApplicationsApiService();
         this.cronjobs = new projects_cron_jobs_api_1.ProjectsCronJobsApiService();
         this.daemons = new projects_daemons_api_1.ProjectsDaemonsApiService();

package/package.json

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