@devopness/sdk-js 2.0.1 → 2.3.0

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

@@ -0,0 +1,146 @@
+/**
+ * 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 { ApplicationType } from './application-type';
+import { EnvironmentLinkItem } from './environment-link-item';
+/**
+ *
+ * @export
+ * @interface ApplicationUpdate
+ */
+export interface ApplicationUpdate {
+    /**
+     * The unique id of the given record
+     * @type {number}
+     * @memberof ApplicationUpdate
+     */
+    id: number;
+    /**
+     *
+     * @type {ApplicationType}
+     * @memberof ApplicationUpdate
+     */
+    type: ApplicationType;
+    /**
+     * The application\'s unique name
+     * @type {string}
+     * @memberof ApplicationUpdate
+     */
+    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 ApplicationUpdate
+     */
+    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 ApplicationUpdate
+     */
+    repository?: string;
+    /**
+     * 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 ApplicationUpdate
+     */
+    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 ApplicationUpdate
+     */
+    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 ApplicationUpdate
+     */
+    programming_language: string;
+    /**
+     * The language runtime engine version to be used to execute this application on the deployed servers
+     * @type {string}
+     * @memberof ApplicationUpdate
+     */
+    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
+     * @type {string}
+     * @memberof ApplicationUpdate
+     */
+    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 ApplicationUpdate
+     */
+    root_directory?: string;
+    /**
+     * The relative web directory where publicly accessible assets are located and the web content should be served from
+     * @type {string}
+     * @memberof ApplicationUpdate
+     */
+    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 ApplicationUpdate
+     */
+    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 ApplicationUpdate
+     */
+    listening_address?: 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 ApplicationUpdate
+     */
+    deployments_keep?: number;
+    /**
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in development mode
+     * @type {boolean}
+     * @memberof ApplicationUpdate
+     */
+    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 ApplicationUpdate
+     */
+    install_dependencies_prod?: boolean;
+    /**
+     * Indicates if the application requires a daemon to keep it alive
+     * @type {boolean}
+     * @memberof ApplicationUpdate
+     */
+    requires_daemon: boolean;
+    /**
+     * Numeric ID of the project to which the application belongs to
+     * @type {number}
+     * @memberof ApplicationUpdate
+     */
+    project_id: number;
+    /**
+     * Numeric ID of the source provider account where the repository is hosted. Required when the `repository` field is informed.
+     * @type {number}
+     * @memberof ApplicationUpdate
+     */
+    source_provider_id?: number;
+    /**
+     *
+     * @type {Array<EnvironmentLinkItem>}
+     * @memberof ApplicationUpdate
+     */
+    environments?: Array<EnvironmentLinkItem>;
+}

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

@@ -9,9 +9,14 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { ApplicationDeploymentSettings } from './application-deployment-settings';
-import { Environment } from './environment';
-import { SocialAccount } from './social-account';
+import { ActionRelation } from './action-relation';
+import { ApplicationLastDeployments } from './application-last-deployments';
+import { ApplicationType } from './application-type';
+import { EnvironmentRelation } from './environment-relation';
+import { ServerRelation } from './server-relation';
+import { SourceProvider } from './source-provider';
+import { SslCertificateRelation } from './ssl-certificate-relation';
+import { UserRelation } from './user-relation';
 /**
  *
  * @export
@@ -25,59 +30,77 @@ export interface Application {
      */
     id: number;
     /**
-     * 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`
-     * @type {string}
+     * The id of the user who created the application and to whom the application belongs
+     * @type {number}
      * @memberof Application
      */
-    name: string;
+    created_by: number;
     /**
-     * Numeric ID of the project that the application belongs to
-     * @type {number}
+     *
+     * @type {ApplicationType}
      * @memberof Application
      */
-    project_id: number;
+    type: ApplicationType;
     /**
-     * Numeric ID of the source provider account where the repository is hosted. Required when the `repository` field is informed.
-     * @type {number}
+     * The application\'s unique name
+     * @type {string}
      * @memberof Application
      */
