@devopness/sdk-js 1.90.0 → 1.93.0

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

@@ -12,7 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { Action } from '../../generated/models';
-import { ActionRelation } from '../../generated/models';
+import { ActionListItem } from '../../generated/models';
 /**
  * ActionsApiService - Auto-generated
  */
@@ -29,5 +29,5 @@ export declare class ActionsApiService extends ApiBaseService {
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
      */
-    listActions(page?: number, perPage?: number): Promise<ApiResponse<Array<ActionRelation>>>;
+    listActions(page?: number, perPage?: number): Promise<ApiResponse<Array<ActionListItem>>>;
 }

package/dist/api/generated/apis/cloud-providers-api.d.ts

@@ -38,11 +38,11 @@ export declare class CloudProvidersApiService extends ApiBaseService {
     /**
      *
      * @summary List credentials of the given cloud provider
-     * @param {string} cloudProviderAcronym Cloud provider acronym to get credentials from
+     * @param {string} cloudProviderCode Code of the cloud provider to get credentials from
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
      */
-    listCloudProviderCredentials(cloudProviderAcronym: string, page?: number, perPage?: number): Promise<ApiResponse<Array<Credential>>>;
+    listCloudProviderCredentials(cloudProviderCode: string, page?: number, perPage?: number): Promise<ApiResponse<Array<Credential>>>;
     /**
      *
      * @summary List cloud provider credentials

package/dist/api/generated/apis/cloud-providers-api.js

@@ -80,14 +80,14 @@ class CloudProvidersApiService extends ApiBaseService_1.ApiBaseService {
     /**
      *
      * @summary List credentials of the given cloud provider
-     * @param {string} cloudProviderAcronym Cloud provider acronym to get credentials from
+     * @param {string} cloudProviderCode Code of the cloud provider to get credentials from
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
      */
-    listCloudProviderCredentials(cloudProviderAcronym, page, perPage) {
+    listCloudProviderCredentials(cloudProviderCode, page, perPage) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (cloudProviderAcronym === null || cloudProviderAcronym === undefined) {
-                throw new Exceptions_1.ArgumentNullException('cloudProviderAcronym', 'listCloudProviderCredentials');
+            if (cloudProviderCode === null || cloudProviderCode === undefined) {
+                throw new Exceptions_1.ArgumentNullException('cloudProviderCode', 'listCloudProviderCredentials');
             }
             let queryString = '';
             const queryParams = { page: page, per_page: perPage, };
@@ -97,8 +97,8 @@ class CloudProvidersApiService extends ApiBaseService_1.ApiBaseService {
                 }
                 queryString += (queryString ? '&' : '') + `${key}=${encodeURI(queryParams[key])}`;
             }
-            const requestUrl = '/cloud-providers/{cloud_provider_acronym}/credentials' + (queryString ? `?${queryString}` : '');
-            const response = yield this.get(requestUrl.replace(`{${"cloud_provider_acronym"}}`, encodeURIComponent(String(cloudProviderAcronym))));
+            const requestUrl = '/cloud-providers/{cloud_provider_code}/credentials' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"cloud_provider_code"}}`, encodeURIComponent(String(cloudProviderCode))));
             return new ApiResponse_1.ApiResponse(response);
         });
     }

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

@@ -12,6 +12,7 @@
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { SshKey } from '../../generated/models';
+import { SshKeyUpdate } from '../../generated/models';
 /**
  * SSHKeysApiService - Auto-generated
  */
@@ -28,4 +29,11 @@ export declare class SSHKeysApiService extends ApiBaseService {
      * @param {number} sshKeyId Numeric ID of the SSH key to get
      */
     getSshKey(sshKeyId: number): Promise<ApiResponse<SshKey>>;
+    /**
+     *
+     * @summary Update an existing SSH key
+     * @param {number} sshKeyId Numeric ID of the SSH key to be updated
+     * @param {SshKeyUpdate} sshKeyUpdate A JSON object containing SSH key data
+     */
+    updateSshKey(sshKeyId: number, sshKeyUpdate: SshKeyUpdate): Promise<ApiResponse<void>>;
 }

package/dist/api/generated/apis/sshkeys-api.js

@@ -61,5 +61,25 @@ class SSHKeysApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Update an existing SSH key
+     * @param {number} sshKeyId Numeric ID of the SSH key to be updated
+     * @param {SshKeyUpdate} sshKeyUpdate A JSON object containing SSH key data
+     */
+    updateSshKey(sshKeyId, sshKeyUpdate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (sshKeyId === null || sshKeyId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('sshKeyId', 'updateSshKey');
+            }
+            if (sshKeyUpdate === null || sshKeyUpdate === undefined) {
+                throw new Exceptions_1.ArgumentNullException('sshKeyUpdate', 'updateSshKey');
+            }
+            let queryString = '';
+            const requestUrl = '/ssh-keys/{ssh_key_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.put(requestUrl.replace(`{${"ssh_key_id"}}`, encodeURIComponent(String(sshKeyId))), sshKeyUpdate);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
 }
 exports.SSHKeysApiService = SSHKeysApiService;

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

@@ -11,6 +11,7 @@
  */
 import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
+import { AcceptedResponseMessage } from '../../generated/models';
 import { LoginCredentials } from '../../generated/models';
 import { User } from '../../generated/models';
 import { UserAccountActivate } from '../../generated/models';
@@ -37,7 +38,7 @@ export declare class UsersApiService extends ApiBaseService {
      * @summary Sign up/register a new user
      * @param {UserCreate} userCreate A JSON object containing user essential data
      */
-    addUser(userCreate: UserCreate): Promise<ApiResponse<void>>;
+    addUser(userCreate: UserCreate): Promise<ApiResponse<AcceptedResponseMessage>>;
     /**
      *
      * @summary Get details of the current user

package/dist/api/generated/models/accepted-response-message.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 AcceptedResponseMessage
+ */
+export interface AcceptedResponseMessage {
+    /**
+     * Message with information about the response
+     * @type {string}
+     * @memberof AcceptedResponseMessage
+     */
+    message: string;
+}

package/dist/api/generated/models/accepted-response-message.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/action-list-item-params.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 { ServerAction } from './server-action';
+/**
+ *
+ * @export
+ * @interface ActionListItemParams
+ */
+export interface ActionListItemParams {
+    /**
+     * List of actions dispatched to servers
+     * @type {Array<ServerAction>}
+     * @memberof ActionListItemParams
+     */
+    servers?: Array<ServerAction>;
+}

package/dist/api/generated/models/action-list-item-params.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/action-list-item.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { ActionListItemParams } from './action-list-item-params';
+import { ActionRelation } from './action-relation';
+/**
+ * @type ActionListItem
+ * @export
+ */
+export declare type ActionListItem = ActionListItemParams & ActionRelation;

package/dist/api/generated/models/action-list-item.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/action-relation.d.ts

@@ -12,6 +12,7 @@
 import { ActionStatus } from './action-status';
 import { ActionSummary } from './action-summary';
 import { ActionType } from './action-type';
+import { Resource } from './resource';
 /**
  *
  * @export
@@ -42,6 +43,12 @@ export interface ActionRelation {
      * @memberof ActionRelation
      */
     type_human_readable: string;
+    /**
+     *
+     * @type {Resource}
+     * @memberof ActionRelation
+     */
+    resource: Resource;
     /**
      *
      * @type {ActionSummary}

package/dist/api/generated/models/cloud-provider.d.ts

@@ -16,17 +16,17 @@
  */
 export interface CloudProvider {
     /**
-     * The unique id of the cloud provider
-     * @type {number}
+     * The code that uniquely identify a cloud provider
+     * @type {string}
      * @memberof CloudProvider
      */
-    id: number;
+    code: string;
     /**
-     * The acronym of the cloud provider
+     * A URL path to the provider\'s logo image
      * @type {string}
      * @memberof CloudProvider
      */
-    acronym: string;
+    logo_url: string;
     /**
      * The name of the cloud provider
      * @type {string}

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

@@ -18,7 +18,7 @@ import { ProviderRegion } from './provider-region';
  */
 export interface CloudService {
     /**
-     * The acronym name of the cloud service
+     * The code that uniquely identify this cloud service
      * @type {string}
      * @memberof CloudService
      */

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

@@ -22,7 +22,7 @@ export interface DaemonRelation {
      * @type {number}
      * @memberof DaemonRelation
      */
-    id?: number;
+    id: number;
     /**
      * The name entered by the user (or auto-generated by `devopness`) to uniquely identify the daemon
      * @type {string}

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

@@ -11,7 +11,9 @@
  */
 import { ActionRelation } from './action-relation';
 import { ApplicationRelation } from './application-relation';
+import { EnvironmentRelation } from './environment-relation';
 import { ProjectRelation } from './project-relation';
+import { ServerRelation } from './server-relation';
 /**
  *
  * @export
@@ -23,7 +25,7 @@ export interface Daemon {
      * @type {number}
      * @memberof Daemon
      */
-    id?: number;
+    id: number;
     /**
      * The name entered by the user (or auto-generated by `devopness`) to uniquely identify the daemon
      * @type {string}
@@ -72,6 +74,18 @@ export interface Daemon {
      * @memberof Daemon
      */
     application: ApplicationRelation | null;
+    /**
+     *
+     * @type {Array<EnvironmentRelation>}
+     * @memberof Daemon
+     */
+    environments: Array<EnvironmentRelation>;
+    /**
+     *
+     * @type {Array<ServerRelation>}
+     * @memberof Daemon
+     */
+    servers: Array<ServerRelation>;
     /**
      *
      * @type {ActionRelation}

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

@@ -28,6 +28,12 @@ export interface DeploymentRelation {
      * @memberof DeploymentRelation
      */
     id: number;
+    /**
+     * The application\'s name that the deployment belongs to
+     * @type {string}
+     * @memberof DeploymentRelation
+     */
+    name: string;
     /**
      *
      * @type {ActionStatus}

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

@@ -34,7 +34,7 @@ export interface Deployment {
      * @type {string}
      * @memberof Deployment
      */
-    name?: string;
+    name: string;
     /**
      *
      * @type {ActionStatus}

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

@@ -1,5 +1,8 @@
+export * from './accepted-response-message';
 export * from './action';
 export * from './action-hook-request';
+export * from './action-list-item';
+export * from './action-list-item-params';
 export * from './action-relation';
 export * from './action-status';
 export * from './action-step';
@@ -146,6 +149,7 @@ export * from './source-provider-name';
 export * from './ssh-key';
 export * from './ssh-key-create';
 export * from './ssh-key-relation';
+export * from './ssh-key-update';
 export * from './ssl-certificate';
 export * from './ssl-certificate-create';
 export * from './ssl-certificate-issuer';

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

@@ -10,8 +10,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./accepted-response-message"), exports);
 __exportStar(require("./action"), exports);
 __exportStar(require("./action-hook-request"), exports);
+__exportStar(require("./action-list-item"), exports);
+__exportStar(require("./action-list-item-params"), exports);
 __exportStar(require("./action-relation"), exports);
 __exportStar(require("./action-status"), exports);
 __exportStar(require("./action-step"), exports);
@@ -158,6 +161,7 @@ __exportStar(require("./source-provider-name"), exports);
 __exportStar(require("./ssh-key"), exports);
 __exportStar(require("./ssh-key-create"), exports);
 __exportStar(require("./ssh-key-relation"), exports);
+__exportStar(require("./ssh-key-update"), exports);
 __exportStar(require("./ssl-certificate"), exports);
 __exportStar(require("./ssl-certificate-create"), exports);
 __exportStar(require("./ssl-certificate-issuer"), exports);

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

@@ -22,6 +22,18 @@ export interface MemberRelation {
      * @memberof MemberRelation
      */
     role: string;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof MemberRelation
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof MemberRelation
+     */
+    updated_at?: string;
     /**
      *
      * @type {UserRelation}

package/dist/api/generated/models/network-rule.d.ts

@@ -10,8 +10,10 @@
  * Do not edit the class manually.
  */
 import { ActionRelation } from './action-relation';
+import { EnvironmentRelation } from './environment-relation';
 import { NetworkRuleProtocol } from './network-rule-protocol';
 import { NetworkRuleType } from './network-rule-type';
+import { ServerRelation } from './server-relation';
 import { UserRelation } from './user-relation';
 /**
  *
@@ -73,6 +75,18 @@ export interface NetworkRule {
      * @memberof NetworkRule
      */
     created_by_user: UserRelation;
+    /**
+     *
+     * @type {Array<EnvironmentRelation>}
+     * @memberof NetworkRule
+     */
+    environments: Array<EnvironmentRelation>;
+    /**
+     *
+     * @type {Array<ServerRelation>}
+     * @memberof NetworkRule
+     */
+    servers: Array<ServerRelation>;
     /**
      *
      * @type {ActionRelation}

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

@@ -9,7 +9,16 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ApplicationRelation } from './application-relation';
+import { CronJobRelation } from './cron-job-relation';
+import { DaemonRelation } from './daemon-relation';
+import { DeploymentRelation } from './deployment-relation';
+import { NetworkRuleRelation } from './network-rule-relation';
 import { ResourceType } from './resource-type';
+import { ServerRelation } from './server-relation';
+import { ServiceRelation } from './service-relation';
+import { SshKeyRelation } from './ssh-key-relation';
+import { SslCertificateRelation } from './ssl-certificate-relation';
 /**
  * Object containing the data of the resource and informations about it
  * @export
@@ -36,8 +45,8 @@ export interface Resource {
     type_human_readable: string;
     /**
      * The resource data of type specified on `resource.type`
-     * @type {object}
+     * @type {ApplicationRelation | CronJobRelation | DaemonRelation | DeploymentRelation | NetworkRuleRelation | ServerRelation | ServiceRelation | SshKeyRelation | SslCertificateRelation}
      * @memberof Resource
      */
-    data?: object | null;
+    data?: ApplicationRelation | CronJobRelation | DaemonRelation | DeploymentRelation | NetworkRuleRelation | ServerRelation | ServiceRelation | SshKeyRelation | SslCertificateRelation | null;
 }

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ActionListItem } from './action-list-item';
 import { ActionRelation } from './action-relation';
 import { ActionStatus } from './action-status';
 import { EnvironmentRelation } from './environment-relation';
@@ -77,10 +78,10 @@ export interface Server {
     status?: ActionStatus;
     /**
      * The list of related actions
-     * @type {Array<ActionRelation>}
+     * @type {Array<ActionListItem>}
      * @memberof Server
      */
-    actions: Array<ActionRelation>;
+    actions: Array<ActionListItem>;
     /**
      * The list of environments to which the server is linked to
      * @type {Array<EnvironmentRelation>}

package/dist/api/generated/models/ssh-key-update.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 { EnvironmentLinkItem } from './environment-link-item';
+/**
+ *
+ * @export
+ * @interface SshKeyUpdate
+ */
+export interface SshKeyUpdate {
+    /**
+     * The Id of the SSH key
+     * @type {number}
+     * @memberof SshKeyUpdate
+     */
+    id: number;
+    /**
+     * The name entered by the user to uniquely identify the public SSH key
+     * @type {string}
+     * @memberof SshKeyUpdate
+     */
+    name: string;
+    /**
+     *
+     * @type {Array<EnvironmentLinkItem>}
+     * @memberof SshKeyUpdate
+     */
+    environments?: Array<EnvironmentLinkItem>;
+}

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

@@ -10,6 +10,8 @@
  * Do not edit the class manually.
  */
 import { ActionRelation } from './action-relation';
+import { EnvironmentRelation } from './environment-relation';
+import { ServerRelation } from './server-relation';
 import { UserRelation } from './user-relation';
 /**
  *
@@ -53,6 +55,18 @@ export interface SshKey {
      * @memberof SshKey
      */
     created_by_user: UserRelation;
+    /**
+     *
+     * @type {Array<EnvironmentRelation>}
+     * @memberof SshKey
+     */
+    environments: Array<EnvironmentRelation>;
+    /**
+     *
+     * @type {Array<ServerRelation>}
+     * @memberof SshKey
+     */
+    servers: Array<ServerRelation>;
     /**
      *
      * @type {ActionRelation}

package/dist/api/generated/models/ssl-certificate-relation.d.ts

@@ -31,6 +31,12 @@ export interface SslCertificateRelation {
      * @memberof SslCertificateRelation
      */
     domains: Array<string>;
+    /**
+     * The name given to SSL certificate
+     * @type {string}
+     * @memberof SslCertificateRelation
+     */
+    name: string;
     /**
      *
      * @type {SslCertificateIssuer}

package/dist/api/generated/models/ssl-certificate.d.ts

@@ -33,6 +33,12 @@ export interface SslCertificate {
      * @memberof SslCertificate
      */
     domains: Array<string>;
+    /**
+     * The name given to SSL certificate
+     * @type {string}
+     * @memberof SslCertificate
+     */
+    name: string;
     /**
      *
      * @type {SslCertificateIssuer}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devopness/sdk-js",
-  "version": "1.90.0",
+  "version": "1.93.0",
   "publishConfig": {
     "access": "public"
   },
@@ -50,16 +50,16 @@
     "@typescript-eslint/eslint-plugin": "^4.0.0",
     "@typescript-eslint/parser": "^4.28.1",
     "axios-mock-adapter": "^1.18.1",
-    "eslint": "^7.1.0",
+    "eslint": "^7.32.0",
     "eslint-config-standard-with-typescript": "^21.0.1",
-    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-import": "^2.24.2",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-standard": "^5.0.0",
     "husky": "^7.0.0",
     "jest": "^27.0.6",
     "ts-jest": "^27.0.3",
-    "typedoc": "^0.21.2",
+    "typedoc": "^0.22.3",
     "typescript": "^4.0.2"
   },
   "dependencies": {