@devopness/sdk-js 2.14.1 → 2.16.0

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

@@ -15,9 +15,9 @@ import { Service } from '../../generated/models';
 import { ServiceReload } from '../../generated/models';
 import { ServiceRestart } from '../../generated/models';
 import { ServiceStart } from '../../generated/models';
-import { ServiceStatusUpdate } from '../../generated/models';
 import { ServiceStop } from '../../generated/models';
 import { ServiceUpdate } from '../../generated/models';
+import { ServiceUpdateStatus } from '../../generated/models';
 /**
  * ServicesApiService - Auto-generated
  */
@@ -25,55 +25,55 @@ export declare class ServicesApiService extends 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: number): Promise<ApiResponse<void>>;
     /**
      *
      * @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: number): Promise<ApiResponse<Service>>;
     /**
      *
      * @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: number, serviceReload: ServiceReload): Promise<ApiResponse<void>>;
     /**
      *
      * @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: number, serviceRestart: ServiceRestart): Promise<ApiResponse<void>>;
     /**
      *
      * @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: number, serviceStart: ServiceStart): Promise<ApiResponse<void>>;
     /**
      *
      * @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: number, serviceStop: ServiceStop): Promise<ApiResponse<void>>;
     /**
      *
      * @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: number, serviceUpdate: ServiceUpdate): Promise<ApiResponse<void>>;
     /**
-     * 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: number, serviceStatusUpdate: ServiceStatusUpdate): Promise<ApiResponse<void>>;
+    updateStatusService(serviceId: number, serviceUpdateStatus: ServiceUpdateStatus): Promise<ApiResponse<void>>;
 }

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/cron-job-create.d.ts

@@ -17,41 +17,41 @@ import { EnvironmentLinkItem } from './environment-link-item';
  */
 export interface CronJobCreate {
     /**
-     * Numeric ID of the project to which the cron job belongs to
-     * @type {number}
-     * @memberof CronJobCreate
-     */
-    project_id: number;
-    /**
-     * Numeric ID of the application to which the cron job belongs to
-     * @type {number}
+     * A cron expression consisting of Minute, Hour, Day of Month, Month and Day of Week subexpressions.
+     * @type {string}
      * @memberof CronJobCreate
      */
-    application_id?: number;
+    pattern: string;
     /**
-     * The name of the cron job
+     * The name of the cron job. Must not be greater than 60 characters.
      * @type {string}
      * @memberof CronJobCreate
      */
     name: string;
     /**
-     * The command line to be executed when running the cron job
+     * The command line to be executed when running the cron job. Must be at least 5 characters. Must not be greater than 255 characters.
      * @type {string}
      * @memberof CronJobCreate
      */
     command: string;
     /**
-     * A cron expression consisting of Minute, Hour, Day of Month, Month and Day of Week subexpressions
+     * The name of the system user on behalf of which the cron job will be executed. Must not be greater than 60 characters.
      * @type {string}
      * @memberof CronJobCreate
      */
-    pattern: string;
+    run_as_user: string;
     /**
-     * The name of the system user on behalf of which the cron job will be executed
-     * @type {string}
+     * Numeric ID of the application to which the cron job belongs to.
+     * @type {number}
      * @memberof CronJobCreate
      */
-    run_as_user: string;
+    application_id?: number;
+    /**
+     * Numeric ID of the project to which the cron job belongs to.
+     * @type {number}
+     * @memberof CronJobCreate
+     */
+    project_id: number;
     /**
      *
      * @type {Array<EnvironmentLinkItem>}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 CronJobEnvironmentCreate
+ */
+export interface CronJobEnvironmentCreate {
+    /**
+     * The name of the cron job. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof CronJobEnvironmentCreate
+     */
+    name: string;
+    /**
+     * The command line to be executed when running the cron job. Must be at least 5 characters. Must not be greater than 255 characters.
+     * @type {string}
+     * @memberof CronJobEnvironmentCreate
+     */
+    command: string;
+    /**
+     * A cron expression consisting of Minute, Hour, Day of Month, Month and Day of Week subexpressions.
+     * @type {string}
+     * @memberof CronJobEnvironmentCreate
+     */
+    pattern: string;
+    /**
+     * The name of the system user on behalf of which the cron job will be executed. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof CronJobEnvironmentCreate
+     */
+    run_as_user: string;
+    /**
+     * Numeric ID of the application to which the cron job belongs to.
+     * @type {number}
+     * @memberof CronJobEnvironmentCreate
+     */
+    application_id?: number;
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof CronJobEnvironmentCreate
+     */
+    servers?: Array<number>;
+}

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

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -12,6 +12,7 @@
 import { ActionRelation } from './action-relation';
 import { ApplicationRelation } from './application-relation';
 import { CronJobPattern } from './cron-job-pattern';
+import { UserRelation } from './user-relation';
 /**
  *
  * @export
@@ -19,7 +20,7 @@ import { CronJobPattern } from './cron-job-pattern';
  */
 export interface CronJobRelation {
     /**
-     * The Id of the given cron job
+     * The ID of the given cron job
      * @type {number}
      * @memberof CronJobRelation
      */
@@ -36,6 +37,12 @@ export interface CronJobRelation {
      * @memberof CronJobRelation
      */
     command: string;
+    /**
+     * The name of the Unix user on behalf of which the cron job will be executed
+     * @type {string}
+     * @memberof CronJobRelation
+     */
+    run_as_user: string;
     /**
      * A cron expression consisting of Minute, Hour, Day of Month, Month and Day of Week subexpressions
      * @type {string}
@@ -48,40 +55,40 @@ export interface CronJobRelation {
      * @memberof CronJobRelation
      */
     pattern_human_readable: CronJobPattern;
-    /**
-     * The name of the Unix user on behalf of which the cron job will be executed
-     * @type {string}
-     * @memberof CronJobRelation
-     */
-    run_as_user: string;
     /**
      * Indicates if the cron job was auto_generated by `devopness` itself
      * @type {boolean}
      * @memberof CronJobRelation
      */
-    auto_generated?: boolean;
+    auto_generated: boolean;
     /**
      *
      * @type {ActionRelation}
      * @memberof CronJobRelation
      */
-    last_action?: ActionRelation | null;
+    last_action: ActionRelation | null;
+    /**
+     *
+     * @type {UserRelation}
+     * @memberof CronJobRelation
+     */
+    created_by_user: UserRelation;
     /**
      *
      * @type {ApplicationRelation}
      * @memberof CronJobRelation
      */
-    application?: ApplicationRelation | null;
+    application: ApplicationRelation | null;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof CronJobRelation
      */
-    created_at?: string;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof CronJobRelation
      */
-    updated_at?: string;
+    updated_at: string;
 }

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

@@ -17,41 +17,41 @@ import { EnvironmentLinkItem } from './environment-link-item';
  */
 export interface CronJobUpdate {
     /**
-     * The unique id of the given record
+     * The unique ID of the given cron job.
      * @type {number}
      * @memberof CronJobUpdate
      */
     id: number;
     /**
-     * Numeric ID of the application to which the cron job belongs to
-     * @type {number}
+     * A cron expression consisting of Minute, Hour, Day of Month, Month and Day of Week subexpressions.
+     * @type {string}
      * @memberof CronJobUpdate
      */
-    application_id?: number;
+    pattern: string;
     /**
-     * The name of the cron job
+     * The name of the cron job. Must not be greater than 60 characters.
      * @type {string}
      * @memberof CronJobUpdate
      */
     name: string;
     /**
-     * The command line to be executed when running the cron job
+     * The command line to be executed when running the cron job. Must be at least 5 characters. Must not be greater than 255 characters.
      * @type {string}
      * @memberof CronJobUpdate
      */
     command: string;
     /**
-     * A cron expression consisting of Minute, Hour, Day of Month, Month and Day of Week subexpressions
+     * The name of the system user on behalf of which the cron job will be executed. Must not be greater than 60 characters.
      * @type {string}
      * @memberof CronJobUpdate
      */
-    pattern: string;
+    run_as_user: string;
     /**
-     * The name of the system user on behalf of which the cron job will be executed
-     * @type {string}
+     * Numeric ID of the application to which the cron job belongs to.
+     * @type {number}
      * @memberof CronJobUpdate
      */
-    run_as_user: string;
+    application_id?: number;
     /**
      *
      * @type {Array<EnvironmentLinkItem>}