@devopness/sdk-js 2.0.1 → 2.3.0

package/dist/api/generated/models/user-create.d.ts

@@ -21,16 +21,4 @@ export interface UserCreate {
      * @memberof UserCreate
      */
     email: string;
-    /**
-     * User\'s full name
-     * @type {string}
-     * @memberof UserCreate
-     */
-    name: string;
-    /**
-     * User\'s password
-     * @type {string}
-     * @memberof UserCreate
-     */
-    password: string;
 }

package/dist/api/generated/models/user-password-reset.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 UserPasswordReset
+ */
+export interface UserPasswordReset {
+    /**
+     * The unique token generated by the API and sent to the user\'s e-mail address when the `send-reset-link` operation has been triggered.
+     * @type {string}
+     * @memberof UserPasswordReset
+     */
+    token: string;
+    /**
+     * The email of the user to reset the password
+     * @type {string}
+     * @memberof UserPasswordReset
+     */
+    email: string;
+    /**
+     * The new password to define to user account
+     * @type {string}
+     * @memberof UserPasswordReset
+     */
+    password: string;
+    /**
+     * The new password again
+     * @type {string}
+     * @memberof UserPasswordReset
+     */
+    password_confirmation: string;
+}

package/dist/api/generated/models/user-password-reset.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/user-password-send-reset-link.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 UserPasswordSendResetLink
+ */
+export interface UserPasswordSendResetLink {
+    /**
+     * The user email to send the password reset link
+     * @type {string}
+     * @memberof UserPasswordSendResetLink
+     */
+    email: string;
+}

package/dist/api/generated/models/user-password-send-reset-link.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/user-relation.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 { Language } from './language';
+/**
+ *
+ * @export
+ * @interface UserRelation
+ */
+export interface UserRelation {
+    /**
+     * The Id of the given user
+     * @type {number}
+     * @memberof UserRelation
+     */
+    id: number;
+    /**
+     * User\'s full name
+     * @type {string}
+     * @memberof UserRelation
+     */
+    name: string;
+    /**
+     * The e-mail that will uniquely identify the user on the system and become its login credential
+     * @type {string}
+     * @memberof UserRelation
+     */
+    email: string;
+    /**
+     *
+     * @type {Language}
+     * @memberof UserRelation
+     */
+    language?: Language | null;
+    /**
+     * Tells if the user is active or not
+     * @type {boolean}
+     * @memberof UserRelation
+     */
+    active?: boolean;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof UserRelation
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof UserRelation
+     */
+    updated_at?: string;
+}

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

@@ -0,0 +1,43 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Language } from './language';
+/**
+ *
+ * @export
+ * @interface UserUpdate
+ */
+export interface UserUpdate {
+    /**
+     * The Id of the given user
+     * @type {number}
+     * @memberof UserUpdate
+     */
+    id: number;
+    /**
+     * The e-mail that will uniquely identify the user on the system and become its login credential
+     * @type {string}
+     * @memberof UserUpdate
+     */
+    email: string;
+    /**
+     * User\'s full name
+     * @type {string}
+     * @memberof UserUpdate
+     */
+    name: string;
+    /**
+     *
+     * @type {Language}
+     * @memberof UserUpdate
+     */
+    language?: Language | null;
+}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { Language } from './language';
 import { SocialAccount } from './social-account';
 /**
  *
@@ -21,7 +22,7 @@ export interface User {
      * @type {number}
      * @memberof User
      */
-    id?: number;
+    id: number;
     /**
      * User\'s full name
      * @type {string}
@@ -34,6 +35,12 @@ export interface User {
      * @memberof User
      */
     email: string;
