@devopness/sdk-js 2.21.0 → 2.22.1

package/dist/api/generated/models/action-retry-response.d.ts

@@ -0,0 +1,137 @@
+/**
+ * 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 { ActionData } from './action-data';
+import { ActionHookRequest } from './action-hook-request';
+import { ActionStatus } from './action-status';
+import { ActionSummary } from './action-summary';
+import { ActionTriggeredFrom } from './action-triggered-from';
+import { ActionType } from './action-type';
+import { EnvironmentRelation } from './environment-relation';
+import { ProjectRelation } from './project-relation';
+import { Resource } from './resource';
+import { ServerAction } from './server-action';
+import { UserRelation } from './user-relation';
+/**
+ *
+ * @export
+ * @interface ActionRetryResponse
+ */
+export interface ActionRetryResponse {
+    /**
+     * The Id of the given action
+     * @type {number}
+     * @memberof ActionRetryResponse
+     */
+    id: number;
+    /**
+     *
+     * @type {ActionStatus}
+     * @memberof ActionRetryResponse
+     */
+    status: ActionStatus;
+    /**
+     *
+     * @type {ActionType}
+     * @memberof ActionRetryResponse
+     */
+    type: ActionType;
+    /**
+     * Human readable version of the action type
+     * @type {string}
+     * @memberof ActionRetryResponse
+     */
+    type_human_readable: string;
+    /**
+     * The permalink URL to the action details on Devopness web app
+     * @type {string}
+     * @memberof ActionRetryResponse
+     */
+    url_web_permalink: string;
+    /**
+     *
+     * @type {ActionData}
+     * @memberof ActionRetryResponse
+     */
+    action_data: ActionData | null;
+    /**
+     *
+     * @type {ActionTriggeredFrom}
+     * @memberof ActionRetryResponse
+     */
+    triggered_from: ActionTriggeredFrom;
+    /**
+     *
+     * @type {UserRelation}
+     * @memberof ActionRetryResponse
+     */
+    triggered_by_user?: UserRelation;
+    /**
+     *
+     * @type {Resource}
+     * @memberof ActionRetryResponse
+     */
+    resource: Resource;
+    /**
+     *
+     * @type {ActionSummary}
+     * @memberof ActionRetryResponse
+     */
+    summary: ActionSummary;
+    /**
+     *
+     * @type {EnvironmentRelation}
+     * @memberof ActionRetryResponse
+     */
+    environment?: EnvironmentRelation;
+    /**
+     *
+     * @type {ProjectRelation}
+     * @memberof ActionRetryResponse
+     */
+    project?: ProjectRelation;
+    /**
+     * List of actions dispatched to servers
+     * @type {Array<ServerAction>}
+     * @memberof ActionRetryResponse
+     */
+    servers?: Array<ServerAction>;
+    /**
+     *
+     * @type {ActionHookRequest}
+     * @memberof ActionRetryResponse
+     */
+    hook_requests?: ActionHookRequest;
+    /**
+     * The date and time when the action started execution (i.e., left the `pending/queued` status)
+     * @type {string}
+     * @memberof ActionRetryResponse
+     */
+    started_at: string | null;
+    /**
+     * The date and time when the action has finished execution
+     * @type {string}
+     * @memberof ActionRetryResponse
+     */
+    completed_at: string | null;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof ActionRetryResponse
+     */
+    created_at: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof ActionRetryResponse
+     */
+    updated_at: string;
+}

package/dist/api/generated/models/{application-create.d.ts → application-project-create.d.ts}

@@ -9,138 +9,131 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { ApplicationType } from './application-type';
 import { EnvironmentLinkItem } from './environment-link-item';
 /**
  *
  * @export
- * @interface ApplicationCreate
+ * @interface ApplicationProjectCreate
  */
