@devopness/sdk-js 2.14.0 → 2.15.0

package/dist/api/generated/models/{service-status-update.d.ts → service-update-status.d.ts}

@@ -12,13 +12,13 @@
 /**
  *
  * @export
- * @interface ServiceStatusUpdate
+ * @interface ServiceUpdateStatus
  */
-export interface ServiceStatusUpdate {
+export interface ServiceUpdateStatus {
     /**
-     * The unique environment id
+     * The ID of the environment this service is running in.
      * @type {number}
-     * @memberof ServiceStatusUpdate
+     * @memberof ServiceUpdateStatus
      */
     environment_id: number;
 }

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

@@ -17,7 +17,7 @@ import { EnvironmentLinkItem } from './environment-link-item';
  */
 export interface ServiceUpdate {
     /**
-     * The unique id of the given record
+     * The unique ID of the service.
      * @type {number}
      * @memberof ServiceUpdate
      */
@@ -27,5 +27,5 @@ export interface ServiceUpdate {
      * @type {Array<EnvironmentLinkItem>}
      * @memberof ServiceUpdate
      */
-    environments: Array<EnvironmentLinkItem>;
+    environments?: Array<EnvironmentLinkItem>;
 }

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

@@ -22,7 +22,7 @@ import { UserRelation } from './user-relation';
  */
 export interface Service {
     /**
-     * The unique id of the given record
+     * The unique ID of the given service
      * @type {number}
      * @memberof Service
      */
@@ -50,7 +50,7 @@ export interface Service {
      * @type {string}
      * @memberof Service
      */
-    version?: string | null;
+    version: string | null;
     /**
      * Indicates if the service was auto_generated by `devopness` itself
      * @type {boolean}
@@ -58,7 +58,7 @@ export interface Service {
      */
     auto_generated: boolean;
     /**
-     * Indicates if the service is marked for start automatically on operating system boot
+     * Indicates if the service will start automatically on operating system boot
      * @type {boolean}
      * @memberof Service
      */
@@ -74,7 +74,7 @@ export interface Service {
      * @type {string}
      * @memberof Service
      */
-    description?: string | null;
+    description: string | null;
     /**
      *
      * @type {Array<EnvironmentRelation>}

package/dist/api/generated/models/ssh-key-create.d.ts

@@ -9,7 +9,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { EnvironmentLinkItem } from './environment-link-item';
 /**
  *
  * @export
@@ -17,27 +16,21 @@ import { EnvironmentLinkItem } from './environment-link-item';
  */
 export interface SshKeyCreate {
     /**
-     * The Id of the given SSH public key
-     * @type {number}
-     * @memberof SshKeyCreate
-     */
-    id?: number;
-    /**
-     * The name entered by the user to uniquely identify the public SSH key
+     * The ssh key\'s name. Must not be greater than 60 characters.
      * @type {string}
      * @memberof SshKeyCreate
      */
     name: string;
     /**
-     * The public SSH key to add to your `devopness` account and associate it to the given project
+     * The public key of the ssh key.
      * @type {string}
      * @memberof SshKeyCreate
      */
     public_key: string;
     /**
-     *
-     * @type {Array<EnvironmentLinkItem>}
+     * List of valid resource IDs
+     * @type {Array<number>}
      * @memberof SshKeyCreate
      */
-    environments?: Array<EnvironmentLinkItem>;
+    servers?: Array<number>;
 }

package/dist/api/generated/models/ssh-key-project-create.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 SshKeyProjectCreate
+ */
+export interface SshKeyProjectCreate {
+    /**
+     * The ssh key\'s name. Must not be greater than 60 characters.
+     * @type {string}
+     * @memberof SshKeyProjectCreate
+     */
+    name: string;
+    /**
+     * The public key of the ssh key.
+     * @type {string}
+     * @memberof SshKeyProjectCreate
+     */
+    public_key: string;
+    /**
+     *
+     * @type {Array<EnvironmentLinkItem>}
+     * @memberof SshKeyProjectCreate
+     */
+    environments?: Array<EnvironmentLinkItem>;
+}

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

@@ -23,23 +23,29 @@ export interface SshKeyRelation {
      */
     id: number;
     /**
-     * The project id that the SSH public key belongs to
+     * The Id of the user to which the SSH key belongs to
      * @type {number}
      * @memberof SshKeyRelation
      */
-    project_id?: number;
+    created_by?: number;
     /**
-     * The name entered by the user to uniquely identify the public SSH key
-     * @type {string}
+     * The project id to which the SSH public key belongs to
+     * @type {number}
      * @memberof SshKeyRelation
      */
-    name: string;
+    project_id?: number;
     /**
-     * The Id of the user to which the SSH key belongs to
+     * The environment id to which the SSH public key belongs to
      * @type {number}
      * @memberof SshKeyRelation
      */
-    created_by?: number;
+    environment_id: number;
+    /**
+     * The name entered by the user to uniquely identify the public SSH key
+     * @type {string}
+     * @memberof SshKeyRelation
+     */
+    name: string;
     /**
      * The hashed fingerprint of the public key
      * @type {string}

package/dist/api/generated/models/ssh-key-update.d.ts

@@ -17,13 +17,13 @@ import { EnvironmentLinkItem } from './environment-link-item';
  */
 export interface SshKeyUpdate {
     /**
-     * The Id of the SSH key
+     * The ssh key\'s ID.
      * @type {number}
      * @memberof SshKeyUpdate
      */
     id: number;
     /**
-     * The name entered by the user to uniquely identify the public SSH key
+     * The ssh key\'s name. Must not be greater than 60 characters.
      * @type {string}
      * @memberof SshKeyUpdate
      */

package/dist/api/generated/models/ssh-key.d.ts

@@ -26,23 +26,29 @@ export interface SshKey {
      */
     id: number;
     /**
-     * The project id that the SSH public key belongs to
+     * The id of the user to which the SSH key belongs to
      * @type {number}
      * @memberof SshKey
      */
-    project_id?: number;
+    created_by?: number;
     /**
-     * The name entered by the user to uniquely identify the public SSH key
-     * @type {string}
+     * The project id to which the SSH public key belongs to
+     * @type {number}
      * @memberof SshKey
      */
-    name: string;
+    project_id?: number;
     /**
-     * The Id of the user to which the SSH key belongs to
+     * The environment id to which the SSH public key belongs to
      * @type {number}
      * @memberof SshKey
      */
-    created_by?: number;
+    environment_id: number;
+    /**
+     * The name entered by the user to uniquely identify the public SSH key
+     * @type {string}
+     * @memberof SshKey
+     */
+    name: string;
     /**
      * The hashed fingerprint of the public key
      * @type {string}

package/dist/index.d.ts

@@ -2,3 +2,4 @@ export * from './DevopnessApiClient';
 export * from './common/ApiResponse';
 export * as SdkExceptions from './common/Exceptions';
 export * as SdkModels from './api/generated/models';
+export * as SdkServices from './services';

package/dist/index.js

@@ -26,8 +26,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SdkModels = exports.SdkExceptions = void 0;
+exports.SdkServices = exports.SdkModels = exports.SdkExceptions = void 0;
 __exportStar(require("./DevopnessApiClient"), exports);
 __exportStar(require("./common/ApiResponse"), exports);
 exports.SdkExceptions = __importStar(require("./common/Exceptions"));
 exports.SdkModels = __importStar(require("./api/generated/models"));
+exports.SdkServices = __importStar(require("./services"));

package/dist/services/ApiBaseService.js

@@ -29,10 +29,8 @@ class ApiBaseService {
             timeout: 30000,
             responseType: 'json',
             headers: {
-                common: {
-                    Accept: "application/json",
-                    'Content-Type': "application/json",
-                },
+                Accept: "application/json",
+                'Content-Type': "application/json"
             },
             withCredentials: false
         };

package/dist/services/index.d.ts

@@ -0,0 +1,27 @@
+export * from './ActionService';
+export * from './ApiBaseService';
+export * from './ApplicationService';
+export * from './CloudProviderCredentialService';
+export * from './CronJobService';
+export * from './DaemonService';
+export * from './EnvironmentService';
+export * from './HookIncomingService';
+export * from './HookOutgoingService';
+export * from './HookRequestService';
+export * from './LogService';
+export * from './NetworkRuleService';
+export * from './PipelineService';
+export * from './ProjectService';
+export * from './ResourceEventService';
+export * from './RoleService';
+export * from './ServerService';
+export * from './ServiceService';
+export * from './SocialAccountService';
+export * from './SourceProviderService';
+export * from './SshKeyService';
+export * from './SslCertificateService';
+export * from './StaticService';
+export * from './TeamInvitationService';
+export * from './TeamService';
+export * from './UserService';
+export * from './VariableService';

package/dist/services/index.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./ActionService"), exports);
+__exportStar(require("./ApiBaseService"), exports);
+__exportStar(require("./ApplicationService"), exports);
+__exportStar(require("./CloudProviderCredentialService"), exports);
+__exportStar(require("./CronJobService"), exports);
+__exportStar(require("./DaemonService"), exports);
+__exportStar(require("./EnvironmentService"), exports);
+__exportStar(require("./HookIncomingService"), exports);
+__exportStar(require("./HookOutgoingService"), exports);
+__exportStar(require("./HookRequestService"), exports);
+__exportStar(require("./LogService"), exports);
+__exportStar(require("./NetworkRuleService"), exports);
+__exportStar(require("./PipelineService"), exports);
+__exportStar(require("./ProjectService"), exports);
+__exportStar(require("./ResourceEventService"), exports);
+__exportStar(require("./RoleService"), exports);
+__exportStar(require("./ServerService"), exports);
+__exportStar(require("./ServiceService"), exports);
+__exportStar(require("./SocialAccountService"), exports);
+__exportStar(require("./SourceProviderService"), exports);
+__exportStar(require("./SshKeyService"), exports);
+__exportStar(require("./SslCertificateService"), exports);
+__exportStar(require("./StaticService"), exports);
+__exportStar(require("./TeamInvitationService"), exports);
+__exportStar(require("./TeamService"), exports);
+__exportStar(require("./UserService"), exports);
+__exportStar(require("./VariableService"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devopness/sdk-js",
-  "version": "2.14.0",
+  "version": "2.15.0",
   "publishConfig": {
     "access": "public"
   },
@@ -13,7 +13,10 @@
   "scripts": {
     "build": "rm -Rf ./dist && npm run lint && tsc",
     "build-api-models": "rm -Rf ./src/api/generated && JAVA_OPTS=\"${JAVA_OPTS} -Dlog.level=warn\" openapi-generator-cli generate && npm run build",
-    "docs": "typedoc",
+    "docs-remove-service-index": "rm -f src/services/index.ts",
+    "docs-export-service-index": "find src/services/ ! -name 'index.ts' -name '*.ts' -type f | sort -k3 -t'/' | xargs -I'{}' bash -c 'echo \"export * from $(echo -e \"\\x27\")./$(basename $0 .ts)$(echo -e \"\\x27\")\" >> src/services/index.ts' {} \\;",
+    "docs-update-service-index": "npm run docs-remove-service-index && npm run docs-export-service-index",
+    "docs": "npm run docs-update-service-index && typedoc",
     "lint": "eslint . --ext .ts",
     "prepublishOnly": "npm test",
     "prepare": "npm run build",
@@ -22,16 +25,20 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/devopness/devopness-sdk-js.git"
+    "url": "git+https://github.com/devopness/devopness.git"
   },
   "keywords": [
+    "Cloud Engineering",
+    "Cloud Infrastructure Management",
+    "Cloud Platform Engineering",
+    "Configuration Management",
     "DevOps",
     "Devopness",
     "Deploy",
     "Deployment",
+    "Platform Engineering",
     "Zero Downtime Deploy",
-    "Server Management",
-    "Configuration Management"
+    "Server Management"
   ],
   "author": "Devopness (https://www.devopness.com)",
   "license": "MIT",
@@ -41,9 +48,9 @@
     ]
   },
   "bugs": {
-    "url": "https://github.com/devopness/devopness-sdk-js/issues"
+    "url": "https://github.com/devopness/devopness/issues"
   },
-  "homepage": "https://github.com/devopness/devopness-sdk-js#readme",
+  "homepage": "https://github.com/devopness/devopness#readme",
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.0.2",
     "@types/jest": "^27.0.1",
@@ -61,7 +68,7 @@
   },
   "dependencies": {
     "@types/parse-link-header": "^2.0.0",
-    "axios": "^0.21.4",
+    "axios": "^0.27.2",
     "parse-link-header": "^2.0.0"
   }
 }

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

@@ -1,24 +0,0 @@
-/**
- * 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 { ApiBaseService } from "../../../services/ApiBaseService";
-import { ApiResponse } from "../../../common/ApiResponse";
-/**
- * InvitationsApiService - Auto-generated
- */
-export declare class InvitationsApiService extends ApiBaseService {
-    /**
-     *
-     * @summary Accept a pending invitation
-     * @param {string} invitationId UUID of the invitation to be accepted
-     */
-    acceptInvitation(invitationId: string): Promise<ApiResponse<void>>;
-}

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

@@ -1,49 +0,0 @@
-"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.
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvitationsApiService = void 0;
-const ApiBaseService_1 = require("../../../services/ApiBaseService");
-const ApiResponse_1 = require("../../../common/ApiResponse");
-const Exceptions_1 = require("../../../common/Exceptions");
-/**
- * InvitationsApiService - Auto-generated
- */
-class InvitationsApiService extends ApiBaseService_1.ApiBaseService {
-    /**
-     *
-     * @summary Accept a pending invitation
-     * @param {string} invitationId UUID of the invitation to be accepted
-     */
-    acceptInvitation(invitationId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (invitationId === null || invitationId === undefined) {
-                throw new Exceptions_1.ArgumentNullException('invitationId', 'acceptInvitation');
-            }
-            let queryString = '';
-            const requestUrl = '/invitations/{invitation_id}/accept' + (queryString ? `?${queryString}` : '');
-            const response = yield this.post(requestUrl.replace(`{${"invitation_id"}}`, encodeURIComponent(String(invitationId))));
-            return new ApiResponse_1.ApiResponse(response);
-        });
-    }
-}
-exports.InvitationsApiService = InvitationsApiService;

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

@@ -1,27 +0,0 @@
-/**
- * devopness API
- * Devopness API - Painless essential DevOps to everyone
- *
- * The version of the OpenAPI document: latest
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * The action to be executed for the given service
- * @export
- * @enum {string}
- */
-export declare enum ServiceAction {
-    Status = "status",
-    Start = "start",
-    Stop = "stop",
-    Reload = "reload",
-    Restart = "restart",
-    Enable = "enable",
-    Disable = "disable",
-    Install = "install",
-    Uninstall = "uninstall"
-}

package/dist/api/generated/models/service-action.js

@@ -1,32 +0,0 @@
-"use strict";
-/* eslint-disable */
-/**
- * devopness API
- * Devopness API - Painless essential DevOps to everyone
- *
- * The version of the OpenAPI document: latest
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceAction = void 0;
-/**
- * The action to be executed for the given service
- * @export
- * @enum {string}
- */
-var ServiceAction;
-(function (ServiceAction) {
-    ServiceAction["Status"] = "status";
-    ServiceAction["Start"] = "start";
-    ServiceAction["Stop"] = "stop";
-    ServiceAction["Reload"] = "reload";
-    ServiceAction["Restart"] = "restart";
-    ServiceAction["Enable"] = "enable";
-    ServiceAction["Disable"] = "disable";
-    ServiceAction["Install"] = "install";
-    ServiceAction["Uninstall"] = "uninstall";
-})(ServiceAction = exports.ServiceAction || (exports.ServiceAction = {}));

package/dist/services/InvitationService.d.ts

@@ -1,3 +0,0 @@
-import { InvitationsApiService } from '../api/generated/apis/invitations-api';
-export declare class InvitationService extends InvitationsApiService {
-}

package/dist/services/InvitationService.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvitationService = void 0;
-const invitations_api_1 = require("../api/generated/apis/invitations-api");
-class InvitationService extends invitations_api_1.InvitationsApiService {
-}
-exports.InvitationService = InvitationService;