@devopness/sdk-js 2.23.0 → 2.24.0

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

@@ -9,8 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { ActionRelation } from './action-relation';
-import { ApplicationPipeline } from './application-pipeline';
+import { ApplicationLastDeployments } from './application-last-deployments';
 import { ApplicationType } from './application-type';
 /**
  *
@@ -19,53 +18,65 @@ import { ApplicationType } from './application-type';
  */
 export interface ApplicationRelation {
     /**
-     * The unique id of the given record
+     * Unique ID of the application
      * @type {number}
      * @memberof ApplicationRelation
      */
     id: number;
     /**
-     * The id of the user who created the server and to whom the server belongs
+     * Numeric ID of the project to which the application belongs to
      * @type {number}
      * @memberof ApplicationRelation
      */
-    created_by: number;
+    project_id: number;
     /**
-     *
-     * @type {ApplicationType}
+     * Numeric ID of the environment to which the application belongs to
+     * @type {number}
      * @memberof ApplicationRelation
      */
-    type: ApplicationType;
+    environment_id: number;
+    /**
+     * The id of the user who created the application and to whom the application belongs
+     * @type {number}
+     * @memberof ApplicationRelation
+     */
+    created_by: number;
     /**
      * The application\'s unique name
      * @type {string}
      * @memberof ApplicationRelation
      */
     name: string;
+    /**
+     *
+     * @type {ApplicationType}
+     * @memberof ApplicationRelation
+     */
+    type: ApplicationType;
     /**
      * 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;
+    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;
+    repository: string;
     /**
      * The name part of a repository full name (`repository_owner/repository_name`)
      * @type {string}
      * @memberof ApplicationRelation
      */
-    repository_name?: string | null;
+    repository_name: string;
     /**
      * The owner part of a repository full name (`repository_owner/repository_name`)
      * @type {string}
      * @memberof ApplicationRelation
      */
-    repository_owner?: string | null;
+    repository_owner: 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}
@@ -73,11 +84,11 @@ export interface 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`
+     * 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 ApplicationRelation
      */
-    push_to_deploy?: boolean;
+    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}
@@ -89,7 +100,7 @@ export interface ApplicationRelation {
      * @type {string}
      * @memberof ApplicationRelation
      */
-    engine_version?: string | null;
+    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}
@@ -101,7 +112,7 @@ export interface ApplicationRelation {
      * @type {string}
      * @memberof ApplicationRelation
      */
-    root_directory?: string;
+    root_directory: string;
     /**
      * The relative web directory where publicly accessible assets are located and the web content should be served from
      * @type {string}
@@ -109,69 +120,57 @@ export interface 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.
+     * The application\'s entrypoint
      * @type {string}
      * @memberof ApplicationRelation
      */
-    entrypoint?: string;
+    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.
+     * Application\'s listening address
      * @type {string}
      * @memberof ApplicationRelation
      */
-    listening_address?: string | null;
+    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 previoius versions
+     * 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 ApplicationRelation
      */
-    deployments_keep?: number;
+    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;
+    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;
+    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;
+    requires_daemon: boolean;
     /**
      *
-     * @type {ApplicationPipeline}
+     * @type {ApplicationLastDeployments}
      * @memberof ApplicationRelation
      */
-    default_pipeline?: ApplicationPipeline | null;
+    last_deployments?: ApplicationLastDeployments;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof ApplicationRelation
      */
-    created_at?: string;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof ApplicationRelation
      */
-    updated_at?: string;
+    updated_at: string;
 }

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

@@ -10,7 +10,6 @@
  * Do not edit the class manually.
  */
 import { ApplicationType } from './application-type';
-import { EnvironmentLinkItem } from './environment-link-item';
 /**
  *
  * @export
@@ -18,11 +17,17 @@ import { EnvironmentLinkItem } from './environment-link-item';
  */
 export interface ApplicationUpdate {
     /**
-     * The unique id of the given record
+     * The unique id of the given application.
      * @type {number}
      * @memberof ApplicationUpdate
      */
     id: number;
+    /**
+     * The application\'s unique name. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof ApplicationUpdate
+     */
+    name: string;
     /**
      *
      * @type {ApplicationType}
@@ -30,117 +35,117 @@ export interface ApplicationUpdate {
      */
     type: ApplicationType;
     /**
-     * The application\'s unique name
+     * 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 ApplicationUpdate
      */
-    name: string;
+    domain_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`
+     * 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 ApplicationUpdate
      */
