@devopness/sdk-js 2.14.0 → 2.15.0

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

@@ -32,7 +32,7 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Delete a given service
-     * @param {number} serviceId The Id of the service to be deleted
+     * @param {number} serviceId The ID of the service.
      */
     deleteService(serviceId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -48,7 +48,7 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Get details of a single service
-     * @param {number} serviceId Unique ID of the service to get
+     * @param {number} serviceId The ID of the service.
      */
     getService(serviceId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -64,8 +64,8 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Reload a service
-     * @param {number} serviceId The unique id of the service
-     * @param {ServiceReload} serviceReload A JSON object containing the environment id
+     * @param {number} serviceId The ID of the service.
+     * @param {ServiceReload} serviceReload A JSON object containing the resource data
      */
     reloadService(serviceId, serviceReload) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -84,8 +84,8 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Restart a service
-     * @param {number} serviceId The unique id of the service
-     * @param {ServiceRestart} serviceRestart A JSON object containing the environment id
+     * @param {number} serviceId The ID of the service.
+     * @param {ServiceRestart} serviceRestart A JSON object containing the resource data
      */
     restartService(serviceId, serviceRestart) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -104,8 +104,8 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Start a service
-     * @param {number} serviceId The unique id of the service
-     * @param {ServiceStart} serviceStart A JSON object containing the environment id
+     * @param {number} serviceId The ID of the service.
+     * @param {ServiceStart} serviceStart A JSON object containing the resource data
      */
     startService(serviceId, serviceStart) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -124,8 +124,8 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Stop a service
-     * @param {number} serviceId The unique id of the service
-     * @param {ServiceStop} serviceStop A JSON object containing the environment id
+     * @param {number} serviceId The ID of the service.
+     * @param {ServiceStop} serviceStop A JSON object containing the resource data
      */
     stopService(serviceId, serviceStop) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -144,8 +144,8 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary Update an existing service
-     * @param {number} serviceId The unique id of the service
-     * @param {ServiceUpdate} serviceUpdate A JSON object containing service data
+     * @param {number} serviceId The ID of the service.
+     * @param {ServiceUpdate} serviceUpdate A JSON object containing the resource data
      */
     updateService(serviceId, serviceUpdate) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -162,22 +162,22 @@ class ServicesApiService extends ApiBaseService_1.ApiBaseService {
         });
     }
     /**
-     * Trigger a status update action for a service in all project servers asynchronously. To get the output of service status update action the endpoint [getServiceStatusLog](/#operation/getServiceStatusLog) should be invoked.
+     *
      * @summary Update status of a service
-     * @param {number} serviceId The unique id of the service
-     * @param {ServiceStatusUpdate} serviceStatusUpdate A JSON object containing the environment id
+     * @param {number} serviceId The ID of the service.
+     * @param {ServiceUpdateStatus} serviceUpdateStatus A JSON object containing the resource data
      */