-    source_provider_id?: number;
+    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 Application
+     */
+    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 Application
      */
-    repository?: string;
+    repository?: string | null;
     /**
      * The name part of a repository full name (`repository_owner/repository_name`)
      * @type {string}
      * @memberof Application
      */
-    repository_name?: string;
+    repository_name?: string | null;
     /**
      * The owner part of a repository full name (`repository_owner/repository_name`)
      * @type {string}
      * @memberof Application
      */
-    repository_owner?: string;
+    repository_owner?: string | null;
     /**
-     * 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 Application
+     */
+    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 Application
+     */
+    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 Application
      */
     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 Application
      */
-    framework: string;
+    engine_version?: string | null;
     /**
-     * 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 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 Application
      */
-    entrypoint: 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}
@@ -91,38 +114,99 @@ export interface Application {
      */
     public_directory: string;
     /**
-     *
-     * @type {SocialAccount}
+     * 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 Application
+     */
+    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 Application
      */
-    source_provider?: SocialAccount;
+    listening_address?: string | null;
     /**
-     * The list of deployment settings for each application environment
-     * @type {Array<ApplicationDeploymentSettings>}
+     * 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 Application
      */
-    deployment_settings?: Array<ApplicationDeploymentSettings>;
+    deployments_keep?: number;
+    /**
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in development mode
+     * @type {boolean}
+     * @memberof Application
+     */
+    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 Application
+     */
+    install_dependencies_prod?: boolean;
+    /**
+     * Indicates if the application requires a daemon to keep it alive
+     * @type {boolean}
+     * @memberof Application
+     */
+    requires_daemon?: boolean;
+    /**
+     * Numeric ID of the project to which the application belongs to
+     * @type {number}
+     * @memberof Application
+     */
+    project_id: number;
     /**
      * The list of environments to which the application is linked to
-     * @type {Array<Environment>}
+     * @type {Array<EnvironmentRelation>}
+     * @memberof Application
+     */
+    environments: Array<EnvironmentRelation>;
+    /**
+     *
+     * @type {Array<ServerRelation>}
+     * @memberof Application
+     */
+    servers: Array<ServerRelation>;
+    /**
+     *
+     * @type {ApplicationLastDeployments}
+     * @memberof Application
+     */
+    last_deployments?: ApplicationLastDeployments;
+    /**
+     *
+     * @type {SourceProvider}
      * @memberof Application
      */
-    environments?: Array<Environment>;
+    source_provider: SourceProvider | null;
     /**
-     * Current status of deploying to remote servers the current application
+     *
+     * @type {Array<SslCertificateRelation>}
+     * @memberof Application
+     */
+    ssl_certificates: Array<SslCertificateRelation>;
+    /**
+     *
+     * @type {UserRelation}
+     * @memberof Application
+     */
+    created_by_user: UserRelation;
+    /**
+     *
+     * @type {ActionRelation}
+     * @memberof Application
+     */
+    last_action?: ActionRelation | null;
+    /**
+     * The date and time when the record was created
      * @type {string}
      * @memberof Application
      */
-    status?: ApplicationStatusEnum;
-}
-/**
-    * @export
-    * @enum {string}
-    */
-export declare enum ApplicationStatusEnum {
-    Pending = "pending",
-    InProgress = "in-progress",
-    Cancelled = "cancelled",
-    Completed = "completed",
-    Failed = "failed"
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof Application
+     */
+    updated_at?: string;
 }

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

@@ -12,16 +12,3 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApplicationStatusEnum = void 0;
-/**
-    * @export
-    * @enum {string}
-    */
-var ApplicationStatusEnum;
-(function (ApplicationStatusEnum) {
-    ApplicationStatusEnum["Pending"] = "pending";
-    ApplicationStatusEnum["InProgress"] = "in-progress";
-    ApplicationStatusEnum["Cancelled"] = "cancelled";
-    ApplicationStatusEnum["Completed"] = "completed";
-    ApplicationStatusEnum["Failed"] = "failed";
-})(ApplicationStatusEnum = exports.ApplicationStatusEnum || (exports.ApplicationStatusEnum = {}));

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