-    domain_name?: string;
+    build_command?: 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.
+     * 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 ApplicationUpdate
      */
-    repository?: string;
+    engine_version?: string;
     /**
-     * The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed.
+     * 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 ApplicationUpdate
      */
-    default_branch: string;
+    framework: 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}
+     * 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 ApplicationUpdate
      */
-    push_to_deploy?: boolean;
+    programming_language: 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`.
+     * 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
      */
-    programming_language: string;
+    listening_address?: string;
     /**
-     * The language runtime engine version to be used to execute this application on the deployed servers
+     * 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 ApplicationUpdate
      */
-    engine_version?: string;
+    repository: 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
+     * Numeric ID of the pipeline used as default on deploy the application.
      * @type {string}
      * @memberof ApplicationUpdate
      */
-    framework: string;
+    default_pipeline_id?: 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}
+     * Numeric ID of the source provider account where the repository is hosted. Required when the `repository` field is informed.
+     * @type {number}
      * @memberof ApplicationUpdate
      */
-    root_directory?: string;
+    source_provider_id: number;
     /**
-     * The relative web directory where publicly accessible assets are located and the web content should be served from
+     * 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 ApplicationUpdate
      */
-    public_directory: string;
+    root_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.
+     * 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 ApplicationUpdate
      */
-    entrypoint?: string;
+    public_directory: 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.
+     * 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 ApplicationUpdate
      */
-    listening_address?: string;
+    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
+     * 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 ApplicationUpdate
      */
     deployments_keep?: number;
     /**
-     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in development mode
-     * @type {boolean}
+     * 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 ApplicationUpdate
      */
-    install_dependencies_dev?: boolean;
+    entrypoint: string;
     /**
-     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in production mode
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in development mode.
      * @type {boolean}
      * @memberof ApplicationUpdate
      */
-    install_dependencies_prod?: boolean;
+    install_dependencies_dev: boolean;
     /**
-     * Indicates if the application requires a daemon to keep it alive
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in production mode.
      * @type {boolean}
      * @memberof ApplicationUpdate
      */
-    requires_daemon: boolean;
+    install_dependencies_prod: boolean;
     /**
-     * Numeric ID of the project to which the application belongs to
-     * @type {number}
+     * 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
      */
-    project_id: number;
+    push_to_deploy?: boolean;
     /**
-     * Numeric ID of the source provider account where the repository is hosted. Required when the `repository` field is informed.
-     * @type {number}
+     * Indicates if the application requires a daemon to keep it alive.
+     * @type {boolean}
      * @memberof ApplicationUpdate
      */
-    source_provider_id?: number;
+    requires_daemon: boolean;
     /**
-     *
-     * @type {Array<EnvironmentLinkItem>}
+     * List of valid resource IDs
+     * @type {Array<number>}
      * @memberof ApplicationUpdate
      */
-    environments?: Array<EnvironmentLinkItem>;
+    servers: Array<number>;
 }

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

@@ -9,7 +9,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { ActionRelation } from './action-relation';
 import { ApplicationLastDeployments } from './application-last-deployments';
 import { ApplicationPipeline } from './application-pipeline';
 import { ApplicationType } from './application-type';
@@ -25,53 +24,65 @@ import { UserRelation } from './user-relation';
  */
 export interface Application {
     /**
-     * The unique id of the given record
+     * Unique ID of the application
      * @type {number}
      * @memberof Application
      */
     id: number;
     /**
-     * The id of the user who created the application and to whom the application belongs
+     * Numeric ID of the project to which the application belongs to
      * @type {number}
      * @memberof Application
      */
-    created_by: number;
+    project_id: number;
     /**
-     *
-     * @type {ApplicationType}
+     * Numeric ID of the environment to which the application belongs to
+     * @type {number}
      * @memberof Application
      */
-    type: ApplicationType;
+    environment_id: number;
+    /**
+     * The id of the user who created the application and to whom the application belongs
+     * @type {number}
+     * @memberof Application
+     */
+    created_by: number;
     /**
      * The application\'s unique name
      * @type {string}
      * @memberof Application
      */
     name: string;
+    /**
+     *
+     * @type {ApplicationType}
+     * @memberof Application
+     */
+    type: ApplicationType;
     /**
      * 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;
+    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 | null;
+    repository: string;
     /**
      * The name part of a repository full name (`repository_owner/repository_name`)
      * @type {string}
      * @memberof Application
      */
-    repository_name?: string | null;
+    repository_name: string;
     /**
      * The owner part of a repository full name (`repository_owner/repository_name`)
      * @type {string}
      * @memberof Application
      */
-    repository_owner?: string | null;
+    repository_owner: 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}
@@ -83,7 +94,7 @@ export interface Application {
      * @type {boolean}
      * @memberof Application
      */
-    push_to_deploy?: boolean;
+    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}
@@ -95,7 +106,7 @@ export interface Application {
      * @type {string}
      * @memberof Application
      */
-    engine_version?: string | null;
+    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}
@@ -107,7 +118,7 @@ export interface Application {
      * @type {string}
      * @memberof Application
      */
-    root_directory?: string;
+    root_directory: string;
     /**
      * The relative web directory where publicly accessible assets are located and the web content should be served from
      * @type {string}
@@ -115,105 +126,99 @@ export interface Application {
      */
     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.
+     * The application\'s entrypoint
      * @type {string}
      * @memberof Application
      */
-    entrypoint?: string;
+    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.
+     * Application\'s listening address
      * @type {string}
      * @memberof Application
      */
-    listening_address?: string | null;
+    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 Application
      */
-    deployments_keep?: number;
+    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;
+    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;
+    install_dependencies_prod: boolean;
     /**
      * Indicates if the application requires a daemon to keep it alive
      * @type {boolean}
      * @memberof Application
      */
-    requires_daemon?: boolean;
+    requires_daemon: boolean;
     /**
-     * Numeric ID of the project to which the application belongs to
-     * @type {number}
+     *
+     * @type {ApplicationPipeline}
      * @memberof Application
      */
-    project_id: number;
+    default_pipeline: ApplicationPipeline | null;
     /**
-     * The list of environments to which the application is linked to
-     * @type {Array<EnvironmentRelation>}
+     *
+     * @type {UserRelation}
      * @memberof Application
      */
-    environments: Array<EnvironmentRelation>;
+    created_by_user: UserRelation;
     /**
      *
-     * @type {Array<ServerRelation>}
+     * @type {ApplicationLastDeployments}
      * @memberof Application
      */
-    servers: Array<ServerRelation>;
+    last_deployments: ApplicationLastDeployments;
     /**
      *
-     * @type {ApplicationLastDeployments}
+     * @type {EnvironmentRelation}
      * @memberof Application
      */
-    last_deployments?: ApplicationLastDeployments;
+    environment: EnvironmentRelation;
     /**
      *
-     * @type {SourceProvider}
+     * @type {Array<EnvironmentRelation>}
      * @memberof Application
      */
-    source_provider: SourceProvider | null;
+    environments: Array<EnvironmentRelation>;
     /**
      *
-     * @type {Array<SslCertificateRelation>}
+     * @type {Array<ServerRelation>}
      * @memberof Application
      */
-    ssl_certificates: Array<SslCertificateRelation>;
+    servers: Array<ServerRelation>;
     /**
      *
-     * @type {UserRelation}
+     * @type {SourceProvider}
      * @memberof Application
      */
-    created_by_user: UserRelation;
+    source_provider: SourceProvider | null;
     /**
      *
-     * @type {ActionRelation}
+     * @type {Array<SslCertificateRelation>}
      * @memberof Application
      */
-    last_action?: ActionRelation | null;
+    ssl_certificates: Array<SslCertificateRelation>;
     /**
      * The date and time when the record was created
      * @type {string}
      * @memberof Application
      */
-    created_at?: string;
+    created_at: string;
     /**
      * The date and time when the record was last updated
      * @type {string}
      * @memberof Application
      */
-    updated_at?: string;
-    /**
-     *
-     * @type {ApplicationPipeline}
-     * @memberof Application
-     */
-    default_pipeline?: ApplicationPipeline | null;
+    updated_at: string;
 }

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

@@ -87,7 +87,7 @@ export interface CronJob {
      * @type {ProjectRelation}
      * @memberof CronJob
      */
-    project: ProjectRelation;
+    project: ProjectRelation | null;
     /**
      *
      * @type {Array<EnvironmentRelation>}