+    /**
+     *
+     * @type {Language}
+     * @memberof User
+     */
+    language?: Language | null;
     /**
      * Tells if the user is active or not
      * @type {boolean}

package/dist/api/generated/models/variable-create.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 { VariableTarget } from './variable-target';
+import { VariableType } from './variable-type';
+/**
+ *
+ * @export
+ * @interface VariableCreate
+ */
+export interface VariableCreate {
+    /**
+     * The unique key used to identify the variable on the target. When variable is of type `file`, this is the relative path to the file within the application directory.
+     * @type {string}
+     * @memberof VariableCreate
+     */
+    key: string;
+    /**
+     * The value to be assigned to this variable when deployed to its target. When variable is of type `file`, this is the file content.
+     * @type {string}
+     * @memberof VariableCreate
+     */
+    value: string;
+    /**
+     * A text describing the variable, provided by the end user
+     * @type {string}
+     * @memberof VariableCreate
+     */
+    description?: string;
+    /**
+     *
+     * @type {VariableTarget}
+     * @memberof VariableCreate
+     */
+    target: VariableTarget;
+    /**
+     *
+     * @type {VariableType}
+     * @memberof VariableCreate
+     */
+    type: VariableType;
+    /**
+     * Indicates if the variable value should be visible or not in the deployment logs
+     * @type {boolean}
+     * @memberof VariableCreate
+     */
+    hidden: boolean;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * 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 target defining how the variable key/value pair will be deployed
+ * @export
+ * @enum {string}
+ */
+export declare enum VariableTarget {
+    ResourceConfigFile = "resource-config-file"
+}

package/dist/api/generated/models/variable-target.js

@@ -0,0 +1,24 @@
+"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.VariableTarget = void 0;
+/**
+ * The target defining how the variable key/value pair will be deployed
+ * @export
+ * @enum {string}
+ */
+var VariableTarget;
+(function (VariableTarget) {
+    VariableTarget["ResourceConfigFile"] = "resource-config-file";
+})(VariableTarget = exports.VariableTarget || (exports.VariableTarget = {}));

package/dist/api/generated/models/variable-type.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 type of the key/value pair
+ * @export
+ * @enum {string}
+ */
+export declare enum VariableType {
+    File = "file"
+}

package/dist/api/generated/models/variable-type.js

@@ -0,0 +1,24 @@
+"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.VariableType = void 0;
+/**
+ * The type of the key/value pair
+ * @export
+ * @enum {string}
+ */
+var VariableType;
+(function (VariableType) {
+    VariableType["File"] = "file";
+})(VariableType = exports.VariableType || (exports.VariableType = {}));

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

@@ -0,0 +1,62 @@
+/**
+ * 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 { VariableTarget } from './variable-target';
+import { VariableType } from './variable-type';
+/**
+ *
+ * @export
+ * @interface VariableUpdate
+ */
+export interface VariableUpdate {
+    /**
+     * Variable\'s unique id
+     * @type {number}
+     * @memberof VariableUpdate
+     */
+    id: number;
+    /**
+     * The unique key used to identify the variable on the target
+     * @type {string}
+     * @memberof VariableUpdate
+     */
+    key: string;
+    /**
+     * The value to be assigned to this variable when deployed to its target
+     * @type {string}
+     * @memberof VariableUpdate
+     */
+    value: string;
+    /**
+     * A text describing the variable, provided by the end user
+     * @type {string}
+     * @memberof VariableUpdate
+     */
+    description?: string;
+    /**
+     *
+     * @type {VariableTarget}
+     * @memberof VariableUpdate
+     */
+    target: VariableTarget;
+    /**
+     *
+     * @type {VariableType}
+     * @memberof VariableUpdate
+     */
+    type: VariableType;
+    /**
+     * Indicates if the variable value should be visible or not in the deployment logs
+     * @type {boolean}
+     * @memberof VariableUpdate
+     */
+    hidden: boolean;
+}

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

@@ -0,0 +1,74 @@
+/**
+ * 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 { VariableTarget } from './variable-target';
+import { VariableType } from './variable-type';
+/**
+ *
+ * @export
+ * @interface Variable
+ */
+export interface Variable {
+    /**
+     * The unique id of the given record
+     * @type {number}
+     * @memberof Variable
+     */
+    id?: number;
+    /**
+     * The unique key used to identify the variable on the target
+     * @type {string}
+     * @memberof Variable
+     */
+    key: string;
+    /**
+     * The value to be assigned to this variable when deployed to its target
+     * @type {string}
+     * @memberof Variable
+     */
+    value: string;
+    /**
+     * A text describing the variable, provided by the end user
+     * @type {string}
+     * @memberof Variable
+     */
+    description?: string;
+    /**
+     *
+     * @type {VariableTarget}
+     * @memberof Variable
+     */
+    target: VariableTarget;
+    /**
+     *
+     * @type {VariableType}
+     * @memberof Variable
+     */
+    type: VariableType;
+    /**
+     * Indicates if the variable value should be visible or not in the deployment logs
+     * @type {boolean}
+     * @memberof Variable
+     */
+    hidden?: boolean;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof Variable
+     */
+    created_at?: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof Variable
+     */
+    updated_at?: string;
+}

package/dist/api/generated/models/variable.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/common/ApiResponse.d.ts

@@ -1,6 +1,8 @@
 import { AxiosResponse } from 'axios';
 export declare class ApiResponse<T> {
-    status: number;
+    actionId?: number;
     data: T;
+    pageCount: number;
+    status: number;
     constructor(axiosResp: AxiosResponse<T>);
 }

package/dist/common/ApiResponse.js

@@ -1,10 +1,24 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiResponse = void 0;
+const parse_link_header_1 = __importDefault(require("parse-link-header"));
 class ApiResponse {
     constructor(axiosResp) {
+        var _a;
         this.status = axiosResp.status;
         this.data = axiosResp.data;
+        this.pageCount = 1;
+        if (axiosResp.headers) {
+            const linkHeader = (0, parse_link_header_1.default)(axiosResp.headers.link);
+            this.pageCount = Number((_a = linkHeader === null || linkHeader === void 0 ? void 0 : linkHeader.last) === null || _a === void 0 ? void 0 : _a.page) || 1;
+            if (axiosResp.headers['x-devopness-action-id']) {
+                // axios headers are intentionally lower cased, as per https://github.com/axios/axios/issues/413
+                this.actionId = Number(axiosResp.headers['x-devopness-action-id']);
+            }
+        }
     }
 }
 exports.ApiResponse = ApiResponse;

package/dist/common/Exceptions.d.ts

@@ -17,6 +17,5 @@ export declare class ApiError<T> extends SdkError {
     response?: AxiosResponse<T>;
     status: number;
     constructor(error: AxiosError);
-    private getFormattedMessage;
     private setMessage;
 }

package/dist/common/Exceptions.js

@@ -42,16 +42,8 @@ class ApiError extends SdkError {
             this.setMessage((_a = error.response) === null || _a === void 0 ? void 0 : _a.statusText);
         }
     }
-    getFormattedMessage(message) {
-        // we adopt the `Response` prefix instead of `Error` here cause most returned messages are validation/security related
-        // messages that prevent damage to be caused to user's data and it's not exactly and exception.
-        // A real error, e.g. HTTP 5xx status codes, will be absolutely rare. Real errors like
-        // NetworkError are handled in their own Error classes in this file.
-        const SDK_ERROR_MESSAGE_PREFIX = 'API Response';
-        return `${SDK_ERROR_MESSAGE_PREFIX}: ${message}`;
-    }
     setMessage(message) {
-        this.message = this.getFormattedMessage(message);
+        this.message = message;
     }
 }
 exports.ApiError = ApiError;

package/dist/index.d.ts

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