-export interface ApplicationCreate {
+export interface ApplicationProjectCreate {
     /**
-     * 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
+     * The application\'s unique name. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof ApplicationProjectCreate
      */
-    type: ApplicationType;
+    name: string;
     /**
-     * The application\'s unique name
+     * Must be one of <code>web</code> or <code>non-web</code>.
      * @type {string}
-     * @memberof ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
-    name: string;
+    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`
+     * 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 ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
     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.
+     * 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 ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
-    repository: string;
+    build_command?: string;
     /**
-     * The version control branch that, by default, will be used when a deployment is triggered and no other branch name 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 ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
-    default_branch: string;
+    engine_version?: 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
+     * 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 ApplicationProjectCreate
      */
-    push_to_deploy?: boolean;
+    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`.
+     * 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 ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
     programming_language: string;
     /**
-     * The language runtime engine version to be used to execute this application on the deployed servers
+     * 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
+     * @memberof ApplicationProjectCreate
      */
-    engine_version?: string;
+    listening_address?: 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
+     * 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 ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
-    framework: string;
+    repository: 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.
+     * Numeric ID of the source provider account where the repository is hosted. Required when the `repository` field is informed.
+     * @type {number}
+     * @memberof ApplicationProjectCreate
+     */
+    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 ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
     root_directory?: string;
     /**
-     * The relative web directory where publicly accessible assets are located and the web content should be served from
+     * 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 ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
     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 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 ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
-    entrypoint: string;
+    default_branch: 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 ApplicationCreate
+     * 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 ApplicationProjectCreate
      */
-    listening_address?: string;
+    deployments_keep?: number;
     /**
-     * The optional command that should be executed once during deployment to build the source code and get the application in a ready state.
+     * 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 ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
-    build_command?: string;
+    entrypoint: 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
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in development mode.
+     * @type {boolean}
+     * @memberof ApplicationProjectCreate
      */
-    deployments_keep?: number;
+    install_dependencies_dev: boolean;
     /**
-     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in development mode
+     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in production mode.
      * @type {boolean}
-     * @memberof ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
-    install_dependencies_dev?: boolean;
+    install_dependencies_prod: boolean;
     /**
-     * Indicates if at deployment time Devopness should execute package manager commands to install dependencies used in production mode
+     * 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
+     * @memberof ApplicationProjectCreate
      */
-    install_dependencies_prod?: boolean;
+    push_to_deploy?: boolean;
     /**
-     * Indicates if the application requires a daemon to keep it alive
+     * Indicates if the application requires a daemon to keep it alive.
      * @type {boolean}
-     * @memberof ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
     requires_daemon: boolean;
-    /**
-     * Numeric ID of the project to which the application belongs to
-     * @type {number}
-     * @memberof ApplicationCreate
-     */
-    project_id?: number;
     /**
      *
      * @type {Array<EnvironmentLinkItem>}
-     * @memberof ApplicationCreate
+     * @memberof ApplicationProjectCreate
      */
-    environments?: Array<EnvironmentLinkItem>;
+    environments: Array<EnvironmentLinkItem>;
 }

package/dist/api/generated/models/{cron-job-create.d.ts → cron-job-project-create.d.ts}

@@ -13,49 +13,49 @@ import { EnvironmentLinkItem } from './environment-link-item';
 /**
  *
  * @export
- * @interface CronJobCreate
+ * @interface CronJobProjectCreate
  */
-export interface CronJobCreate {
+export interface CronJobProjectCreate {
     /**
      * A cron expression consisting of Minute, Hour, Day of Month, Month and Day of Week subexpressions.
      * @type {string}
-     * @memberof CronJobCreate
+     * @memberof CronJobProjectCreate
      */
     pattern: string;
     /**
      * The name of the cron job. Must not be greater than 60 characters.
      * @type {string}
-     * @memberof CronJobCreate
+     * @memberof CronJobProjectCreate
      */
     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 CronJobCreate
+     * @memberof CronJobProjectCreate
      */
     command: 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 CronJobCreate
+     * @memberof CronJobProjectCreate
      */
     run_as_user: string;
     /**
      * Numeric ID of the application to which the cron job belongs to.
      * @type {number}
-     * @memberof CronJobCreate
+     * @memberof CronJobProjectCreate
      */
     application_id?: number;
     /**
      * Numeric ID of the project to which the cron job belongs to.
      * @type {number}
-     * @memberof CronJobCreate
+     * @memberof CronJobProjectCreate
      */
     project_id: number;
     /**
      *
      * @type {Array<EnvironmentLinkItem>}
-     * @memberof CronJobCreate
+     * @memberof CronJobProjectCreate
      */
     environments?: Array<EnvironmentLinkItem>;
 }

package/dist/api/generated/models/{daemon-create.d.ts → daemon-environment-create.d.ts}

@@ -12,43 +12,43 @@
 /**
  *
  * @export
- * @interface DaemonCreate
+ * @interface DaemonEnvironmentCreate
  */
-export interface DaemonCreate {
+export interface DaemonEnvironmentCreate {
     /**
      * The command line to be executed to start the daemon. Must not be greater than 255 characters.
      * @type {string}
-     * @memberof DaemonCreate
+     * @memberof DaemonEnvironmentCreate
      */
     command: string;
     /**
      * The number of daemon process instances of the program to run simultaneously. Must be at least 1. Must not be greater than 99.
      * @type {number}
-     * @memberof DaemonCreate
+     * @memberof DaemonEnvironmentCreate
      */
     process_count: number;
     /**
      * The working directory where the daemon will be relative to when performing disk i/o. Must start with one of <code>/</code>.
      * @type {string}
-     * @memberof DaemonCreate
+     * @memberof DaemonEnvironmentCreate
      */
     working_directory: string;
     /**
      * The name of the Unix user on behalf of which the daemon will run. Must not be greater than 60 characters.
      * @type {string}
-     * @memberof DaemonCreate
+     * @memberof DaemonEnvironmentCreate
      */
     run_as_user: string;
     /**
      * The name entered by the user (or auto-generated by `devopness`) to uniquely identify the daemon. Must contain only letters, numbers, dashes and underscores. Must not be greater than 60 characters.
      * @type {string}
-     * @memberof DaemonCreate
+     * @memberof DaemonEnvironmentCreate
      */
     name: string;
     /**
      * List of valid resource IDs
      * @type {Array<number>}
-     * @memberof DaemonCreate
+     * @memberof DaemonEnvironmentCreate
      */
     servers?: Array<number>;
 }

package/dist/api/generated/models/{environment-create.d.ts → environment-project-create.d.ts}

@@ -13,19 +13,19 @@ import { EnvironmentType } from './environment-type';
 /**
  *
  * @export
- * @interface EnvironmentCreate
+ * @interface EnvironmentProjectCreate
  */
-export interface EnvironmentCreate {
-    /**
-     * The environment\'s name
-     * @type {string}
-     * @memberof EnvironmentCreate
-     */
-    name: string;
+export interface EnvironmentProjectCreate {
     /**
      *
      * @type {EnvironmentType}
-     * @memberof EnvironmentCreate
+     * @memberof EnvironmentProjectCreate
      */
     type: EnvironmentType;
+    /**
+     * The environment\'s name. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof EnvironmentProjectCreate
+     */
+    name: string;
 }