@@ -0,0 +1,25 @@
+/**
+ * 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 { ServiceName } from './service-name';
+/**
+ *
+ * @export
+ * @interface BlueprintService
+ */
+export interface BlueprintService {
+    /**
+     *
+     * @type {ServiceName}
+     * @memberof BlueprintService
+     */
+    name?: ServiceName;
+}

package/dist/api/generated/models/blueprint-service.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/cloud-aws-ec2-settings.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 { CloudOs } from './cloud-os';
+/**
+ *
+ * @export
+ * @interface CloudAwsEc2Settings
+ */
+export interface CloudAwsEc2Settings {
+    /**
+     * The instance type to be launched on the cloud provider
+     * @type {string}
+     * @memberof CloudAwsEc2Settings
+     */
+    instance_type: string;
+    /**
+     * Datacenter region where the cloud instance will be launched
+     * @type {string}
+     * @memberof CloudAwsEc2Settings
+     */
+    region: string;
+    /**
+     * The storage\'s size of the cloud instance
+     * @type {number}
+     * @memberof CloudAwsEc2Settings
+     */
+    storage_size: number;
+    /**
+     *
+     * @type {CloudOs}
+     * @memberof CloudAwsEc2Settings
+     */
+    os: CloudOs;
+}

package/dist/api/generated/models/cloud-aws-ec2-settings.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/cloud-digital-ocean-droplet-settings.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { CloudOs } from './cloud-os';
+/**
+ *
+ * @export
+ * @interface CloudDigitalOceanDropletSettings
+ */
+export interface CloudDigitalOceanDropletSettings {
+    /**
+     * The instance type to be launched on the cloud provider
+     * @type {string}
+     * @memberof CloudDigitalOceanDropletSettings
+     */
+    instance_type: string;
+    /**
+     * Datacenter region where the cloud instance will be launched
+     * @type {string}
+     * @memberof CloudDigitalOceanDropletSettings
+     */
+    region: string;
+    /**
+     *
+     * @type {CloudOs}
+     * @memberof CloudDigitalOceanDropletSettings
+     */
+    os: CloudOs;
+}

package/dist/api/generated/models/cloud-digital-ocean-droplet-settings.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/cloud-instance.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 CloudInstance
+ */
+export interface CloudInstance {
+    /**
+     * The name of the cloud instance
+     * @type {string}
+     * @memberof CloudInstance
+     */
+    name: string;
+    /**
+     * The type of the cloud instance
+     * @type {string}
+     * @memberof CloudInstance
+     */
+    type: string;
+    /**
+     * The family to which the instance belongs
+     * @type {string}
+     * @memberof CloudInstance
+     */
+    family: string;
+    /**
+     * The default disk size (in GB) used to instance
+     * @type {number}
+     * @memberof CloudInstance
+     */
+    default_disk_size: number;
+    /**
+     * The price per hour of the instance
+     * @type {string}
+     * @memberof CloudInstance
+     */
+    price_hourly: string;
+    /**
+     * The price per month of the instance
+     * @type {string}
+     * @memberof CloudInstance
+     */
+    price_monthly: string;
+    /**
+     * The currency of the prices
+     * @type {string}
+     * @memberof CloudInstance
+     */
+    price_currency: string;
+    /**
+     * The number of virtual CPU of the instance
+     * @type {number}
+     * @memberof CloudInstance
+     */
+    vcpus: number;
+    /**
+     * The RAM memory size (in MB) of the instance
+     * @type {string}
+     * @memberof CloudInstance
+     */
+    memory: string;
+}

package/dist/api/generated/models/cloud-instance.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 });