-    updateServiceStatus(serviceId, serviceStatusUpdate) {
+    updateStatusService(serviceId, serviceUpdateStatus) {
         return __awaiter(this, void 0, void 0, function* () {
             if (serviceId === null || serviceId === undefined) {
-                throw new Exceptions_1.ArgumentNullException('serviceId', 'updateServiceStatus');
+                throw new Exceptions_1.ArgumentNullException('serviceId', 'updateStatusService');
             }
-            if (serviceStatusUpdate === null || serviceStatusUpdate === undefined) {
-                throw new Exceptions_1.ArgumentNullException('serviceStatusUpdate', 'updateServiceStatus');
+            if (serviceUpdateStatus === null || serviceUpdateStatus === undefined) {
+                throw new Exceptions_1.ArgumentNullException('serviceUpdateStatus', 'updateStatusService');
             }
             let queryString = '';
             const requestUrl = '/services/{service_id}/update-status' + (queryString ? `?${queryString}` : '');
-            const response = yield this.post(requestUrl.replace(`{${"service_id"}}`, encodeURIComponent(String(serviceId))), serviceStatusUpdate);
+            const response = yield this.post(requestUrl.replace(`{${"service_id"}}`, encodeURIComponent(String(serviceId))), serviceUpdateStatus);
             return new ApiResponse_1.ApiResponse(response);
         });
     }

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

@@ -0,0 +1,138 @@
+/**
+ * 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 ApplicationEnvironmentCreate
+ */
+export interface ApplicationEnvironmentCreate {
+    /**
+     * The application\'s unique name. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    name: string;
+    /**
+     * Must be one of <code>web</code> or <code>non-web</code>.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    type: string;
+    /**
+     * The domain or sub-domain through which the application deployed with these settings will be accessible. It can be a naked domain or any subdomain. If app has domain names `testing.my-app.com`, `staging.my-app.com` and `www.my-app.com` a possible good candidate for the application name would be the \"naked\" domain `my-app.com`. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    domain_name?: string;
+    /**
+     * The optional command that should be executed once during deployment to build the source code and get the application in a ready state. Must be at least 10 characters. Must not be greater than 300 characters.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    build_command?: string;
+    /**
+     * The language runtime engine version to be used to execute this application on the deployed servers. This field is required unless <code>programming_language</code> is in <code>html</code>.  Must be one of <code></code> Must be at least 1 characters. Must not be greater than 10 characters.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    engine_version?: string;
+    /**
+     * The base framework on top of which the application has been implemented - it might have impact on the steps to be performed during application deployment. Must not be greater than 30 characters.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    framework: string;
+    /**
+     * The programming language runtime environment to be used to serve the application. E.g.: if a front-end web app is developed using Node.js, but should be served statically (a SPA application, for instance) then this field value should be `html`. Must be one of <code>docker</code>, <code>dotnetcore</code>, <code>html</code>, <code>nodejs</code>, <code>php</code>, or <code>python</code> Must not be greater than 30 characters.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    programming_language: string;
+    /**
+     * Required for CGI|FastCGI|SCGI|WSGI based applications or `docker` containerized applications. It tells `devopness` the private address at which the application listens to external calls.The address has `http` or `https` protocol, an domain name or IP address, optional port and optional path. Or you can specify a UNIX-socket using `unix:` prefix after protocol.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    listening_address?: string;
+    /**
+     * The full name of a repository (`repository_owner/repository_name`) containing the application source code. Required when the `source_provider_id` field is informed. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    repository: string;
+    /**
+     * Numeric ID of the source provider account where the repository is hosted. Required when the `repository` field is informed.
+     * @type {number}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    source_provider_id: number;
+    /**
+     * The relative directory where package manager\'s manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code>.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    root_directory?: string;
+    /**
+     * The relative web directory where publicly accessible assets are located and the web content should be served from. Must start with one of <code>/</code>.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    public_directory: string;
+    /**
+     * The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed. Must not be greater than 100 characters.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    default_branch: string;
+    /**
+     * The number of deployment history, logs and artifacts to keep stored in both devopness servers and user\'s servers. OR The number of deployment artifacts to be retained in the user\'s servers, making it easier and faster to rollback to previous versions. Must be at least 1. Must not be greater than 10.
+     * @type {number}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    deployments_keep?: number;
+    /**
+     * The entrypoint tells devopness how an application should be started and has basically two forms: 1) `File`: if it\'s a simple file name/path a web app will be served using the entrypoint value as its index file. Example: `index.html` 2) `Command`: if a command line instruction is provided as the entrypoint value, it will be handled as the start up command that initializes the application. It will be assumed that the user is an advanced user that knows what she/he is doing, therefore the command specified here will be run - as is - every time the application needs to be started. Must not be greater than 120 characters.
+     * @type {string}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    entrypoint: string;
+    /**
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in development mode.
+     * @type {boolean}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    install_dependencies_dev: boolean;
+    /**
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in production mode.
+     * @type {boolean}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    install_dependencies_prod: boolean;
+    /**
+     * Indicates if push to deploy webhooks are enabled for this application. If enabled an app deployment will be automatically triggered when new changes are committed to the `default_branch`.
+     * @type {boolean}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    push_to_deploy?: boolean;
+    /**
+     * Indicates if the application requires a daemon to keep it alive.
+     * @type {boolean}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    requires_daemon: boolean;
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof ApplicationEnvironmentCreate
+     */
+    servers?: Array<number>;
+}

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

@@ -22,6 +22,7 @@ export * from './api-error-errors-field-name';
 export * from './application';
 export * from './application-create';
 export * from './application-deployment';
+export * from './application-environment-create';
 export * from './application-last-deployment';
 export * from './application-last-deployments';
 export * from './application-options';
@@ -156,7 +157,6 @@ export * from './server-provision-settings';
 export * from './server-relation';
 export * from './server-update';
 export * from './service';
-export * from './service-action';
 export * from './service-create';
 export * from './service-initial-state';
 export * from './service-name';
@@ -165,11 +165,11 @@ export * from './service-relation';
 export * from './service-reload';
 export * from './service-restart';
 export * from './service-start';
-export * from './service-status-update';
 export * from './service-stop';
 export * from './service-type';
 export * from './service-type-supported-versions';
 export * from './service-update';
+export * from './service-update-status';
 export * from './social-account';
 export * from './social-account-create';
 export * from './social-account-displayable-name';
@@ -181,6 +181,7 @@ export * from './source-provider-displayable-name';
 export * from './source-provider-name';
 export * from './ssh-key';
 export * from './ssh-key-create';
+export * from './ssh-key-project-create';
 export * from './ssh-key-relation';
 export * from './ssh-key-update';
 export * from './ssl-certificate';

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

@@ -38,6 +38,7 @@ __exportStar(require("./api-error-errors-field-name"), exports);
 __exportStar(require("./application"), exports);
 __exportStar(require("./application-create"), exports);
 __exportStar(require("./application-deployment"), exports);
+__exportStar(require("./application-environment-create"), exports);
 __exportStar(require("./application-last-deployment"), exports);
 __exportStar(require("./application-last-deployments"), exports);
 __exportStar(require("./application-options"), exports);
@@ -172,7 +173,6 @@ __exportStar(require("./server-provision-settings"), exports);
 __exportStar(require("./server-relation"), exports);
 __exportStar(require("./server-update"), exports);
 __exportStar(require("./service"), exports);
-__exportStar(require("./service-action"), exports);
 __exportStar(require("./service-create"), exports);
 __exportStar(require("./service-initial-state"), exports);
 __exportStar(require("./service-name"), exports);
@@ -181,11 +181,11 @@ __exportStar(require("./service-relation"), exports);
 __exportStar(require("./service-reload"), exports);
 __exportStar(require("./service-restart"), exports);
 __exportStar(require("./service-start"), exports);
-__exportStar(require("./service-status-update"), exports);
 __exportStar(require("./service-stop"), exports);
 __exportStar(require("./service-type"), exports);
 __exportStar(require("./service-type-supported-versions"), exports);
 __exportStar(require("./service-update"), exports);
+__exportStar(require("./service-update-status"), exports);
 __exportStar(require("./social-account"), exports);
 __exportStar(require("./social-account-create"), exports);
 __exportStar(require("./social-account-displayable-name"), exports);
@@ -197,6 +197,7 @@ __exportStar(require("./source-provider-displayable-name"), exports);
 __exportStar(require("./source-provider-name"), exports);
 __exportStar(require("./ssh-key"), exports);
 __exportStar(require("./ssh-key-create"), exports);
+__exportStar(require("./ssh-key-project-create"), exports);
 __exportStar(require("./ssh-key-relation"), exports);
 __exportStar(require("./ssh-key-update"), exports);
 __exportStar(require("./ssl-certificate"), exports);

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

@@ -23,6 +23,12 @@ export interface ServerRelation {
      * @memberof ServerRelation
      */
     id: number;
+    /**
+     * The id of the user who created the server and to whom the server belongs
+     * @type {number}
+     * @memberof ServerRelation
+     */
+    created_by: number;
     /**
      * The server\'s name
      * @type {string}
@@ -35,6 +41,18 @@ export interface ServerRelation {
      * @memberof ServerRelation
      */
     hostname: string;
+    /**
+     * strubg The name of the server\'s provider.
+     * @type {string}
+     * @memberof ServerRelation
+     */
+    provider_name: string;
+    /**
+     * The human readable version of the provider\'s name
+     * @type {string}
+     * @memberof ServerRelation
+     */
+    provider_name_human_readable: string;
     /**
      * Public ipv4 address for server access
      * @type {string}
@@ -47,12 +65,6 @@ export interface ServerRelation {
      * @memberof ServerRelation
      */
     ssh_port: number;
-    /**
-     * The id of the user who created the server and to whom the server belongs
-     * @type {number}
-     * @memberof ServerRelation
-     */
-    created_by: number;
     /**
      * Tells if the server is active or not
      * @type {boolean}
@@ -64,35 +76,23 @@ export interface ServerRelation {
      * @type {ActionStatus}
      * @memberof ServerRelation
      */
-    status?: ActionStatus;
-    /**
-     * The name of the server\'s provider.
-     * @type {string}
-     * @memberof ServerRelation
-     */
-    provider_name?: string;
-    /**
-     * The human readable version of the provider\'s name
-     * @type {string}
-     * @memberof ServerRelation
-     */
-    provider_name_human_readable?: string;
+    status: ActionStatus;
     /**
      *
      * @type {ActionRelation}
      * @memberof ServerRelation
      */
-    last_action?: ActionRelation | null;
+    last_action: ActionRelation | null;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof ServerRelation
      */
-    created_at?: string;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof ServerRelation
      */
-    updated_at?: string;
+    updated_at: string;
 }

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

@@ -27,6 +27,12 @@ export interface Server {
      * @memberof Server
      */
     id: number;
+    /**
+     * The id of the user who created the server and to whom the server belongs
+     * @type {number}
+     * @memberof Server
+     */
+    created_by: number;
     /**
      * The server\'s name
      * @type {string}
@@ -39,6 +45,18 @@ export interface Server {
      * @memberof Server
      */
     hostname: string;
+    /**
+     * The name of the server\'s provider.
+     * @type {string}
+     * @memberof Server
+     */
+    provider_name: string;
+    /**
+     * The human readable version of the provider\'s name
+     * @type {string}
+     * @memberof Server
+     */
+    provider_name_human_readable: string;
     /**
      * Public ipv4 address for server access
      * @type {string}
@@ -51,12 +69,6 @@ export interface Server {
      * @memberof Server
      */
     ssh_port: number;
-    /**
-     * The id of the user who created the server and to whom the server belongs
-     * @type {number}
-     * @memberof Server
-     */
-    created_by: number;
     /**
      * Tells if the server is active or not
      * @type {boolean}
@@ -65,22 +77,22 @@ export interface Server {
     active: boolean;
     /**
      *
-     * @type {ServerBlueprint}
+     * @type {ActionStatus}
      * @memberof Server
      */
-    blueprint: ServerBlueprint;
+    status: ActionStatus;
     /**
      *
-     * @type {ActionStatus}
+     * @type {ServerBlueprint}
      * @memberof Server
      */
-    status?: ActionStatus;
+    blueprint: ServerBlueprint;
     /**
-     * The list of environments to which the server is linked to
-     * @type {Array<EnvironmentRelation>}
+     *
+     * @type {UserRelation}
      * @memberof Server
      */
-    environments: Array<EnvironmentRelation>;
+    created_by_user: UserRelation;
     /**
      *
      * @type {ProjectRelation}
@@ -88,39 +100,33 @@ export interface Server {
      */
     project: ProjectRelation;
     /**
-     * The name of the server\'s provider.
-     * @type {string}
-     * @memberof Server
-     */
-    provider_name?: string;
-    /**
-     * The human readable version of the provider\'s name
-     * @type {string}
+     *
+     * @type {ActionRelation}
      * @memberof Server
      */
-    provider_name_human_readable?: string;
+    last_action: ActionRelation | null;
     /**
      *
-     * @type {UserRelation}
+     * @type {EnvironmentRelation}
      * @memberof Server
      */
-    created_by_user: UserRelation;
+    environment: EnvironmentRelation;
     /**
      *
-     * @type {ActionRelation}
+     * @type {Array<EnvironmentRelation>}
      * @memberof Server
      */
-    last_action: ActionRelation | null;
+    environments: Array<EnvironmentRelation>;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof Server
      */
-    created_at?: string;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof Server
      */
-    updated_at?: string;
+    updated_at: string;
 }

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

@@ -19,13 +19,7 @@ import { ServiceName } from './service-name';
  */
 export interface ServiceCreate {
     /**
-     *
-     * @type {ServiceName}
-     * @memberof ServiceCreate
-     */
-    type: ServiceName;
-    /**
-     * Tells if the service should start automatically on operating system boot
+     * Tells if the service should start automatically on operating system boot.
      * @type {boolean}
      * @memberof ServiceCreate
      */
@@ -38,14 +32,20 @@ export interface ServiceCreate {
     initial_state?: ServiceInitialState;
     /**
      *
-     * @type {Array<EnvironmentLinkItem>}
+     * @type {ServiceName}
      * @memberof ServiceCreate
      */
-    environments?: Array<EnvironmentLinkItem>;
+    type: ServiceName;
     /**
-     * The service version to be installed
+     * The service version to be installed. Must be one of <code></code> Must be at least 3 characters. Must not be greater than 30 characters.
      * @type {string}
      * @memberof ServiceCreate
      */
-    version?: string;
+    version: string;
+    /**
+     *
+     * @type {Array<EnvironmentLinkItem>}
+     * @memberof ServiceCreate
+     */
+    environments?: Array<EnvironmentLinkItem>;
 }

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

@@ -18,29 +18,35 @@ import { ServiceInitialState } from './service-initial-state';
  */
 export interface ServiceRelation {
     /**
-     * The unique id of the given record
+     * The unique ID of the given service
      * @type {number}
      * @memberof ServiceRelation
      */
     id: number;
     /**
-     * The service name
+     * The human readable service name
      * @type {string}
      * @memberof ServiceRelation
      */
     name: string;
     /**
-     * Formatted/human readable version of the service name
+     * The service type
      * @type {string}
      * @memberof ServiceRelation
      */
-    name_human_readable?: string;
+    type: string;
+    /**
+     * Formatted/human readable version of the service type
+     * @type {string}
+     * @memberof ServiceRelation
+     */
+    type_human_readable: string;
     /**
      * The service current installed version
      * @type {string}
      * @memberof ServiceRelation
      */
-    version?: string | null;
+    version: string | null;
     /**
      * Indicates if the service was auto_generated by `devopness` itself
      * @type {boolean}
@@ -48,7 +54,7 @@ export interface ServiceRelation {
      */
     auto_generated: boolean;
     /**
-     * Indicates if the service is marked for start automatically on operating system boot
+     * Indicates if the service will start automatically on operating system boot
      * @type {boolean}
      * @memberof ServiceRelation
      */
@@ -64,13 +70,13 @@ export interface ServiceRelation {
      * @type {string}
      * @memberof ServiceRelation
      */
-    description?: string | null;
+    description: string | null;
     /**
      *
      * @type {ActionRelation}
      * @memberof ServiceRelation
      */
-    last_action?: ActionRelation | null;
+    last_action: ActionRelation | null;
     /**
      * The date and time when the record was created
      * @type {string}

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

@@ -16,7 +16,7 @@
  */
 export interface ServiceReload {
     /**
-     * The unique environment id
+     * The ID of the environment this service is running in.
      * @type {number}
      * @memberof ServiceReload
      */

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

@@ -16,7 +16,7 @@
  */
 export interface ServiceRestart {
     /**
-     * The unique environment id
+     * The ID of the environment this service is running in.
      * @type {number}
      * @memberof ServiceRestart
      */

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

@@ -16,7 +16,7 @@
  */
 export interface ServiceStart {
     /**
-     * The unique environment id
+     * The ID of the environment this service is running in.
      * @type {number}
      * @memberof ServiceStart
      */

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

@@ -16,7 +16,7 @@
  */
 export interface ServiceStop {
     /**
-     * The unique environment id
+     * The ID of the environment this service is running in.
      * @type {number}
      * @memberof ServiceStop
      */