@devopness/sdk-js 2.0.1 → 2.3.0

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

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { ApplicationDeploymentSettings } from './application-deployment-settings';
+import { ApplicationType } from './application-type';
 import { EnvironmentLinkItem } from './environment-link-item';
 /**
  *
@@ -18,17 +18,29 @@ import { EnvironmentLinkItem } from './environment-link-item';
  */
 export interface ApplicationCreate {
     /**
-     * A domain name that points to application main web address. 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`
+     * Numeric ID of the source provider account where the repository is hosted. Required when the `repository` field is informed.
+     * @type {number}
+     * @memberof ApplicationCreate
+     */
+    source_provider_id: number;
+    /**
+     *
+     * @type {ApplicationType}
+     * @memberof ApplicationCreate
+     */
+    type: ApplicationType;
+    /**
+     * The application\'s unique name
      * @type {string}
      * @memberof ApplicationCreate
      */
     name: string;
     /**
-     * Numeric ID of the source provider account where the repository is hosted. Required when the `repository` field is informed.
-     * @type {number}
+     * 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`
+     * @type {string}
      * @memberof ApplicationCreate
      */
-    source_provider_id: number;
+    domain_name?: 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.
      * @type {string}
@@ -36,23 +48,35 @@ export interface ApplicationCreate {
      */
     repository: string;
     /**
-     * The predominant programming language used in the application source code
+     * The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed.
+     * @type {string}
+     * @memberof ApplicationCreate
+     */
+    default_branch: string;
+    /**
+     * 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 ApplicationCreate
+     */
+    push_to_deploy?: boolean;
+    /**
+     * 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`.
      * @type {string}
      * @memberof ApplicationCreate
      */
     programming_language: string;
     /**
-     * The base framework on top of which the application has been implemented - if any
+     * The language runtime engine version to be used to execute this application on the deployed servers
      * @type {string}
      * @memberof ApplicationCreate
      */
-    framework: string;
+    engine_version?: string;
     /**
-     * The relative web directory where publicly accessible assets are located and the web content should be served from
+     * 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
      * @type {string}
      * @memberof ApplicationCreate
      */
-    public_directory: string;
+    framework: string;
     /**
      * 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.
      * @type {string}
@@ -60,17 +84,59 @@ export interface ApplicationCreate {
      */
     root_directory?: string;
     /**
-     * The applicaton initialization file/module/function from which the application execution starts. It might be a file name, a package manager script or a module/class/function exported by application code and invoked by a run time environment of the technology used by the application.
+     * The relative web directory where publicly accessible assets are located and the web content should be served from
+     * @type {string}
+     * @memberof ApplicationCreate
+     */
+    public_directory: string;
+    /**
+     * 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.
      * @type {string}
      * @memberof ApplicationCreate
      */
     entrypoint: string;
     /**
-     * The list of deployment settings for each application environment
-     * @type {Array<ApplicationDeploymentSettings>}
+     * 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 ApplicationCreate
+     */
+    listening_address?: string;
+    /**
+     * The optional command that should be executed once during deployment to build the source code and get the application in a ready state.
+     * @type {string}
+     * @memberof ApplicationCreate
+     */
+    build_command?: 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
+     * @type {number}
+     * @memberof ApplicationCreate
+     */
+    deployments_keep?: number;
+    /**
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in development mode
+     * @type {boolean}
+     * @memberof ApplicationCreate
+     */
+    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 ApplicationCreate
+     */
+    install_dependencies_prod?: boolean;
+    /**
+     * Indicates if the application requires a daemon to keep it alive
+     * @type {boolean}
+     * @memberof ApplicationCreate
+     */
+    requires_daemon: boolean;
+    /**
+     * Numeric ID of the project to which the application belongs to
+     * @type {number}
      * @memberof ApplicationCreate
      */
-    deployment_settings?: Array<ApplicationDeploymentSettings>;
+    project_id?: number;
     /**
      *
      * @type {Array<EnvironmentLinkItem>}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { DeploymentType } from './deployment-type';
 /**
  *
  * @export
@@ -16,30 +17,27 @@
  */
 export interface ApplicationDeployment {
     /**
-     * The type of the deployment being triggered
-     * @type {string}
+     *
+     * @type {DeploymentType}
      * @memberof ApplicationDeployment
      */
-    type: ApplicationDeploymentTypeEnum;
+    type: DeploymentType;
     /**
-     * The name of the branch from which the source code should be retrieved and deployed
+     * The name of the branch from which the application source code will be retrieved and deployed. This parameter is ignored when `hash` is provided.
      * @type {string}
      * @memberof ApplicationDeployment
      */
     branch: string;
     /**
-     * The commit\'s full hash that uniquely identify a commit. Required when re-deploying
+     * The commit hash from which the application source code will be retrieved and deployed. When provided `branch` parameter is ignored
      * @type {string}
      * @memberof ApplicationDeployment
      */
     hash?: string;
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum ApplicationDeploymentTypeEnum {
-    Deploy = "deploy",
-    Redeploy = "redeploy",
-    Rollback = "rollback"
+    /**
+     * List of servers ids that the deploy will be triggered to
+     * @type {Array<number>}
+     * @memberof ApplicationDeployment
+     */
+    servers?: Array<number>;
 }

package/dist/api/generated/models/application-deployment.js

@@ -12,14 +12,3 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApplicationDeploymentTypeEnum = void 0;
-/**
-    * @export
-    * @enum {string}
-    */
-var ApplicationDeploymentTypeEnum;
-(function (ApplicationDeploymentTypeEnum) {
-    ApplicationDeploymentTypeEnum["Deploy"] = "deploy";
-    ApplicationDeploymentTypeEnum["Redeploy"] = "redeploy";
-    ApplicationDeploymentTypeEnum["Rollback"] = "rollback";
-})(ApplicationDeploymentTypeEnum = exports.ApplicationDeploymentTypeEnum || (exports.ApplicationDeploymentTypeEnum = {}));

package/dist/api/generated/models/application-last-deployments.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ */
+import { Action } from './action';
+/**
+ * Latest deployment created to application and the more recent completed deployment
+ * @export
+ * @interface ApplicationLastDeployments
+ */
+export interface ApplicationLastDeployments {
+    /**
+     *
+     * @type {Action}
+     * @memberof ApplicationLastDeployments
+     */
+    latest?: Action | null;
+    /**
+     *
+     * @type {Action}
+     * @memberof ApplicationLastDeployments
+     */
+    live?: Action | null;
+}

package/dist/api/generated/models/application-last-deployments.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/application-options.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+import { DeploymentDefaultStep } from './deployment-default-step';
+import { LanguageRuntime } from './language-runtime';
+/**
+ *
+ * @export
+ * @interface ApplicationOptions
+ */
+export interface ApplicationOptions {
+    /**
+     *
+     * @type {Array<DeploymentDefaultStep>}
+     * @memberof ApplicationOptions
+     */
+    deployment_steps: Array<DeploymentDefaultStep>;
+    /**
+     *
+     * @type {Array<LanguageRuntime>}
+     * @memberof ApplicationOptions
+     */
+    language_runtimes: Array<LanguageRuntime>;
+}

package/dist/api/generated/models/application-options.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/application-relation.d.ts

@@ -0,0 +1,170 @@
+/**
+ * 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.
+ */
+import { ActionRelation } from './action-relation';
+import { ApplicationType } from './application-type';
+/**
+ *
+ * @export
+ * @interface ApplicationRelation
+ */
+export interface ApplicationRelation {
+    /**
+     * The unique id of the given record
+     * @type {number}
+     * @memberof ApplicationRelation
+     */
+    id: number;
+    /**
+     * The id of the user who created the server and to whom the server belongs
+     * @type {number}
+     * @memberof ApplicationRelation
+     */
+    created_by: number;
+    /**
+     *
+     * @type {ApplicationType}
+     * @memberof ApplicationRelation
+     */
+    type: ApplicationType;
+    /**
+     * The application\'s unique name
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    name: 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`
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    domain_name?: 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.
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    repository?: string | null;
+    /**
+     * The name part of a repository full name (`repository_owner/repository_name`)
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    repository_name?: string | null;
+    /**
+     * The owner part of a repository full name (`repository_owner/repository_name`)
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    repository_owner?: string | null;
+    /**
+     * The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed.
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    default_branch: string;
+    /**
+     * Indicates if push to deploy webhooks are enabled for this application. If enabled an app deployment will be automatically triggered when new changes are commited to the `default_branch`
+     * @type {boolean}
+     * @memberof ApplicationRelation
+     */
+    push_to_deploy?: boolean;
+    /**
+     * 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`.
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    programming_language: string;
+    /**
+     * The language runtime engine version to be used to execute this application on the deployed servers
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    engine_version?: string | null;
+    /**
+     * 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
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    framework: string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    root_directory?: string;
+    /**
+     * The relative web directory where publicly accessible assets are located and the web content should be served from
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    public_directory: string;
+    /**
+     * 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 initalizes 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 - everytime the application needs to be started.
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    entrypoint?: 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 ApplicationRelation
+     */
+    listening_address?: string | null;
+    /**
+     * 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 previoius versions
+     * @type {number}
+     * @memberof ApplicationRelation
+     */
+    deployments_keep?: number;
+    /**
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in development mode
+     * @type {boolean}
+     * @memberof ApplicationRelation
+     */
+    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 ApplicationRelation
+     */
+    install_dependencies_prod?: boolean;
+    /**
+     * Indicates if the application requires a daemon to keep it alive
+     * @type {boolean}
+     * @memberof ApplicationRelation
+     */
+    requires_daemon?: boolean;
+    /**
+     * Numeric ID of the project to which the application belongs to
+     * @type {number}
+     * @memberof ApplicationRelation
+     */
+    project_id: number;
+    /**
+     *
+     * @type {ActionRelation}
+     * @memberof ApplicationRelation
+     */
+    last_action?: ActionRelation | null;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof ApplicationRelation
+     */
+    updated_at?: string;
+}

package/dist/api/generated/models/application-relation.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/application-type.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+/**
+ * The application\'s type, which will mainly define if it is publicly accessible through a web domain or not
+ * @export
+ * @enum {string}
+ */
+export declare enum ApplicationType {
+    Web = "web",
+    NonWeb = "non-web"
+}

package/dist/api/generated/models/application-type.js

@@ -0,0 +1,25 @@
+"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 });
+exports.ApplicationType = void 0;
+/**
+ * The application\'s type, which will mainly define if it is publicly accessible through a web domain or not
+ * @export
+ * @enum {string}
+ */
+var ApplicationType;
+(function (ApplicationType) {
+    ApplicationType["Web"] = "web";
+    ApplicationType["NonWeb"] = "non-web";
+})(ApplicationType = exports.ApplicationType || (exports.ApplicationType = {}));